blob: 772d45d12631f25bb7552412c5e6daeb0f6dd78a [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200201 if (default_args != NULL)
202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
269 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100270 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200271 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200273 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200274
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200275 if (*skipwhite(p) == '=' && default_args != NULL)
276 {
277 typval_T rettv;
278
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100279 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200280 any_default = TRUE;
281 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200282 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200283 p = skipwhite(p);
284 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200285 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 {
287 if (ga_grow(default_args, 1) == FAIL)
288 goto err_ret;
289
290 // trim trailing whitespace
291 while (p > expr && VIM_ISWHITE(p[-1]))
292 p--;
293 c = *p;
294 *p = NUL;
295 expr = vim_strsave(expr);
296 if (expr == NULL)
297 {
298 *p = c;
299 goto err_ret;
300 }
301 ((char_u **)(default_args->ga_data))
302 [default_args->ga_len] = expr;
303 default_args->ga_len++;
304 *p = c;
305 }
306 else
307 mustend = TRUE;
308 }
309 else if (any_default)
310 {
311 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200312 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200313 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200314
315 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
316 {
317 // Be tolerant when skipping
318 if (!skip)
319 {
320 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
321 goto err_ret;
322 }
323 p = skipwhite(p);
324 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200325 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200326 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200327 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200328 // Don't give this error when skipping, it makes the "->" not
329 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100330 // Allow missing space after comma in legacy functions.
331 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200332 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
333 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100334 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 goto err_ret;
336 }
337 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200338 else
339 mustend = TRUE;
340 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200341 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200342 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200343 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200344
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200345 if (*p != endchar)
346 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100347 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200348
349 *argp = p;
350 return OK;
351
352err_ret:
353 if (newargs != NULL)
354 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200355 if (default_args != NULL)
356 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357 return FAIL;
358}
359
360/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100361 * Parse the argument types, filling "fp->uf_arg_types".
362 * Return OK or FAIL.
363 */
364 static int
365parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
366{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200367 int len = 0;
368
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100369 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
370 if (argtypes->ga_len > 0)
371 {
372 // When "varargs" is set the last name/type goes into uf_va_name
373 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200374 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100375
376 if (len > 0)
377 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
378 if (fp->uf_arg_types != NULL)
379 {
380 int i;
381 type_T *type;
382
383 for (i = 0; i < len; ++ i)
384 {
385 char_u *p = ((char_u **)argtypes->ga_data)[i];
386
387 if (p == NULL)
388 // will get the type from the default value
389 type = &t_unknown;
390 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100391 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100392 if (type == NULL)
393 return FAIL;
394 fp->uf_arg_types[i] = type;
395 }
396 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100397 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200398
399 if (varargs)
400 {
401 char_u *p;
402
403 // Move the last argument "...name: type" to uf_va_name and
404 // uf_va_type.
405 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
406 [fp->uf_args.ga_len - 1];
407 --fp->uf_args.ga_len;
408 p = ((char_u **)argtypes->ga_data)[len];
409 if (p == NULL)
410 // TODO: get type from default value
411 fp->uf_va_type = &t_list_any;
412 else
413 {
414 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
415 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
416 {
417 semsg(_(e_variable_arguments_type_must_be_list_str),
418 ((char_u **)argtypes->ga_data)[len]);
419 return FAIL;
420 }
421 }
422 if (fp->uf_va_type == NULL)
423 return FAIL;
424 }
425
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100426 return OK;
427}
428
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100429 static int
430parse_return_type(ufunc_T *fp, char_u *ret_type)
431{
432 if (ret_type == NULL)
433 fp->uf_ret_type = &t_void;
434 else
435 {
436 char_u *p = ret_type;
437
438 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
439 if (fp->uf_ret_type == NULL)
440 {
441 fp->uf_ret_type = &t_void;
442 return FAIL;
443 }
444 }
445 return OK;
446}
447
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100448/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200449 * Register function "fp" as using "current_funccal" as its scope.
450 */
451 static int
452register_closure(ufunc_T *fp)
453{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200454 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100455 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200456 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200457 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 fp->uf_scoped = current_funccal;
459 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200460
Bram Moolenaar58016442016-07-31 18:30:22 +0200461 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
462 return FAIL;
463 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
464 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200465 return OK;
466}
467
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100468 static void
469set_ufunc_name(ufunc_T *fp, char_u *name)
470{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100471 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
472 // actually extends beyond the struct.
473 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100474
475 if (name[0] == K_SPECIAL)
476 {
477 fp->uf_name_exp = alloc(STRLEN(name) + 3);
478 if (fp->uf_name_exp != NULL)
479 {
480 STRCPY(fp->uf_name_exp, "<SNR>");
481 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
482 }
483 }
484}
485
Bram Moolenaar58016442016-07-31 18:30:22 +0200486/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200487 * Get a name for a lambda. Returned in static memory.
488 */
489 char_u *
490get_lambda_name(void)
491{
492 static char_u name[30];
493 static int lambda_no = 0;
494
495 sprintf((char*)name, "<lambda>%d", ++lambda_no);
496 return name;
497}
498
Bram Moolenaar801ab062020-06-25 19:27:56 +0200499#if defined(FEAT_LUA) || defined(PROTO)
500/*
501 * Registers a native C callback which can be called from Vim script.
502 * Returns the name of the Vim script function.
503 */
504 char_u *
505register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
506{
507 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200508 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200509
510 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
511 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200512 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200513
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200514 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200515 fp->uf_refcount = 1;
516 fp->uf_varargs = TRUE;
517 fp->uf_flags = FC_CFUNC;
518 fp->uf_calls = 0;
519 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200520 fp->uf_cb = cb;
521 fp->uf_cb_free = cb_free;
522 fp->uf_cb_state = state;
523
524 set_ufunc_name(fp, name);
525 hash_add(&func_hashtab, UF2HIKEY(fp));
526
527 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200528}
529#endif
530
Bram Moolenaar04b12692020-05-04 23:24:44 +0200531/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100532 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100533 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100534 * If "white_error" is not NULL check for correct use of white space and set
535 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100536 * Return NULL if no valid arrow found.
537 */
538 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100539skip_arrow(
540 char_u *start,
541 int equal_arrow,
542 char_u **ret_type,
543 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100544{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100545 char_u *s = start;
546 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100547
548 if (equal_arrow)
549 {
550 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100551 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100552 if (white_error != NULL && !VIM_ISWHITE(s[1]))
553 {
554 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100555 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100556 return NULL;
557 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100558 s = skipwhite(s + 1);
559 *ret_type = s;
560 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100561 if (s == *ret_type)
562 {
563 emsg(_(e_missing_return_type));
564 return NULL;
565 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100566 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100567 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100568 s = skipwhite(s);
569 if (*s != '=')
570 return NULL;
571 ++s;
572 }
573 if (*s != '>')
574 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100575 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
576 || !IS_WHITE_OR_NUL(s[1])))
577 {
578 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100579 semsg(_(e_white_space_required_before_and_after_str_at_str),
580 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100581 return NULL;
582 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100583 return skipwhite(s + 1);
584}
585
586/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100587 * Check if "*cmd" points to a function command and if so advance "*cmd" and
588 * return TRUE.
589 * Otherwise return FALSE;
590 * Do not consider "function(" to be a command.
591 */
592 static int
593is_function_cmd(char_u **cmd)
594{
595 char_u *p = *cmd;
596
597 if (checkforcmd(&p, "function", 2))
598 {
599 if (*p == '(')
600 return FALSE;
601 *cmd = p;
602 return TRUE;
603 }
604 return FALSE;
605}
606
607/*
608 * Read the body of a function, put every line in "newlines".
609 * "newlines" must already have been initialized.
610 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
611 */
612 static int
613get_function_body(
614 exarg_T *eap,
615 garray_T *newlines,
616 char_u *line_arg_in,
617 char_u **line_to_free)
618{
619 linenr_T sourcing_lnum_top = SOURCING_LNUM;
620 linenr_T sourcing_lnum_off;
621 int saved_wait_return = need_wait_return;
622 char_u *line_arg = line_arg_in;
623 int vim9_function = eap->cmdidx == CMD_def
624 || eap->cmdidx == CMD_block;
625#define MAX_FUNC_NESTING 50
626 char nesting_def[MAX_FUNC_NESTING];
627 int nesting = 0;
628 getline_opt_T getline_options;
629 int indent = 2;
630 char_u *skip_until = NULL;
631 int ret = FAIL;
632 int is_heredoc = FALSE;
633 char_u *heredoc_trimmed = NULL;
634
635 // Detect having skipped over comment lines to find the return
636 // type. Add NULL lines to keep the line count correct.
637 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
638 if (SOURCING_LNUM < sourcing_lnum_off)
639 {
640 sourcing_lnum_off -= SOURCING_LNUM;
641 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
642 goto theend;
643 while (sourcing_lnum_off-- > 0)
644 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
645 }
646
647 nesting_def[nesting] = vim9_function;
648 getline_options = vim9_function
649 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
650 for (;;)
651 {
652 char_u *theline;
653 char_u *p;
654 char_u *arg;
655
656 if (KeyTyped)
657 {
658 msg_scroll = TRUE;
659 saved_wait_return = FALSE;
660 }
661 need_wait_return = FALSE;
662
663 if (line_arg != NULL)
664 {
665 // Use eap->arg, split up in parts by line breaks.
666 theline = line_arg;
667 p = vim_strchr(theline, '\n');
668 if (p == NULL)
669 line_arg += STRLEN(line_arg);
670 else
671 {
672 *p = NUL;
673 line_arg = p + 1;
674 }
675 }
676 else
677 {
678 vim_free(*line_to_free);
679 if (eap->getline == NULL)
680 theline = getcmdline(':', 0L, indent, getline_options);
681 else
682 theline = eap->getline(':', eap->cookie, indent,
683 getline_options);
684 *line_to_free = theline;
685 }
686 if (KeyTyped)
687 lines_left = Rows - 1;
688 if (theline == NULL)
689 {
690 // Use the start of the function for the line number.
691 SOURCING_LNUM = sourcing_lnum_top;
692 if (skip_until != NULL)
693 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
694 else if (eap->cmdidx == CMD_def)
695 emsg(_(e_missing_enddef));
696 else if (eap->cmdidx == CMD_block)
697 emsg(_(e_missing_end_block));
698 else
699 emsg(_("E126: Missing :endfunction"));
700 goto theend;
701 }
702
703 // Detect line continuation: SOURCING_LNUM increased more than one.
704 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
705 if (SOURCING_LNUM < sourcing_lnum_off)
706 sourcing_lnum_off -= SOURCING_LNUM;
707 else
708 sourcing_lnum_off = 0;
709
710 if (skip_until != NULL)
711 {
712 // Don't check for ":endfunc"/":enddef" between
713 // * ":append" and "."
714 // * ":python <<EOF" and "EOF"
715 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
716 if (heredoc_trimmed == NULL
717 || (is_heredoc && skipwhite(theline) == theline)
718 || STRNCMP(theline, heredoc_trimmed,
719 STRLEN(heredoc_trimmed)) == 0)
720 {
721 if (heredoc_trimmed == NULL)
722 p = theline;
723 else if (is_heredoc)
724 p = skipwhite(theline) == theline
725 ? theline : theline + STRLEN(heredoc_trimmed);
726 else
727 p = theline + STRLEN(heredoc_trimmed);
728 if (STRCMP(p, skip_until) == 0)
729 {
730 VIM_CLEAR(skip_until);
731 VIM_CLEAR(heredoc_trimmed);
732 getline_options = vim9_function
733 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
734 is_heredoc = FALSE;
735 }
736 }
737 }
738 else
739 {
740 int c;
741
742 // skip ':' and blanks
743 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
744 ;
745
746 // Check for "endfunction", "enddef" or "}".
747 // When a ":" follows it must be a dict key; "enddef: value,"
748 if ((nesting == 0 && eap->cmdidx == CMD_block)
749 ? *p == '}'
750 : (checkforcmd(&p, nesting_def[nesting]
751 ? "enddef" : "endfunction", 4)
752 && *p != ':'))
753 {
754 if (nesting-- == 0)
755 {
756 char_u *nextcmd = NULL;
757
758 if (*p == '|' || *p == '}')
759 nextcmd = p + 1;
760 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
761 nextcmd = line_arg;
762 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100763 && (vim9_function || p_verbose > 0))
764 {
765 if (eap->cmdidx == CMD_def)
766 semsg(_(e_text_found_after_enddef_str), p);
767 else
768 give_warning2((char_u *)
769 _("W22: Text found after :endfunction: %s"),
770 p, TRUE);
771 }
772 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100773 {
774 // Another command follows. If the line came from "eap"
775 // we can simply point into it, otherwise we need to
776 // change "eap->cmdlinep".
777 eap->nextcmd = nextcmd;
778 if (*line_to_free != NULL)
779 {
780 vim_free(*eap->cmdlinep);
781 *eap->cmdlinep = *line_to_free;
782 *line_to_free = NULL;
783 }
784 }
785 break;
786 }
787 }
788
789 // Check for mismatched "endfunc" or "enddef".
790 // We don't check for "def" inside "func" thus we also can't check
791 // for "enddef".
792 // We continue to find the end of the function, although we might
793 // not find it.
794 else if (nesting_def[nesting])
795 {
796 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
797 emsg(_(e_mismatched_endfunction));
798 }
799 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
800 emsg(_(e_mismatched_enddef));
801
802 // Increase indent inside "if", "while", "for" and "try", decrease
803 // at "end".
804 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
805 indent -= 2;
806 else if (STRNCMP(p, "if", 2) == 0
807 || STRNCMP(p, "wh", 2) == 0
808 || STRNCMP(p, "for", 3) == 0
809 || STRNCMP(p, "try", 3) == 0)
810 indent += 2;
811
812 // Check for defining a function inside this function.
813 // Only recognize "def" inside "def", not inside "function",
814 // For backwards compatibility, see Test_function_python().
815 c = *p;
816 if (is_function_cmd(&p)
817 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
818 {
819 if (*p == '!')
820 p = skipwhite(p + 1);
821 p += eval_fname_script(p);
822 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
823 NULL, NULL));
824 if (*skipwhite(p) == '(')
825 {
826 if (nesting == MAX_FUNC_NESTING - 1)
827 emsg(_(e_function_nesting_too_deep));
828 else
829 {
830 ++nesting;
831 nesting_def[nesting] = (c == 'd');
832 indent += 2;
833 }
834 }
835 }
836
837 // Check for ":append", ":change", ":insert". Not for :def.
838 p = skip_range(p, FALSE, NULL);
839 if (!vim9_function
840 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
841 || (p[0] == 'c'
842 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
843 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
844 && (STRNCMP(&p[3], "nge", 3) != 0
845 || !ASCII_ISALPHA(p[6])))))))
846 || (p[0] == 'i'
847 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
848 && (!ASCII_ISALPHA(p[2])
849 || (p[2] == 's'
850 && (!ASCII_ISALPHA(p[3])
851 || p[3] == 'e'))))))))
852 skip_until = vim_strsave((char_u *)".");
853
854 // Check for ":python <<EOF", ":tcl <<EOF", etc.
855 arg = skipwhite(skiptowhite(p));
856 if (arg[0] == '<' && arg[1] =='<'
857 && ((p[0] == 'p' && p[1] == 'y'
858 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
859 || ((p[2] == '3' || p[2] == 'x')
860 && !ASCII_ISALPHA(p[3]))))
861 || (p[0] == 'p' && p[1] == 'e'
862 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
863 || (p[0] == 't' && p[1] == 'c'
864 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
865 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
866 && !ASCII_ISALPHA(p[3]))
867 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
868 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
869 || (p[0] == 'm' && p[1] == 'z'
870 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
871 ))
872 {
873 // ":python <<" continues until a dot, like ":append"
874 p = skipwhite(arg + 2);
875 if (STRNCMP(p, "trim", 4) == 0)
876 {
877 // Ignore leading white space.
878 p = skipwhite(p + 4);
879 heredoc_trimmed = vim_strnsave(theline,
880 skipwhite(theline) - theline);
881 }
882 if (*p == NUL)
883 skip_until = vim_strsave((char_u *)".");
884 else
885 skip_until = vim_strnsave(p, skiptowhite(p) - p);
886 getline_options = GETLINE_NONE;
887 is_heredoc = TRUE;
888 }
889
890 // Check for ":cmd v =<< [trim] EOF"
891 // and ":cmd [a, b] =<< [trim] EOF"
892 // and "lines =<< [trim] EOF" for Vim9
893 // Where "cmd" can be "let", "var", "final" or "const".
894 arg = skipwhite(skiptowhite(p));
895 if (*arg == '[')
896 arg = vim_strchr(arg, ']');
897 if (arg != NULL)
898 {
899 int found = (eap->cmdidx == CMD_def && arg[0] == '='
900 && arg[1] == '<' && arg[2] =='<');
901
902 if (!found)
903 // skip over the argument after "cmd"
904 arg = skipwhite(skiptowhite(arg));
905 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
906 && (checkforcmd(&p, "let", 2)
907 || checkforcmd(&p, "var", 3)
908 || checkforcmd(&p, "final", 5)
909 || checkforcmd(&p, "const", 5))))
910 {
911 p = skipwhite(arg + 3);
912 if (STRNCMP(p, "trim", 4) == 0)
913 {
914 // Ignore leading white space.
915 p = skipwhite(p + 4);
916 heredoc_trimmed = vim_strnsave(theline,
917 skipwhite(theline) - theline);
918 }
919 skip_until = vim_strnsave(p, skiptowhite(p) - p);
920 getline_options = GETLINE_NONE;
921 is_heredoc = TRUE;
922 }
923 }
924 }
925
926 // Add the line to the function.
927 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
928 goto theend;
929
930 // Copy the line to newly allocated memory. get_one_sourceline()
931 // allocates 250 bytes per line, this saves 80% on average. The cost
932 // is an extra alloc/free.
933 p = vim_strsave(theline);
934 if (p == NULL)
935 goto theend;
936 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
937
938 // Add NULL lines for continuation lines, so that the line count is
939 // equal to the index in the growarray.
940 while (sourcing_lnum_off-- > 0)
941 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
942
943 // Check for end of eap->arg.
944 if (line_arg != NULL && *line_arg == NUL)
945 line_arg = NULL;
946 }
947
948 // Don't define the function when skipping commands or when an error was
949 // detected.
950 if (!eap->skip && !did_emsg)
951 ret = OK;
952
953theend:
954 vim_free(skip_until);
955 vim_free(heredoc_trimmed);
956 need_wait_return |= saved_wait_return;
957 return ret;
958}
959
960/*
961 * Handle the body of a lambda. *arg points to the "{", process statements
962 * until the matching "}".
963 * When successful "rettv" is set to a funcref.
964 */
965 static int
966lambda_function_body(
967 char_u **arg,
968 typval_T *rettv,
969 evalarg_T *evalarg,
970 garray_T *newargs,
971 garray_T *argtypes,
972 int varargs,
973 garray_T *default_args,
974 char_u *ret_type)
975{
Bram Moolenaarfed9e832021-04-10 21:38:38 +0200976 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +0100977 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100978 exarg_T eap;
979 garray_T newlines;
980 char_u *cmdline = NULL;
981 int ret = FAIL;
982 char_u *line_to_free = NULL;
983 partial_T *pt;
984 char_u *name;
985 int lnum_save = -1;
986 linenr_T sourcing_lnum_top = SOURCING_LNUM;
987
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100988 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
989 {
990 semsg(_(e_trailing_arg), *arg + 1);
991 return FAIL;
992 }
993
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100994 CLEAR_FIELD(eap);
995 eap.cmdidx = CMD_block;
996 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 eap.cmdlinep = &cmdline;
998 eap.skip = !evaluate;
999 if (evalarg->eval_cctx != NULL)
1000 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1001 else
1002 {
1003 eap.getline = evalarg->eval_getline;
1004 eap.cookie = evalarg->eval_cookie;
1005 }
1006
1007 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1008 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001009 {
1010 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001011 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001012 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001013 if (cmdline != NULL)
1014 {
1015 // Something comes after the "}".
1016 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001017
1018 // "arg" points into cmdline, need to keep the line and free it later.
1019 vim_free(evalarg->eval_tofree_cmdline);
1020 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001021 }
1022 else
1023 *arg = (char_u *)"";
1024
1025 name = get_lambda_name();
1026 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1027 if (ufunc == NULL)
1028 goto erret;
1029 set_ufunc_name(ufunc, name);
1030 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001031 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001032 ufunc->uf_refcount = 1;
1033 ufunc->uf_args = *newargs;
1034 newargs->ga_data = NULL;
1035 ufunc->uf_def_args = *default_args;
1036 default_args->ga_data = NULL;
1037 ufunc->uf_func_type = &t_func_any;
1038
1039 // error messages are for the first function line
1040 lnum_save = SOURCING_LNUM;
1041 SOURCING_LNUM = sourcing_lnum_top;
1042
1043 // parse argument types
1044 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1045 {
1046 SOURCING_LNUM = lnum_save;
1047 goto erret;
1048 }
1049
1050 // parse the return type, if any
1051 if (parse_return_type(ufunc, ret_type) == FAIL)
1052 goto erret;
1053
1054 pt = ALLOC_CLEAR_ONE(partial_T);
1055 if (pt == NULL)
1056 goto erret;
1057 pt->pt_func = ufunc;
1058 pt->pt_refcount = 1;
1059
1060 ufunc->uf_lines = newlines;
1061 newlines.ga_data = NULL;
1062 if (sandbox)
1063 ufunc->uf_flags |= FC_SANDBOX;
1064 if (!ASCII_ISUPPER(*ufunc->uf_name))
1065 ufunc->uf_flags |= FC_VIM9;
1066 ufunc->uf_script_ctx = current_sctx;
1067 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1068 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1069 set_function_type(ufunc);
1070
1071 rettv->vval.v_partial = pt;
1072 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001073 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001074 ret = OK;
1075
1076erret:
1077 if (lnum_save >= 0)
1078 SOURCING_LNUM = lnum_save;
1079 vim_free(line_to_free);
1080 ga_clear_strings(&newlines);
1081 ga_clear_strings(newargs);
1082 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001083 if (ufunc != NULL)
1084 {
1085 func_clear(ufunc, TRUE);
1086 func_free(ufunc, TRUE);
1087 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001088 return ret;
1089}
1090
1091/*
1092 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001093 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001094 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001095 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1096 */
1097 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001098get_lambda_tv(
1099 char_u **arg,
1100 typval_T *rettv,
1101 int types_optional,
1102 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001103{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001104 int evaluate = evalarg != NULL
1105 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001106 garray_T newargs;
1107 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001108 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001109 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001110 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001111 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001112 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001113 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001114 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001115 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001116 char_u *s;
1117 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001118 int *old_eval_lavars = eval_lavars_used;
1119 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001120 char_u *tofree1 = NULL;
1121 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001122 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001123 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001124 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001125
1126 if (equal_arrow && !in_vim9script())
1127 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001128
1129 ga_init(&newargs);
1130 ga_init(&newlines);
1131
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001132 // First, check if this is really a lambda expression. "->" or "=>" must
1133 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001134 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001135 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001136 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001137 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001138 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001139 {
1140 if (types_optional)
1141 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001142 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001143 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001144
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001145 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001146 if (evaluate)
1147 pnewargs = &newargs;
1148 else
1149 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001150 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001151 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001152 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001153 &varargs, &default_args,
1154 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001155 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001156 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001157 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001158 {
1159 if (types_optional)
1160 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001161 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001162 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001163 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001164 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001165
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001166 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1167 if (ret_type != NULL)
1168 {
1169 ret_type = vim_strsave(ret_type);
1170 tofree2 = ret_type;
1171 }
1172
Bram Moolenaare38eab22019-12-05 21:50:01 +01001173 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001174 if (evaluate)
1175 eval_lavars_used = &eval_lavars;
1176
Bram Moolenaar65c44152020-12-24 15:14:01 +01001177 *arg = skipwhite_and_linebreak(*arg, evalarg);
1178
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001179 // Recognize "{" as the start of a function body.
1180 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001181 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001182 if (evalarg == NULL)
1183 // cannot happen?
1184 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001185 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1186 types_optional ? &argtypes : NULL, varargs,
1187 &default_args, ret_type) == FAIL)
1188 goto errret;
1189 goto theend;
1190 }
1191 if (default_args.ga_len > 0)
1192 {
1193 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001194 goto errret;
1195 }
1196
Bram Moolenaare38eab22019-12-05 21:50:01 +01001197 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001198 start = *arg;
1199 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001200 if (ret == FAIL)
1201 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001202 if (evalarg != NULL)
1203 {
1204 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001205 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001206 evalarg->eval_tofree = NULL;
1207 }
1208
Bram Moolenaar65c44152020-12-24 15:14:01 +01001209 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001210 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001211 *arg = skipwhite_and_linebreak(*arg, evalarg);
1212 if (**arg != '}')
1213 {
1214 semsg(_("E451: Expected }: %s"), *arg);
1215 goto errret;
1216 }
1217 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001218 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001219
1220 if (evaluate)
1221 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001222 int len;
1223 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001224 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001225 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001226
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001227 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001228 if (fp == NULL)
1229 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001230 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001231 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001232 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001233 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001234
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001235 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1236 if (ga_grow(&newlines, 1) == FAIL)
1237 goto errret;
1238
Bram Moolenaare38eab22019-12-05 21:50:01 +01001239 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001240 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001241 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001242 if (p == NULL)
1243 goto errret;
1244 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1245 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001246 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001247 if (strstr((char *)p + 7, "a:") == NULL)
1248 // No a: variables are used for sure.
1249 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001250
1251 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001252 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001253 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001254 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001255 if (types_optional)
1256 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001257 if (parse_argument_types(fp, &argtypes,
1258 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001259 goto errret;
1260 if (ret_type != NULL)
1261 {
1262 fp->uf_ret_type = parse_type(&ret_type,
1263 &fp->uf_type_list, TRUE);
1264 if (fp->uf_ret_type == NULL)
1265 goto errret;
1266 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001267 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001268 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001269 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001270
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001271 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001272 if (current_funccal != NULL && eval_lavars)
1273 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001274 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001275 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001276 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001277 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001278
1279#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001280 if (prof_def_func())
1281 func_do_profile(fp);
1282#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001283 if (sandbox)
1284 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001285 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001286 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1287 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001288 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001289 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001290 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001291 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001292
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001293 pt->pt_func = fp;
1294 pt->pt_refcount = 1;
1295 rettv->vval.v_partial = pt;
1296 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001297
1298 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001299 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001300
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001301theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001302 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001303 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001304 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001305 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001306 vim_free(tofree1);
1307 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001308 if (types_optional)
1309 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001310 return OK;
1311
1312errret:
1313 ga_clear_strings(&newargs);
1314 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001315 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001316 if (types_optional)
1317 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001318 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001319 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001320 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001321 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001322 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001323 vim_free(tofree1);
1324 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001325 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001326 return FAIL;
1327}
1328
1329/*
1330 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1331 * name it contains, otherwise return "name".
1332 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1333 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001334 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1335 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001336 */
1337 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001338deref_func_name(
1339 char_u *name,
1340 int *lenp,
1341 partial_T **partialp,
1342 type_T **type,
1343 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001344{
1345 dictitem_T *v;
1346 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001347 char_u *s = NULL;
1348 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001349
1350 if (partialp != NULL)
1351 *partialp = NULL;
1352
1353 cc = name[*lenp];
1354 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001355 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001357 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001358 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001359 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001361 if (v->di_tv.vval.v_string == NULL)
1362 {
1363 *lenp = 0;
1364 return (char_u *)""; // just in case
1365 }
1366 s = v->di_tv.vval.v_string;
1367 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001368 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001370 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001371 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001372 partial_T *pt = v->di_tv.vval.v_partial;
1373
1374 if (pt == NULL)
1375 {
1376 *lenp = 0;
1377 return (char_u *)""; // just in case
1378 }
1379 if (partialp != NULL)
1380 *partialp = pt;
1381 s = partial_name(pt);
1382 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001384
1385 if (s != NULL)
1386 {
1387 if (type != NULL && ht == get_script_local_ht())
1388 {
1389 svar_T *sv = find_typval_in_script(&v->di_tv);
1390
1391 if (sv != NULL)
1392 *type = sv->sv_type;
1393 }
1394 return s;
1395 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001396 }
1397
1398 return name;
1399}
1400
1401/*
1402 * Give an error message with a function name. Handle <SNR> things.
1403 * "ermsg" is to be passed without translation, use N_() instead of _().
1404 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001405 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001406emsg_funcname(char *ermsg, char_u *name)
1407{
1408 char_u *p;
1409
1410 if (*name == K_SPECIAL)
1411 p = concat_str((char_u *)"<SNR>", name + 3);
1412 else
1413 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001414 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001415 if (p != name)
1416 vim_free(p);
1417}
1418
1419/*
1420 * Allocate a variable for the result of a function.
1421 * Return OK or FAIL.
1422 */
1423 int
1424get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001425 char_u *name, // name of the function
1426 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001427 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001428 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001429 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001430 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001431{
1432 char_u *argp;
1433 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001434 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1435 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001436 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001437
1438 /*
1439 * Get the arguments.
1440 */
1441 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001442 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1443 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001445 // skip the '(' or ',' and possibly line breaks
1446 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1447
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448 if (*argp == ')' || *argp == ',' || *argp == NUL)
1449 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001450 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 {
1452 ret = FAIL;
1453 break;
1454 }
1455 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001456 // The comma should come right after the argument, but this wasn't
1457 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001458 if (vim9script)
1459 {
1460 if (*argp != ',' && *skipwhite(argp) == ',')
1461 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001462 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001463 ret = FAIL;
1464 break;
1465 }
1466 }
1467 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001468 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001469 if (*argp != ',')
1470 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001471 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1472 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001473 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001474 ret = FAIL;
1475 break;
1476 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001478 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001479 if (*argp == ')')
1480 ++argp;
1481 else
1482 ret = FAIL;
1483
1484 if (ret == OK)
1485 {
1486 int i = 0;
1487
1488 if (get_vim_var_nr(VV_TESTING))
1489 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001490 // Prepare for calling test_garbagecollect_now(), need to know
1491 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492 if (funcargs.ga_itemsize == 0)
1493 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1494 for (i = 0; i < argcount; ++i)
1495 if (ga_grow(&funcargs, 1) == OK)
1496 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1497 &argvars[i];
1498 }
1499
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001500 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001501
1502 funcargs.ga_len -= i;
1503 }
1504 else if (!aborting())
1505 {
1506 if (argcount == MAX_FUNC_ARGS)
1507 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1508 else
1509 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1510 }
1511
1512 while (--argcount >= 0)
1513 clear_tv(&argvars[argcount]);
1514
Bram Moolenaar8294d492020-08-10 22:40:56 +02001515 if (in_vim9script())
1516 *arg = argp;
1517 else
1518 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519 return ret;
1520}
1521
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522/*
1523 * Return TRUE if "p" starts with "<SID>" or "s:".
1524 * Only works if eval_fname_script() returned non-zero for "p"!
1525 */
1526 static int
1527eval_fname_sid(char_u *p)
1528{
1529 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1530}
1531
1532/*
1533 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1534 * Change <SNR>123_name() to K_SNR 123_name().
1535 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1536 * (slow).
1537 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001538 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001539fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1540{
1541 int llen;
1542 char_u *fname;
1543 int i;
1544
1545 llen = eval_fname_script(name);
1546 if (llen > 0)
1547 {
1548 fname_buf[0] = K_SPECIAL;
1549 fname_buf[1] = KS_EXTRA;
1550 fname_buf[2] = (int)KE_SNR;
1551 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001552 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001554 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001555 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 else
1557 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001558 sprintf((char *)fname_buf + 3, "%ld_",
1559 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 i = (int)STRLEN(fname_buf);
1561 }
1562 }
1563 if (i + STRLEN(name + llen) < FLEN_FIXED)
1564 {
1565 STRCPY(fname_buf + i, name + llen);
1566 fname = fname_buf;
1567 }
1568 else
1569 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001570 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001571 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001572 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001573 else
1574 {
1575 *tofree = fname;
1576 mch_memmove(fname, fname_buf, (size_t)i);
1577 STRCPY(fname + i, name + llen);
1578 }
1579 }
1580 }
1581 else
1582 fname = name;
1583 return fname;
1584}
1585
1586/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001587 * Find a function "name" in script "sid".
1588 */
1589 static ufunc_T *
1590find_func_with_sid(char_u *name, int sid)
1591{
1592 hashitem_T *hi;
1593 char_u buffer[200];
1594
1595 buffer[0] = K_SPECIAL;
1596 buffer[1] = KS_EXTRA;
1597 buffer[2] = (int)KE_SNR;
1598 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1599 (long)sid, name);
1600 hi = hash_find(&func_hashtab, buffer);
1601 if (!HASHITEM_EMPTY(hi))
1602 return HI2UF(hi);
1603
1604 return NULL;
1605}
1606
1607/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001609 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610 * Return NULL for unknown function.
1611 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001612 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001613find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001614{
1615 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001616 ufunc_T *func;
1617 imported_T *imported;
1618
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001619 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001620 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001621 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001622 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001623 int find_script_local = in_vim9script()
1624 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001625
Bram Moolenaar95006e32020-08-29 17:47:08 +02001626 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001627 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001628 // Find script-local function before global one.
1629 func = find_func_with_sid(name, current_sctx.sc_sid);
1630 if (func != NULL)
1631 return func;
1632 }
1633
Bram Moolenaarefa94442020-08-08 22:16:00 +02001634 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001635 && name[1] == KS_EXTRA
1636 && name[2] == KE_SNR)
1637 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001638 // Caller changes s: to <SNR>99_name.
1639
1640 after_script = name + 3;
1641 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001642 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001643 ++after_script;
1644 else
1645 after_script = NULL;
1646 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001647 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001648 {
1649 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001650 if (after_script != NULL && sid != current_sctx.sc_sid)
1651 imported = find_imported_in_script(after_script, 0, sid);
1652 else
1653 imported = find_imported(after_script == NULL
1654 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001655 if (imported != NULL && imported->imp_funcname != NULL)
1656 {
1657 hi = hash_find(&func_hashtab, imported->imp_funcname);
1658 if (!HASHITEM_EMPTY(hi))
1659 return HI2UF(hi);
1660 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001661 }
1662 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001663
Bram Moolenaara26b9702020-04-18 19:53:28 +02001664 hi = hash_find(&func_hashtab,
1665 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001666 if (!HASHITEM_EMPTY(hi))
1667 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001668
1669 return NULL;
1670}
1671
1672/*
1673 * Find a function by name, return pointer to it in ufuncs.
1674 * "cctx" is passed in a :def function to find imported functions.
1675 * Return NULL for unknown or dead function.
1676 */
1677 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001678find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001679{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001680 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001681
1682 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1683 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684 return NULL;
1685}
1686
1687/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001688 * Return TRUE if "ufunc" is a global function.
1689 */
1690 int
1691func_is_global(ufunc_T *ufunc)
1692{
1693 return ufunc->uf_name[0] != K_SPECIAL;
1694}
1695
1696/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 * Copy the function name of "fp" to buffer "buf".
1698 * "buf" must be able to hold the function name plus three bytes.
1699 * Takes care of script-local function names.
1700 */
1701 static void
1702cat_func_name(char_u *buf, ufunc_T *fp)
1703{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001704 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705 {
1706 STRCPY(buf, "<SNR>");
1707 STRCAT(buf, fp->uf_name + 3);
1708 }
1709 else
1710 STRCPY(buf, fp->uf_name);
1711}
1712
1713/*
1714 * Add a number variable "name" to dict "dp" with value "nr".
1715 */
1716 static void
1717add_nr_var(
1718 dict_T *dp,
1719 dictitem_T *v,
1720 char *name,
1721 varnumber_T nr)
1722{
1723 STRCPY(v->di_key, name);
1724 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1725 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1726 v->di_tv.v_type = VAR_NUMBER;
1727 v->di_tv.v_lock = VAR_FIXED;
1728 v->di_tv.vval.v_number = nr;
1729}
1730
1731/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001732 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001734 static void
1735free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001736{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001737 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001738
1739 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1740 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001741 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001742
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001743 // When garbage collecting a funccall_T may be freed before the
1744 // function that references it, clear its uf_scoped field.
1745 // The function may have been redefined and point to another
1746 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001747 if (fp != NULL && fp->uf_scoped == fc)
1748 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001749 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001750 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001752 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753 vim_free(fc);
1754}
1755
1756/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001757 * Free "fc" and what it contains.
1758 * Can be called only when "fc" is kept beyond the period of it called,
1759 * i.e. after cleanup_function_call(fc).
1760 */
1761 static void
1762free_funccal_contents(funccall_T *fc)
1763{
1764 listitem_T *li;
1765
1766 // Free all l: variables.
1767 vars_clear(&fc->l_vars.dv_hashtab);
1768
1769 // Free all a: variables.
1770 vars_clear(&fc->l_avars.dv_hashtab);
1771
1772 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001773 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001774 clear_tv(&li->li_tv);
1775
1776 free_funccal(fc);
1777}
1778
1779/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001780 * Handle the last part of returning from a function: free the local hashtable.
1781 * Unless it is still in use by a closure.
1782 */
1783 static void
1784cleanup_function_call(funccall_T *fc)
1785{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001786 int may_free_fc = fc->fc_refcount <= 0;
1787 int free_fc = TRUE;
1788
Bram Moolenaar6914c642017-04-01 21:21:30 +02001789 current_funccal = fc->caller;
1790
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001791 // Free all l: variables if not referred.
1792 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1793 vars_clear(&fc->l_vars.dv_hashtab);
1794 else
1795 free_fc = FALSE;
1796
1797 // If the a:000 list and the l: and a: dicts are not referenced and
1798 // there is no closure using it, we can free the funccall_T and what's
1799 // in it.
1800 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1801 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001802 else
1803 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001804 int todo;
1805 hashitem_T *hi;
1806 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001807
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001808 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001809
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001810 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001811 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1812 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1813 {
1814 if (!HASHITEM_EMPTY(hi))
1815 {
1816 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001817 di = HI2DI(hi);
1818 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001819 }
1820 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001821 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001822
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001823 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1824 fc->l_varlist.lv_first = NULL;
1825 else
1826 {
1827 listitem_T *li;
1828
1829 free_fc = FALSE;
1830
1831 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001832 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001833 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001834 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001835
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001836 if (free_fc)
1837 free_funccal(fc);
1838 else
1839 {
1840 static int made_copy = 0;
1841
1842 // "fc" is still in use. This can happen when returning "a:000",
1843 // assigning "l:" to a global variable or defining a closure.
1844 // Link "fc" in the list for garbage collection later.
1845 fc->caller = previous_funccal;
1846 previous_funccal = fc;
1847
1848 if (want_garbage_collect)
1849 // If garbage collector is ready, clear count.
1850 made_copy = 0;
1851 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001852 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001853 // We have made a lot of copies, worth 4 Mbyte. This can happen
1854 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001855 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001856 // too much memory.
1857 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001858 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001859 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001860 }
1861}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001862
1863/*
1864 * There are two kinds of function names:
1865 * 1. ordinary names, function defined with :function or :def
1866 * 2. numbered functions and lambdas
1867 * For the first we only count the name stored in func_hashtab as a reference,
1868 * using function() does not count as a reference, because the function is
1869 * looked up by name.
1870 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001871 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001872func_name_refcount(char_u *name)
1873{
1874 return isdigit(*name) || *name == '<';
1875}
1876
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001877/*
1878 * Unreference "fc": decrement the reference count and free it when it
1879 * becomes zero. "fp" is detached from "fc".
1880 * When "force" is TRUE we are exiting.
1881 */
1882 static void
1883funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1884{
1885 funccall_T **pfc;
1886 int i;
1887
1888 if (fc == NULL)
1889 return;
1890
1891 if (--fc->fc_refcount <= 0 && (force || (
1892 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1893 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1894 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1895 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1896 {
1897 if (fc == *pfc)
1898 {
1899 *pfc = fc->caller;
1900 free_funccal_contents(fc);
1901 return;
1902 }
1903 }
1904 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1905 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1906 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1907}
1908
1909/*
1910 * Remove the function from the function hashtable. If the function was
1911 * deleted while it still has references this was already done.
1912 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1913 */
1914 static int
1915func_remove(ufunc_T *fp)
1916{
1917 hashitem_T *hi;
1918
1919 // Return if it was already virtually deleted.
1920 if (fp->uf_flags & FC_DEAD)
1921 return FALSE;
1922
1923 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1924 if (!HASHITEM_EMPTY(hi))
1925 {
1926 // When there is a def-function index do not actually remove the
1927 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001928 // Do remove it when it's a copy.
1929 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001930 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001931 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001932 return FALSE;
1933 }
1934 hash_remove(&func_hashtab, hi);
1935 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001936 return TRUE;
1937 }
1938 return FALSE;
1939}
1940
1941 static void
1942func_clear_items(ufunc_T *fp)
1943{
1944 ga_clear_strings(&(fp->uf_args));
1945 ga_clear_strings(&(fp->uf_def_args));
1946 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001947 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001948 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001949 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001950 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001951
1952 // Increment the refcount of this function to avoid it being freed
1953 // recursively when the partial is freed.
1954 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001955 partial_unref(fp->uf_partial);
1956 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001957 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001958
1959#ifdef FEAT_LUA
1960 if (fp->uf_cb_free != NULL)
1961 {
1962 fp->uf_cb_free(fp->uf_cb_state);
1963 fp->uf_cb_free = NULL;
1964 }
1965
1966 fp->uf_cb_state = NULL;
1967 fp->uf_cb = NULL;
1968#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001969#ifdef FEAT_PROFILE
1970 VIM_CLEAR(fp->uf_tml_count);
1971 VIM_CLEAR(fp->uf_tml_total);
1972 VIM_CLEAR(fp->uf_tml_self);
1973#endif
1974}
1975
1976/*
1977 * Free all things that a function contains. Does not free the function
1978 * itself, use func_free() for that.
1979 * When "force" is TRUE we are exiting.
1980 */
1981 static void
1982func_clear(ufunc_T *fp, int force)
1983{
1984 if (fp->uf_cleared)
1985 return;
1986 fp->uf_cleared = TRUE;
1987
1988 // clear this function
1989 func_clear_items(fp);
1990 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001991 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001992}
1993
1994/*
1995 * Free a function and remove it from the list of functions. Does not free
1996 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001997 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001998 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001999 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002000 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002001func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002002{
2003 // Only remove it when not done already, otherwise we would remove a newer
2004 // version of the function with the same name.
2005 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2006 func_remove(fp);
2007
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002008 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002009 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002010 if (fp->uf_dfunc_idx > 0)
2011 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002012 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002013 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002014 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002015 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002016 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002017}
2018
2019/*
2020 * Free all things that a function contains and free the function itself.
2021 * When "force" is TRUE we are exiting.
2022 */
2023 static void
2024func_clear_free(ufunc_T *fp, int force)
2025{
2026 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002027 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2028 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002029 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002030 else
2031 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002032}
2033
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002034/*
2035 * Copy already defined function "lambda" to a new function with name "global".
2036 * This is for when a compiled function defines a global function.
2037 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002038 int
2039copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002040{
2041 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002042 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002043
2044 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002045 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002046 semsg(_(e_lambda_function_not_found_str), lambda);
2047 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002048 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002049
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002050 fp = find_func(global, TRUE, NULL);
2051 if (fp != NULL)
2052 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002053 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002054 semsg(_(e_funcexts), global);
2055 return FAIL;
2056 }
2057
2058 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2059 if (fp == NULL)
2060 return FAIL;
2061
2062 fp->uf_varargs = ufunc->uf_varargs;
2063 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2064 fp->uf_def_status = ufunc->uf_def_status;
2065 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2066 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2067 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2068 == FAIL
2069 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2070 goto failed;
2071
2072 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2073 : vim_strsave(ufunc->uf_name_exp);
2074 if (ufunc->uf_arg_types != NULL)
2075 {
2076 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2077 if (fp->uf_arg_types == NULL)
2078 goto failed;
2079 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2080 sizeof(type_T *) * fp->uf_args.ga_len);
2081 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002082 if (ufunc->uf_va_name != NULL)
2083 {
2084 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2085 if (fp->uf_va_name == NULL)
2086 goto failed;
2087 }
2088 fp->uf_ret_type = ufunc->uf_ret_type;
2089
2090 fp->uf_refcount = 1;
2091 STRCPY(fp->uf_name, global);
2092 hash_add(&func_hashtab, UF2HIKEY(fp));
2093
2094 // the referenced dfunc_T is now used one more time
2095 link_def_function(fp);
2096
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002097 // Create a partial to store the context of the function where it was
2098 // instantiated. Only needs to be done once. Do this on the original
2099 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002100 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2101 {
2102 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2103
2104 if (pt == NULL)
2105 goto failed;
2106 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002107 {
2108 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002109 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002110 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002111 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002112 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002113 }
2114
2115 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002116
2117failed:
2118 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002119 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002120}
2121
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002122static int funcdepth = 0;
2123
2124/*
2125 * Increment the function call depth count.
2126 * Return FAIL when going over 'maxfuncdepth'.
2127 * Otherwise return OK, must call funcdepth_decrement() later!
2128 */
2129 int
2130funcdepth_increment(void)
2131{
2132 if (funcdepth >= p_mfd)
2133 {
2134 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2135 return FAIL;
2136 }
2137 ++funcdepth;
2138 return OK;
2139}
2140
2141 void
2142funcdepth_decrement(void)
2143{
2144 --funcdepth;
2145}
2146
2147/*
2148 * Get the current function call depth.
2149 */
2150 int
2151funcdepth_get(void)
2152{
2153 return funcdepth;
2154}
2155
2156/*
2157 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002158 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002159 * times as funcdepth_increment().
2160 */
2161 void
2162funcdepth_restore(int depth)
2163{
2164 funcdepth = depth;
2165}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002166
2167/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002168 * Call a user function.
2169 */
2170 static void
2171call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002172 ufunc_T *fp, // pointer to function
2173 int argcount, // nr of args
2174 typval_T *argvars, // arguments
2175 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002176 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002177 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002178{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002179 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002180 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002181 funccall_T *fc;
2182 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002183 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002184 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002185 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002186 int i;
2187 int ai;
2188 int islambda = FALSE;
2189 char_u numbuf[NUMBUFLEN];
2190 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002191#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002192 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002193#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002194 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195
Bram Moolenaarb2049902021-01-24 12:53:53 +01002196#ifdef FEAT_PROFILE
2197 CLEAR_FIELD(profile_info);
2198#endif
2199
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002200 // If depth of calling is getting too high, don't execute the function.
2201 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002202 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002203 rettv->v_type = VAR_NUMBER;
2204 rettv->vval.v_number = -1;
2205 return;
2206 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002207
Bram Moolenaare38eab22019-12-05 21:50:01 +01002208 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002209
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002210 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002211 if (fc == NULL)
2212 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002213 fc->caller = current_funccal;
2214 current_funccal = fc;
2215 fc->func = fp;
2216 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002218 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2220 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002221 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002222 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002223 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002224
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002225 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002226 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002227#ifdef FEAT_PROFILE
2228 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2229#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002230 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002231#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002232 if (do_profiling == PROF_YES)
2233 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002234#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002235 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002236 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002237#ifdef FEAT_PROFILE
2238 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002239 || (caller != NULL && caller->uf_profiling)))
2240 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002241#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002242 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002243 free_funccal(fc);
2244 return;
2245 }
2246
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2248 islambda = TRUE;
2249
2250 /*
2251 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2252 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2253 * each argument variable and saves a lot of time.
2254 */
2255 /*
2256 * Init l: variables.
2257 */
2258 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2259 if (selfdict != NULL)
2260 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002261 // Set l:self to "selfdict". Use "name" to avoid a warning from
2262 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002263 v = &fc->fixvar[fixvar_idx++].var;
2264 name = v->di_key;
2265 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002266 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002267 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2268 v->di_tv.v_type = VAR_DICT;
2269 v->di_tv.v_lock = 0;
2270 v->di_tv.vval.v_dict = selfdict;
2271 ++selfdict->dv_refcount;
2272 }
2273
2274 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002275 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002276 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277 * Set a:000 to a list with room for the "..." arguments.
2278 */
2279 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002280 if ((fp->uf_flags & FC_NOARGS) == 0)
2281 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002282 (varnumber_T)(argcount >= fp->uf_args.ga_len
2283 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002284 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002285 if ((fp->uf_flags & FC_NOARGS) == 0)
2286 {
2287 // Use "name" to avoid a warning from some compiler that checks the
2288 // destination size.
2289 v = &fc->fixvar[fixvar_idx++].var;
2290 name = v->di_key;
2291 STRCPY(name, "000");
2292 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2293 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2294 v->di_tv.v_type = VAR_LIST;
2295 v->di_tv.v_lock = VAR_FIXED;
2296 v->di_tv.vval.v_list = &fc->l_varlist;
2297 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002298 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002299 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2300 fc->l_varlist.lv_lock = VAR_FIXED;
2301
2302 /*
2303 * Set a:firstline to "firstline" and a:lastline to "lastline".
2304 * Set a:name to named arguments.
2305 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002306 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002307 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002308 if ((fp->uf_flags & FC_NOARGS) == 0)
2309 {
2310 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002311 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002312 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002313 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002314 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002315 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002316 {
2317 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002318 typval_T def_rettv;
2319 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320
2321 ai = i - fp->uf_args.ga_len;
2322 if (ai < 0)
2323 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002324 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002325 name = FUNCARG(fp, i);
2326 if (islambda)
2327 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002328
2329 // evaluate named argument default expression
2330 isdefault = ai + fp->uf_def_args.ga_len >= 0
2331 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2332 && argvars[i].vval.v_number == VVAL_NONE));
2333 if (isdefault)
2334 {
2335 char_u *default_expr = NULL;
2336 def_rettv.v_type = VAR_NUMBER;
2337 def_rettv.vval.v_number = -1;
2338
2339 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2340 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002341 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002342 {
2343 default_arg_err = 1;
2344 break;
2345 }
2346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002347 }
2348 else
2349 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002350 if ((fp->uf_flags & FC_NOARGS) != 0)
2351 // Bail out if no a: arguments used (in lambda).
2352 break;
2353
Bram Moolenaare38eab22019-12-05 21:50:01 +01002354 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355 sprintf((char *)numbuf, "%d", ai + 1);
2356 name = numbuf;
2357 }
2358 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2359 {
2360 v = &fc->fixvar[fixvar_idx++].var;
2361 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002362 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 }
2364 else
2365 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002366 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367 if (v == NULL)
2368 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002369 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002370 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002372 // Note: the values are copied directly to avoid alloc/free.
2373 // "argvars" must have VAR_FIXED for v_lock.
2374 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002375 v->di_tv.v_lock = VAR_FIXED;
2376
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002377 if (addlocal)
2378 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002379 // Named arguments should be accessed without the "a:" prefix in
2380 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002381 copy_tv(&v->di_tv, &v->di_tv);
2382 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002383 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002384 else
2385 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002386
2387 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2388 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002389 listitem_T *li = &fc->l_listitems[ai];
2390
2391 li->li_tv = argvars[i];
2392 li->li_tv.v_lock = VAR_FIXED;
2393 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002394 }
2395 }
2396
Bram Moolenaare38eab22019-12-05 21:50:01 +01002397 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002399
2400 if (fp->uf_flags & FC_SANDBOX)
2401 {
2402 using_sandbox = TRUE;
2403 ++sandbox;
2404 }
2405
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002406 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002407 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002408 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002410 ++no_wait_return;
2411 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002413 smsg(_("calling %s"), SOURCING_NAME);
2414 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002415 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002416 char_u buf[MSG_BUF_LEN];
2417 char_u numbuf2[NUMBUFLEN];
2418 char_u *tofree;
2419 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002420
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002421 msg_puts("(");
2422 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002424 if (i > 0)
2425 msg_puts(", ");
2426 if (argvars[i].v_type == VAR_NUMBER)
2427 msg_outnum((long)argvars[i].vval.v_number);
2428 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002429 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002430 // Do not want errors such as E724 here.
2431 ++emsg_off;
2432 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2433 --emsg_off;
2434 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002435 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002436 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002437 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002438 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2439 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002441 msg_puts((char *)s);
2442 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002443 }
2444 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002445 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002446 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002448 msg_puts("\n"); // don't overwrite this either
2449
2450 verbose_leave_scroll();
2451 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452 }
2453#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002454 if (do_profiling == PROF_YES)
2455 profile_may_start_func(&profile_info, fp,
2456 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457#endif
2458
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002459 save_current_sctx = current_sctx;
2460 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461 save_did_emsg = did_emsg;
2462 did_emsg = FALSE;
2463
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002464 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2465 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002466 else if (islambda)
2467 {
2468 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2469
2470 // A Lambda always has the command "return {expr}". It is much faster
2471 // to evaluate {expr} directly.
2472 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002473 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002474 --ex_nesting_level;
2475 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002476 else
2477 // call do_cmdline() to execute the lines
2478 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2480
2481 --RedrawingDisabled;
2482
Bram Moolenaare38eab22019-12-05 21:50:01 +01002483 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2485 {
2486 clear_tv(rettv);
2487 rettv->v_type = VAR_NUMBER;
2488 rettv->vval.v_number = -1;
2489 }
2490
2491#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002492 if (do_profiling == PROF_YES)
2493 {
2494 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2495
2496 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2497 profile_may_end_func(&profile_info, fp, caller);
2498 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002499#endif
2500
Bram Moolenaare38eab22019-12-05 21:50:01 +01002501 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502 if (p_verbose >= 12)
2503 {
2504 ++no_wait_return;
2505 verbose_enter_scroll();
2506
2507 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002508 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002510 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511 (long)fc->rettv->vval.v_number);
2512 else
2513 {
2514 char_u buf[MSG_BUF_LEN];
2515 char_u numbuf2[NUMBUFLEN];
2516 char_u *tofree;
2517 char_u *s;
2518
Bram Moolenaare38eab22019-12-05 21:50:01 +01002519 // The value may be very long. Skip the middle part, so that we
2520 // have some idea how it starts and ends. smsg() would always
2521 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 ++emsg_off;
2523 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2524 --emsg_off;
2525 if (s != NULL)
2526 {
2527 if (vim_strsize(s) > MSG_BUF_CLEN)
2528 {
2529 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2530 s = buf;
2531 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002532 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 vim_free(tofree);
2534 }
2535 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002536 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537
2538 verbose_leave_scroll();
2539 --no_wait_return;
2540 }
2541
Bram Moolenaare31ee862020-01-07 20:59:34 +01002542 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002543 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002544 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002545#ifdef FEAT_PROFILE
2546 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002547 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002549 if (using_sandbox)
2550 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002551
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002552 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 {
2554 ++no_wait_return;
2555 verbose_enter_scroll();
2556
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002557 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002558 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559
2560 verbose_leave_scroll();
2561 --no_wait_return;
2562 }
2563
2564 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002565 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002566 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002567}
2568
2569/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002570 * Check the argument count for user function "fp".
2571 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2572 */
2573 int
2574check_user_func_argcount(ufunc_T *fp, int argcount)
2575{
2576 int regular_args = fp->uf_args.ga_len;
2577
2578 if (argcount < regular_args - fp->uf_def_args.ga_len)
2579 return FCERR_TOOFEW;
2580 else if (!has_varargs(fp) && argcount > regular_args)
2581 return FCERR_TOOMANY;
2582 return FCERR_UNKNOWN;
2583}
2584
2585/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002586 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002587 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002588 int
2589call_user_func_check(
2590 ufunc_T *fp,
2591 int argcount,
2592 typval_T *argvars,
2593 typval_T *rettv,
2594 funcexe_T *funcexe,
2595 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002596{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002597 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002598
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002599 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2600 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002601 error = check_user_func_argcount(fp, argcount);
2602 if (error != FCERR_UNKNOWN)
2603 return error;
2604 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002605 error = FCERR_DICT;
2606 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002607 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002608 int did_save_redo = FALSE;
2609 save_redo_T save_redo;
2610
2611 /*
2612 * Call the user function.
2613 * Save and restore search patterns, script variables and
2614 * redo buffer.
2615 */
2616 save_search_patterns();
2617 if (!ins_compl_active())
2618 {
2619 saveRedobuff(&save_redo);
2620 did_save_redo = TRUE;
2621 }
2622 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002623 call_user_func(fp, argcount, argvars, rettv, funcexe,
2624 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002625 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2626 // Function was unreferenced while being used, free it now.
2627 func_clear_free(fp, FALSE);
2628 if (did_save_redo)
2629 restoreRedobuff(&save_redo);
2630 restore_search_patterns();
2631 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002632 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002633 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002634}
2635
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002636static funccal_entry_T *funccal_stack = NULL;
2637
2638/*
2639 * Save the current function call pointer, and set it to NULL.
2640 * Used when executing autocommands and for ":source".
2641 */
2642 void
2643save_funccal(funccal_entry_T *entry)
2644{
2645 entry->top_funccal = current_funccal;
2646 entry->next = funccal_stack;
2647 funccal_stack = entry;
2648 current_funccal = NULL;
2649}
2650
2651 void
2652restore_funccal(void)
2653{
2654 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002655 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002656 else
2657 {
2658 current_funccal = funccal_stack->top_funccal;
2659 funccal_stack = funccal_stack->next;
2660 }
2661}
2662
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002663 funccall_T *
2664get_current_funccal(void)
2665{
2666 return current_funccal;
2667}
2668
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002669/*
2670 * Mark all functions of script "sid" as deleted.
2671 */
2672 void
2673delete_script_functions(int sid)
2674{
2675 hashitem_T *hi;
2676 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002677 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002678 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002679 size_t len;
2680
2681 buf[0] = K_SPECIAL;
2682 buf[1] = KS_EXTRA;
2683 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002684 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002685 len = STRLEN(buf);
2686
Bram Moolenaarce658352020-07-31 23:47:12 +02002687 while (todo > 0)
2688 {
2689 todo = func_hashtab.ht_used;
2690 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2691 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002692 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002693 fp = HI2UF(hi);
2694 if (STRNCMP(fp->uf_name, buf, len) == 0)
2695 {
2696 int changed = func_hashtab.ht_changed;
2697
2698 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002699
2700 if (fp->uf_calls > 0)
2701 {
2702 // Function is executing, don't free it but do remove
2703 // it from the hashtable.
2704 if (func_remove(fp))
2705 fp->uf_refcount--;
2706 }
2707 else
2708 {
2709 func_clear(fp, TRUE);
2710 // When clearing a function another function can be
2711 // cleared as a side effect. When that happens start
2712 // over.
2713 if (changed != func_hashtab.ht_changed)
2714 break;
2715 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002716 }
2717 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002718 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002719 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002720}
2721
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722#if defined(EXITFREE) || defined(PROTO)
2723 void
2724free_all_functions(void)
2725{
2726 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002727 ufunc_T *fp;
2728 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002729 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002730 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731
Bram Moolenaare38eab22019-12-05 21:50:01 +01002732 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002733 while (current_funccal != NULL)
2734 {
2735 clear_tv(current_funccal->rettv);
2736 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002737 if (current_funccal == NULL && funccal_stack != NULL)
2738 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002739 }
2740
Bram Moolenaare38eab22019-12-05 21:50:01 +01002741 // First clear what the functions contain. Since this may lower the
2742 // reference count of a function, it may also free a function and change
2743 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002744 while (todo > 0)
2745 {
2746 todo = func_hashtab.ht_used;
2747 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2748 if (!HASHITEM_EMPTY(hi))
2749 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002750 // clear the def function index now
2751 fp = HI2UF(hi);
2752 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002753 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002754
Bram Moolenaare38eab22019-12-05 21:50:01 +01002755 // Only free functions that are not refcounted, those are
2756 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002757 if (func_name_refcount(fp->uf_name))
2758 ++skipped;
2759 else
2760 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002761 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002762 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002763 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002764 {
2765 skipped = 0;
2766 break;
2767 }
2768 }
2769 --todo;
2770 }
2771 }
2772
Bram Moolenaare38eab22019-12-05 21:50:01 +01002773 // Now actually free the functions. Need to start all over every time,
2774 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002775 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002776 while (func_hashtab.ht_used > skipped)
2777 {
2778 todo = func_hashtab.ht_used;
2779 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 if (!HASHITEM_EMPTY(hi))
2781 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002782 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002783 // Only free functions that are not refcounted, those are
2784 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002785 fp = HI2UF(hi);
2786 if (func_name_refcount(fp->uf_name))
2787 ++skipped;
2788 else
2789 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002790 if (func_free(fp, FALSE) == OK)
2791 {
2792 skipped = 0;
2793 break;
2794 }
2795 // did not actually free it
2796 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002797 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002799 }
2800 if (skipped == 0)
2801 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002802
2803 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804}
2805#endif
2806
2807/*
2808 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002809 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 * "len" is the length of "name", or -1 for NUL terminated.
2811 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002812 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813builtin_function(char_u *name, int len)
2814{
2815 char_u *p;
2816
Bram Moolenaara26b9702020-04-18 19:53:28 +02002817 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 return FALSE;
2819 p = vim_strchr(name, AUTOLOAD_CHAR);
2820 return p == NULL || (len > 0 && p > name + len);
2821}
2822
2823 int
2824func_call(
2825 char_u *name,
2826 typval_T *args,
2827 partial_T *partial,
2828 dict_T *selfdict,
2829 typval_T *rettv)
2830{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002831 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 listitem_T *item;
2833 typval_T argv[MAX_FUNC_ARGS + 1];
2834 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 int r = 0;
2836
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002837 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002838 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839 {
2840 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2841 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002842 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 break;
2844 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002845 // Make a copy of each argument. This is needed to be able to set
2846 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847 copy_tv(&item->li_tv, &argv[argc++]);
2848 }
2849
2850 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002851 {
2852 funcexe_T funcexe;
2853
Bram Moolenaara80faa82020-04-12 19:37:17 +02002854 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002855 funcexe.firstline = curwin->w_cursor.lnum;
2856 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002857 funcexe.evaluate = TRUE;
2858 funcexe.partial = partial;
2859 funcexe.selfdict = selfdict;
2860 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2861 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862
Bram Moolenaare38eab22019-12-05 21:50:01 +01002863 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 while (argc > 0)
2865 clear_tv(&argv[--argc]);
2866
2867 return r;
2868}
2869
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002870static int callback_depth = 0;
2871
2872 int
2873get_callback_depth(void)
2874{
2875 return callback_depth;
2876}
2877
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002879 * Invoke call_func() with a callback.
2880 */
2881 int
2882call_callback(
2883 callback_T *callback,
2884 int len, // length of "name" or -1 to use strlen()
2885 typval_T *rettv, // return value goes here
2886 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002887 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002888 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002889{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002890 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002891 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002892
Bram Moolenaara80faa82020-04-12 19:37:17 +02002893 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002894 funcexe.evaluate = TRUE;
2895 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002896 ++callback_depth;
2897 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2898 --callback_depth;
2899 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002900}
2901
2902/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002903 * Give an error message for the result of a function.
2904 * Nothing if "error" is FCERR_NONE.
2905 */
2906 void
2907user_func_error(int error, char_u *name)
2908{
2909 switch (error)
2910 {
2911 case FCERR_UNKNOWN:
2912 emsg_funcname(e_unknownfunc, name);
2913 break;
2914 case FCERR_NOTMETHOD:
2915 emsg_funcname(
2916 N_("E276: Cannot use function as a method: %s"), name);
2917 break;
2918 case FCERR_DELETED:
2919 emsg_funcname(N_(e_func_deleted), name);
2920 break;
2921 case FCERR_TOOMANY:
2922 emsg_funcname((char *)e_toomanyarg, name);
2923 break;
2924 case FCERR_TOOFEW:
2925 emsg_funcname((char *)e_toofewarg, name);
2926 break;
2927 case FCERR_SCRIPT:
2928 emsg_funcname(
2929 N_("E120: Using <SID> not in a script context: %s"), name);
2930 break;
2931 case FCERR_DICT:
2932 emsg_funcname(
2933 N_("E725: Calling dict function without Dictionary: %s"),
2934 name);
2935 break;
2936 }
2937}
2938
2939/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002941 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002942 * Return FAIL when the function can't be called, OK otherwise.
2943 * Also returns OK when an error was encountered while executing the function.
2944 */
2945 int
2946call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002947 char_u *funcname, // name of the function
2948 int len, // length of "name" or -1 to use strlen()
2949 typval_T *rettv, // return value goes here
2950 int argcount_in, // number of "argvars"
2951 typval_T *argvars_in, // vars for arguments, must have "argcount"
2952 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002953 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954{
2955 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002956 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002957 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002958 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002959 char_u fname_buf[FLEN_FIXED + 1];
2960 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002961 char_u *fname = NULL;
2962 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002963 int argcount = argcount_in;
2964 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002965 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002966 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2967 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002969 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002970 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002972 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2973 // even when call_func() returns FAIL.
2974 rettv->v_type = VAR_UNKNOWN;
2975
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002976 if (partial != NULL)
2977 fp = partial->pt_func;
2978 if (fp == NULL)
2979 {
2980 // Make a copy of the name, if it comes from a funcref variable it
2981 // could be changed or deleted in the called function.
2982 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2983 if (name == NULL)
2984 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002985
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002986 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2987 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002989 if (funcexe->doesrange != NULL)
2990 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991
2992 if (partial != NULL)
2993 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002994 // When the function has a partial with a dict and there is a dict
2995 // argument, use the dict argument. That is backwards compatible.
2996 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002997 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002999 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000 {
3001 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003002 {
3003 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3004 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003005 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003006 goto theend;
3007 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003009 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003010 for (i = 0; i < argcount_in; ++i)
3011 argv[i + argv_clear] = argvars_in[i];
3012 argvars = argv;
3013 argcount = partial->pt_argc + argcount_in;
3014 }
3015 }
3016
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003017 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3018 {
3019 // Check that the argument types are OK for the types of the funcref.
3020 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003021 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003022 error = FCERR_OTHER;
3023 }
3024
Bram Moolenaaref140542019-12-31 21:27:13 +01003025 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 {
3027 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003028 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029
Bram Moolenaar333894b2020-08-01 18:53:07 +02003030 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003031 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003032 {
3033 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003035 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003036
Bram Moolenaare38eab22019-12-05 21:50:01 +01003037 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003039 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003040
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003041 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003042 {
3043 /*
3044 * User defined function.
3045 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003046 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003047 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048
Bram Moolenaare38eab22019-12-05 21:50:01 +01003049 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003050 if (fp == NULL
3051 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003052 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003053 && !aborting())
3054 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003055 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003056 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003057 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003058 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3060 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003061 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003062 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003063 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003064 if (fp == NULL)
3065 {
3066 char_u *p = untrans_function_name(rfname);
3067
3068 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003069 // Don't do this if the name starts with "s:".
3070 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003071 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003072 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003074 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003075 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003076#ifdef FEAT_LUA
3077 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3078 {
3079 cfunc_T cb = fp->uf_cb;
3080
3081 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3082 }
3083#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003084 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003086 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003087 // postponed filling in the arguments, do it now
3088 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003089 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003090
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003091 if (funcexe->basetv != NULL)
3092 {
3093 // Method call: base->Method()
3094 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3095 argv[0] = *funcexe->basetv;
3096 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003097 argvars = argv;
3098 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003099 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003100
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003101 error = call_user_func_check(fp, argcount, argvars, rettv,
3102 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 }
3104 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003105 else if (funcexe->basetv != NULL)
3106 {
3107 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003108 * expr->method(): Find the method name in the table, call its
3109 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003110 */
3111 error = call_internal_method(fname, argcount, argvars, rettv,
3112 funcexe->basetv);
3113 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003114 else
3115 {
3116 /*
3117 * Find the function name in the table, call its implementation.
3118 */
3119 error = call_internal_func(fname, argcount, argvars, rettv);
3120 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003121
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122 /*
3123 * The function call (or "FuncUndefined" autocommand sequence) might
3124 * have been aborted by an error, an interrupt, or an explicitly thrown
3125 * exception that has not been caught so far. This situation can be
3126 * tested for by calling aborting(). For an error in an internal
3127 * function or for the "E132" error in call_user_func(), however, the
3128 * throw point at which the "force_abort" flag (temporarily reset by
3129 * emsg()) is normally updated has not been reached yet. We need to
3130 * update that flag first to make aborting() reliable.
3131 */
3132 update_force_abort();
3133 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003134 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135 ret = OK;
3136
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003137theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 /*
3139 * Report an error unless the argument evaluation or function call has been
3140 * cancelled due to an aborting error, an interrupt, or an exception.
3141 */
3142 if (!aborting())
3143 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003144 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145 }
3146
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003147 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003149 clear_tv(&argv[--argv_clear + argv_base]);
3150
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 vim_free(tofree);
3152 vim_free(name);
3153
3154 return ret;
3155}
3156
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003157 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003158printable_func_name(ufunc_T *fp)
3159{
3160 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3161}
3162
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003163/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003164 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 */
3166 static void
3167list_func_head(ufunc_T *fp, int indent)
3168{
3169 int j;
3170
3171 msg_start();
3172 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003173 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003174 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003175 msg_puts("def ");
3176 else
3177 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003178 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179 msg_putchar('(');
3180 for (j = 0; j < fp->uf_args.ga_len; ++j)
3181 {
3182 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003183 msg_puts(", ");
3184 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003185 if (fp->uf_arg_types != NULL)
3186 {
3187 char *tofree;
3188
3189 msg_puts(": ");
3190 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3191 vim_free(tofree);
3192 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003193 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3194 {
3195 msg_puts(" = ");
3196 msg_puts(((char **)(fp->uf_def_args.ga_data))
3197 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003199 }
3200 if (fp->uf_varargs)
3201 {
3202 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003203 msg_puts(", ");
3204 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003205 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003206 if (fp->uf_va_name != NULL)
3207 {
3208 if (j)
3209 msg_puts(", ");
3210 msg_puts("...");
3211 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003212 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003213 {
3214 char *tofree;
3215
3216 msg_puts(": ");
3217 msg_puts(type_name(fp->uf_va_type, &tofree));
3218 vim_free(tofree);
3219 }
3220 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003221 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003222
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003223 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003224 {
3225 if (fp->uf_ret_type != &t_void)
3226 {
3227 char *tofree;
3228
3229 msg_puts(": ");
3230 msg_puts(type_name(fp->uf_ret_type, &tofree));
3231 vim_free(tofree);
3232 }
3233 }
3234 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003235 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003237 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003238 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003239 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003240 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003241 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242 msg_clr_eos();
3243 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003244 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245}
3246
3247/*
3248 * Get a function name, translating "<SID>" and "<SNR>".
3249 * Also handles a Funcref in a List or Dictionary.
3250 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003251 * Set "*is_global" to TRUE when the function must be global, unless
3252 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253 * flags:
3254 * TFN_INT: internal function name OK
3255 * TFN_QUIET: be quiet
3256 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003257 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258 * Advances "pp" to just after the function name (if no error).
3259 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003260 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261trans_function_name(
3262 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003263 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003264 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003266 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003267 partial_T **partial, // return: partial of a FuncRef
3268 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269{
3270 char_u *name = NULL;
3271 char_u *start;
3272 char_u *end;
3273 int lead;
3274 char_u sid_buf[20];
3275 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003276 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003278 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003279 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280
3281 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003282 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003283 start = *pp;
3284
Bram Moolenaare38eab22019-12-05 21:50:01 +01003285 // Check for hard coded <SNR>: already translated function ID (from a user
3286 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3288 && (*pp)[2] == (int)KE_SNR)
3289 {
3290 *pp += 3;
3291 len = get_id_len(pp) + 3;
3292 return vim_strnsave(start, len);
3293 }
3294
Bram Moolenaare38eab22019-12-05 21:50:01 +01003295 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3296 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003297 lead = eval_fname_script(start);
3298 if (lead > 2)
3299 start += lead;
3300
Bram Moolenaare38eab22019-12-05 21:50:01 +01003301 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003302 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 lead > 2 ? 0 : FNE_CHECK_START);
3304 if (end == start)
3305 {
3306 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003307 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003308 goto theend;
3309 }
3310 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3311 {
3312 /*
3313 * Report an invalid expression in braces, unless the expression
3314 * evaluation has been cancelled due to an aborting error, an
3315 * interrupt, or an exception.
3316 */
3317 if (!aborting())
3318 {
3319 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003320 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321 }
3322 else
3323 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3324 goto theend;
3325 }
3326
3327 if (lv.ll_tv != NULL)
3328 {
3329 if (fdp != NULL)
3330 {
3331 fdp->fd_dict = lv.ll_dict;
3332 fdp->fd_newkey = lv.ll_newkey;
3333 lv.ll_newkey = NULL;
3334 fdp->fd_di = lv.ll_di;
3335 }
3336 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3337 {
3338 name = vim_strsave(lv.ll_tv->vval.v_string);
3339 *pp = end;
3340 }
3341 else if (lv.ll_tv->v_type == VAR_PARTIAL
3342 && lv.ll_tv->vval.v_partial != NULL)
3343 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003344 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 *pp = end;
3346 if (partial != NULL)
3347 *partial = lv.ll_tv->vval.v_partial;
3348 }
3349 else
3350 {
3351 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3352 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003353 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 else
3355 *pp = end;
3356 name = NULL;
3357 }
3358 goto theend;
3359 }
3360
3361 if (lv.ll_name == NULL)
3362 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003363 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 *pp = end;
3365 goto theend;
3366 }
3367
Bram Moolenaare38eab22019-12-05 21:50:01 +01003368 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 if (lv.ll_exp_name != NULL)
3370 {
3371 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003372 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 flags & TFN_NO_AUTOLOAD);
3374 if (name == lv.ll_exp_name)
3375 name = NULL;
3376 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003377 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 {
3379 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003380 name = deref_func_name(*pp, &len, partial, type,
3381 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 if (name == *pp)
3383 name = NULL;
3384 }
3385 if (name != NULL)
3386 {
3387 name = vim_strsave(name);
3388 *pp = end;
3389 if (STRNCMP(name, "<SNR>", 5) == 0)
3390 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003391 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 name[0] = K_SPECIAL;
3393 name[1] = KS_EXTRA;
3394 name[2] = (int)KE_SNR;
3395 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3396 }
3397 goto theend;
3398 }
3399
3400 if (lv.ll_exp_name != NULL)
3401 {
3402 len = (int)STRLEN(lv.ll_exp_name);
3403 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3404 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3405 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003406 // When there was "s:" already or the name expanded to get a
3407 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 lv.ll_name += 2;
3409 len -= 2;
3410 lead = 2;
3411 }
3412 }
3413 else
3414 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003415 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003417 {
3418 if (is_global != NULL && lv.ll_name[0] == 'g')
3419 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 len = (int)(end - lv.ll_name);
3423 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003424 if (len <= 0)
3425 {
3426 if (!skip)
3427 emsg(_(e_function_name));
3428 goto theend;
3429 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003431 // In Vim9 script a user function is script-local by default, unless it
3432 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003433 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003434 if (vim9script)
3435 {
3436 char_u *p;
3437
3438 // SomeScript#func() is a global function.
3439 for (p = start; *p != NUL && *p != '('; ++p)
3440 if (*p == AUTOLOAD_CHAR)
3441 vim9script = FALSE;
3442 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003443
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 /*
3445 * Copy the function name to allocated memory.
3446 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3447 * Accept <SNR>123_name() outside a script.
3448 */
3449 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003450 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003451 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003453 if (!vim9script)
3454 lead = 3;
3455 if (vim9script || (lv.ll_exp_name != NULL
3456 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 || eval_fname_sid(*pp))
3458 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003459 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003460 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003462 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 goto theend;
3464 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003465 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003466 if (vim9script)
3467 extra = 3 + (int)STRLEN(sid_buf);
3468 else
3469 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470 }
3471 }
3472 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3473 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003474 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003475 start);
3476 goto theend;
3477 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003478 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 {
3480 char_u *cp = vim_strchr(lv.ll_name, ':');
3481
3482 if (cp != NULL && cp < end)
3483 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003484 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 goto theend;
3486 }
3487 }
3488
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003489 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 if (name != NULL)
3491 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003492 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 {
3494 name[0] = K_SPECIAL;
3495 name[1] = KS_EXTRA;
3496 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003497 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 STRCPY(name + 3, sid_buf);
3499 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003500 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3501 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 }
3503 *pp = end;
3504
3505theend:
3506 clear_lval(&lv);
3507 return name;
3508}
3509
3510/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003511 * Assuming "name" is the result of trans_function_name() and it was prefixed
3512 * to use the script-local name, return the unmodified name (points into
3513 * "name"). Otherwise return NULL.
3514 * This can be used to first search for a script-local function and fall back
3515 * to the global function if not found.
3516 */
3517 char_u *
3518untrans_function_name(char_u *name)
3519{
3520 char_u *p;
3521
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003522 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003523 {
3524 p = vim_strchr(name, '_');
3525 if (p != NULL)
3526 return p + 1;
3527 }
3528 return NULL;
3529}
3530
3531/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003532 * List functions. When "regmatch" is NULL all of then.
3533 * Otherwise functions matching "regmatch".
3534 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003535 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003536list_functions(regmatch_T *regmatch)
3537{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003538 int changed = func_hashtab.ht_changed;
3539 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003540 hashitem_T *hi;
3541
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003542 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003543 {
3544 if (!HASHITEM_EMPTY(hi))
3545 {
3546 ufunc_T *fp = HI2UF(hi);
3547
3548 --todo;
3549 if ((fp->uf_flags & FC_DEAD) == 0
3550 && (regmatch == NULL
3551 ? !message_filtered(fp->uf_name)
3552 && !func_name_refcount(fp->uf_name)
3553 : !isdigit(*fp->uf_name)
3554 && vim_regexec(regmatch, fp->uf_name, 0)))
3555 {
3556 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003557 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003558 {
3559 emsg(_("E454: function list was modified"));
3560 return;
3561 }
3562 }
3563 }
3564 }
3565}
3566
3567/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003568 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003569 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3570 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003571 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003573 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003574define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003576 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 int j;
3578 int c;
3579 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003580 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003581 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003582 char_u *p;
3583 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003584 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 char_u *line_arg = NULL;
3586 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003587 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003588 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 garray_T newlines;
3590 int varargs = FALSE;
3591 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003592 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003593 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003594 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 dictitem_T *v;
3596 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003597 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003600 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003601 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003602 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603
3604 /*
3605 * ":function" without argument: list functions.
3606 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003607 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 {
3609 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003610 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003612 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003613 }
3614
3615 /*
3616 * ":function /pat": list functions matching pattern.
3617 */
3618 if (*eap->arg == '/')
3619 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003620 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 if (!eap->skip)
3622 {
3623 regmatch_T regmatch;
3624
3625 c = *p;
3626 *p = NUL;
3627 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3628 *p = c;
3629 if (regmatch.regprog != NULL)
3630 {
3631 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003632 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 vim_regfree(regmatch.regprog);
3634 }
3635 }
3636 if (*p == '/')
3637 ++p;
3638 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003639 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640 }
3641
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003642 ga_init(&newargs);
3643 ga_init(&argtypes);
3644 ga_init(&default_args);
3645
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 /*
3647 * Get the function name. There are these situations:
3648 * func normal function name
3649 * "name" == func, "fudi.fd_dict" == NULL
3650 * dict.func new dictionary entry
3651 * "name" == NULL, "fudi.fd_dict" set,
3652 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3653 * dict.func existing dict entry with a Funcref
3654 * "name" == func, "fudi.fd_dict" set,
3655 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3656 * dict.func existing dict entry that's not a Funcref
3657 * "name" == NULL, "fudi.fd_dict" set,
3658 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3659 * s:func script-local function name
3660 * g:func global function name, same as "func"
3661 */
3662 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003663 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003665 // nested function, argument is (args).
3666 paren = TRUE;
3667 CLEAR_FIELD(fudi);
3668 }
3669 else
3670 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003671 if (STRNCMP(p, "<lambda>", 8) == 0)
3672 {
3673 p += 8;
3674 (void)getdigits(&p);
3675 name = vim_strnsave(eap->arg, p - eap->arg);
3676 CLEAR_FIELD(fudi);
3677 }
3678 else
3679 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003680 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003681 paren = (vim_strchr(p, '(') != NULL);
3682 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003684 /*
3685 * Return on an invalid expression in braces, unless the expression
3686 * evaluation has been cancelled due to an aborting error, an
3687 * interrupt, or an exception.
3688 */
3689 if (!aborting())
3690 {
3691 if (!eap->skip && fudi.fd_newkey != NULL)
3692 semsg(_(e_dictkey), fudi.fd_newkey);
3693 vim_free(fudi.fd_newkey);
3694 return NULL;
3695 }
3696 else
3697 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 }
3700
Bram Moolenaare38eab22019-12-05 21:50:01 +01003701 // An error in a function call during evaluation of an expression in magic
3702 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 saved_did_emsg = did_emsg;
3704 did_emsg = FALSE;
3705
3706 /*
3707 * ":function func" with only function name: list function.
3708 */
3709 if (!paren)
3710 {
3711 if (!ends_excmd(*skipwhite(p)))
3712 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003713 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003714 goto ret_free;
3715 }
3716 eap->nextcmd = check_nextcmd(p);
3717 if (eap->nextcmd != NULL)
3718 *p = NUL;
3719 if (!eap->skip && !got_int)
3720 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003721 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003722 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3723 {
3724 char_u *up = untrans_function_name(name);
3725
3726 // With Vim9 script the name was made script-local, if not
3727 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003728 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003729 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003730 }
3731
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732 if (fp != NULL)
3733 {
3734 list_func_head(fp, TRUE);
3735 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3736 {
3737 if (FUNCLINE(fp, j) == NULL)
3738 continue;
3739 msg_putchar('\n');
3740 msg_outnum((long)(j + 1));
3741 if (j < 9)
3742 msg_putchar(' ');
3743 if (j < 99)
3744 msg_putchar(' ');
3745 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003746 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 ui_breakcheck();
3748 }
3749 if (!got_int)
3750 {
3751 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003752 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003753 msg_puts(" enddef");
3754 else
3755 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 }
3757 }
3758 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003759 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 }
3761 goto ret_free;
3762 }
3763
3764 /*
3765 * ":function name(arg1, arg2)" Define function.
3766 */
3767 p = skipwhite(p);
3768 if (*p != '(')
3769 {
3770 if (!eap->skip)
3771 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003772 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003773 goto ret_free;
3774 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003775 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 if (vim_strchr(p, '(') != NULL)
3777 p = vim_strchr(p, '(');
3778 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003779
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003780 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3781 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003782 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003783 goto ret_free;
3784 }
3785
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003786 // In Vim9 script only global functions can be redefined.
3787 if (vim9script && eap->forceit && !is_global)
3788 {
3789 emsg(_(e_nobang));
3790 goto ret_free;
3791 }
3792
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003793 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794
Bram Moolenaar04b12692020-05-04 23:24:44 +02003795 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003797 // Check the name of the function. Unless it's a dictionary function
3798 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 if (name != NULL)
3800 arg = name;
3801 else
3802 arg = fudi.fd_newkey;
3803 if (arg != NULL && (fudi.fd_di == NULL
3804 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3805 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3806 {
3807 if (*arg == K_SPECIAL)
3808 j = 3;
3809 else
3810 j = 0;
3811 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3812 : eval_isnamec(arg[j])))
3813 ++j;
3814 if (arg[j] != NUL)
3815 emsg_funcname((char *)e_invarg2, arg);
3816 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003817 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003819 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 }
3821
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003822 // This may get more lines and make the pointers into the first line
3823 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003824 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003825 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003826 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003827 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003828 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003830 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003832 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003834 // find the return type: :def Func(): type
3835 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003837 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003838 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003839 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003840 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003841 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003842 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003843 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003844 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003845 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003846 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003847 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003848 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003849 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003851 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003853 else
3854 // find extra arguments "range", "dict", "abort" and "closure"
3855 for (;;)
3856 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003857 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003858 p = skipwhite(p);
3859 if (STRNCMP(p, "range", 5) == 0)
3860 {
3861 flags |= FC_RANGE;
3862 p += 5;
3863 }
3864 else if (STRNCMP(p, "dict", 4) == 0)
3865 {
3866 flags |= FC_DICT;
3867 p += 4;
3868 }
3869 else if (STRNCMP(p, "abort", 5) == 0)
3870 {
3871 flags |= FC_ABORT;
3872 p += 5;
3873 }
3874 else if (STRNCMP(p, "closure", 7) == 0)
3875 {
3876 flags |= FC_CLOSURE;
3877 p += 7;
3878 if (current_funccal == NULL)
3879 {
3880 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3881 name == NULL ? (char_u *)"" : name);
3882 goto erret;
3883 }
3884 }
3885 else
3886 break;
3887 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888
Bram Moolenaare38eab22019-12-05 21:50:01 +01003889 // When there is a line break use what follows for the function body.
3890 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003891 if (*p == '\n')
3892 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003893 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003894 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3895 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003896 && !(VIM_ISWHITE(*whitep) && *p == '#'
3897 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003898 && !eap->skip
3899 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003900 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901
3902 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003903 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3904 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905 */
3906 if (KeyTyped)
3907 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003908 // Check if the function already exists, don't let the user type the
3909 // whole function before telling him it doesn't work! For a script we
3910 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 if (!eap->skip && !eap->forceit)
3912 {
3913 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003914 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003915 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916 emsg_funcname(e_funcexts, name);
3917 }
3918
3919 if (!eap->skip && did_emsg)
3920 goto erret;
3921
Bram Moolenaare38eab22019-12-05 21:50:01 +01003922 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003923 cmdline_row = msg_row;
3924 }
3925
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003926 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003927 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003928
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003929 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 goto erret;
3931
3932 /*
3933 * If there are no errors, add the function
3934 */
3935 if (fudi.fd_dict == NULL)
3936 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003937 hashtab_T *ht;
3938
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003939 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3941 {
3942 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3943 name);
3944 goto erret;
3945 }
3946
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003947 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003948 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003950 char_u *uname = untrans_function_name(name);
3951
3952 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3953 }
3954
3955 if (fp != NULL || import != NULL)
3956 {
3957 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003958
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003959 // Function can be replaced with "function!" and when sourcing the
3960 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003961 // A name that is used by an import can not be overruled.
3962 if (import != NULL
3963 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003964 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003965 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003967 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003968 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003969 else
3970 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 goto erret;
3972 }
3973 if (fp->uf_calls > 0)
3974 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003975 emsg_funcname(
3976 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977 name);
3978 goto erret;
3979 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003980 if (fp->uf_refcount > 1)
3981 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003982 // This function is referenced somewhere, don't redefine it but
3983 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003984 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003985 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003986 fp = NULL;
3987 overwrite = TRUE;
3988 }
3989 else
3990 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003991 char_u *exp_name = fp->uf_name_exp;
3992
3993 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003994 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003995 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003996 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003997 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003998 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003999#ifdef FEAT_PROFILE
4000 fp->uf_profiling = FALSE;
4001 fp->uf_prof_initialized = FALSE;
4002#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004003 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004004 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005 }
4006 }
4007 else
4008 {
4009 char numbuf[20];
4010
4011 fp = NULL;
4012 if (fudi.fd_newkey == NULL && !eap->forceit)
4013 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004014 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 goto erret;
4016 }
4017 if (fudi.fd_di == NULL)
4018 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004019 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004020 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 goto erret;
4022 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004023 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004024 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 goto erret;
4026
Bram Moolenaare38eab22019-12-05 21:50:01 +01004027 // Give the function a sequential number. Can only be used with a
4028 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 vim_free(name);
4030 sprintf(numbuf, "%d", ++func_nr);
4031 name = vim_strsave((char_u *)numbuf);
4032 if (name == NULL)
4033 goto erret;
4034 }
4035
4036 if (fp == NULL)
4037 {
4038 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4039 {
4040 int slen, plen;
4041 char_u *scriptname;
4042
Bram Moolenaare38eab22019-12-05 21:50:01 +01004043 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004045 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 {
4047 scriptname = autoload_name(name);
4048 if (scriptname != NULL)
4049 {
4050 p = vim_strchr(scriptname, '/');
4051 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004052 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004054 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 j = OK;
4056 vim_free(scriptname);
4057 }
4058 }
4059 if (j == FAIL)
4060 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004061 linenr_T save_lnum = SOURCING_LNUM;
4062
4063 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004064 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004065 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066 goto erret;
4067 }
4068 }
4069
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004070 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 if (fp == NULL)
4072 goto erret;
4073
4074 if (fudi.fd_dict != NULL)
4075 {
4076 if (fudi.fd_di == NULL)
4077 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004078 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4080 if (fudi.fd_di == NULL)
4081 {
4082 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004083 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 goto erret;
4085 }
4086 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4087 {
4088 vim_free(fudi.fd_di);
4089 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004090 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091 goto erret;
4092 }
4093 }
4094 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004095 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004096 clear_tv(&fudi.fd_di->di_tv);
4097 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099
Bram Moolenaare38eab22019-12-05 21:50:01 +01004100 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 flags |= FC_DICT;
4102 }
4103
Bram Moolenaare38eab22019-12-05 21:50:01 +01004104 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004105 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004106 if (overwrite)
4107 {
4108 hi = hash_find(&func_hashtab, name);
4109 hi->hi_key = UF2HIKEY(fp);
4110 }
4111 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 {
4113 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004114 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115 goto erret;
4116 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004117 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 }
4119 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004120 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004121 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004122 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004123
4124 if (eap->cmdidx == CMD_def)
4125 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004126 int lnum_save = SOURCING_LNUM;
4127 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004128
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004129 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004130
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004131 // error messages are for the first function line
4132 SOURCING_LNUM = sourcing_lnum_top;
4133
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004134 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004135 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004136 int count = cstack->cs_idx + 1;
4137 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004138
4139 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004140 // a block that is visible now but not when the function is called
4141 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004142 fp->uf_block_ids = ALLOC_MULT(int, count);
4143 if (fp->uf_block_ids != NULL)
4144 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004145 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004146 sizeof(int) * count);
4147 fp->uf_block_depth = count;
4148 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004149
4150 // Set flag in each block to indicate a function was defined. This
4151 // is used to keep the variable when leaving the block, see
4152 // hide_script_var().
4153 for (i = 0; i <= cstack->cs_idx; ++i)
4154 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004155 }
4156
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004157 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004158 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004159 SOURCING_LNUM = lnum_save;
4160 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004161 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004162 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004163
4164 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004165 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004166 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004167 SOURCING_LNUM = lnum_save;
4168 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004169 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004170 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004171 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004172 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004173 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004174
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004176 if ((flags & FC_CLOSURE) != 0)
4177 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004178 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004179 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004180 }
4181 else
4182 fp->uf_scoped = NULL;
4183
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 if (prof_def_func())
4186 func_do_profile(fp);
4187#endif
4188 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004189 if (sandbox)
4190 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004191 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004192 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 fp->uf_flags = flags;
4194 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004195 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004196 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004197 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004198 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004199 if (is_export)
4200 {
4201 fp->uf_flags |= FC_EXPORT;
4202 // let ex_export() know the export worked.
4203 is_export = FALSE;
4204 }
4205
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004206 if (eap->cmdidx == CMD_def)
4207 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004208 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4209 // :func does not use Vim9 script syntax, even in a Vim9 script file
4210 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004211
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004212 goto ret_free;
4213
4214erret:
4215 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004216 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004217 if (fp != NULL)
4218 {
4219 ga_init(&fp->uf_args);
4220 ga_init(&fp->uf_def_args);
4221 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222errret_2:
4223 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004224 if (fp != NULL)
4225 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004226ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004227 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004228 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004230 if (name != name_arg)
4231 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004232 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004233 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004234
4235 return fp;
4236}
4237
4238/*
4239 * ":function"
4240 */
4241 void
4242ex_function(exarg_T *eap)
4243{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004244 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004245}
4246
4247/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004248 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004249 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004250 */
4251 void
4252ex_defcompile(exarg_T *eap UNUSED)
4253{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004254 long todo = (long)func_hashtab.ht_used;
4255 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004256 hashitem_T *hi;
4257 ufunc_T *ufunc;
4258
4259 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4260 {
4261 if (!HASHITEM_EMPTY(hi))
4262 {
4263 --todo;
4264 ufunc = HI2UF(hi);
4265 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004266 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4267 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004268 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004269 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004270
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004271 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004272 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004273 // a function has been added or removed, need to start over
4274 todo = (long)func_hashtab.ht_used;
4275 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004276 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004277 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004278 }
4279 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004280 }
4281 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282}
4283
4284/*
4285 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4286 * Return 2 if "p" starts with "s:".
4287 * Return 0 otherwise.
4288 */
4289 int
4290eval_fname_script(char_u *p)
4291{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004292 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4293 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4295 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4296 return 5;
4297 if (p[0] == 's' && p[1] == ':')
4298 return 2;
4299 return 0;
4300}
4301
4302 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004303translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304{
4305 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004306 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004307 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004308}
4309
4310/*
4311 * Return TRUE when "ufunc" has old-style "..." varargs
4312 * or named varargs "...name: type".
4313 */
4314 int
4315has_varargs(ufunc_T *ufunc)
4316{
4317 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318}
4319
4320/*
4321 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004322 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 */
4324 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004325function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004326{
4327 char_u *nm = name;
4328 char_u *p;
4329 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004330 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004331 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004333 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4334 if (no_deref)
4335 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004336 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 nm = skipwhite(nm);
4338
Bram Moolenaare38eab22019-12-05 21:50:01 +01004339 // Only accept "funcname", "funcname ", "funcname (..." and
4340 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004342 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343 vim_free(p);
4344 return n;
4345}
4346
Bram Moolenaar113e1072019-01-20 15:30:40 +01004347#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004348 char_u *
4349get_expanded_name(char_u *name, int check)
4350{
4351 char_u *nm = name;
4352 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004353 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004354
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004355 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004356 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004358 if (p != NULL && *nm == NUL
4359 && (!check || translated_function_exists(p, is_global)))
4360 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361
4362 vim_free(p);
4363 return NULL;
4364}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004365#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367/*
4368 * Function given to ExpandGeneric() to obtain the list of user defined
4369 * function names.
4370 */
4371 char_u *
4372get_user_func_name(expand_T *xp, int idx)
4373{
4374 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004375 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376 static hashitem_T *hi;
4377 ufunc_T *fp;
4378
4379 if (idx == 0)
4380 {
4381 done = 0;
4382 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004383 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004385 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 {
4387 if (done++ > 0)
4388 ++hi;
4389 while (HASHITEM_EMPTY(hi))
4390 ++hi;
4391 fp = HI2UF(hi);
4392
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004393 // don't show dead, dict and lambda functions
4394 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004395 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004396 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397
4398 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004399 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400
4401 cat_func_name(IObuff, fp);
4402 if (xp->xp_context != EXPAND_USER_FUNC)
4403 {
4404 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004405 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004406 STRCAT(IObuff, ")");
4407 }
4408 return IObuff;
4409 }
4410 return NULL;
4411}
4412
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413/*
4414 * ":delfunction {name}"
4415 */
4416 void
4417ex_delfunction(exarg_T *eap)
4418{
4419 ufunc_T *fp = NULL;
4420 char_u *p;
4421 char_u *name;
4422 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004423 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424
4425 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004426 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4427 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428 vim_free(fudi.fd_newkey);
4429 if (name == NULL)
4430 {
4431 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004432 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 return;
4434 }
4435 if (!ends_excmd(*skipwhite(p)))
4436 {
4437 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004438 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 return;
4440 }
4441 eap->nextcmd = check_nextcmd(p);
4442 if (eap->nextcmd != NULL)
4443 *p = NUL;
4444
4445 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004446 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447 vim_free(name);
4448
4449 if (!eap->skip)
4450 {
4451 if (fp == NULL)
4452 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004453 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004454 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 return;
4456 }
4457 if (fp->uf_calls > 0)
4458 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004459 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004460 return;
4461 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004462 if (fp->uf_flags & FC_VIM9)
4463 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004464 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004465 return;
4466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467
4468 if (fudi.fd_dict != NULL)
4469 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004470 // Delete the dict item that refers to the function, it will
4471 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4473 }
4474 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004475 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004476 // A normal function (not a numbered function or lambda) has a
4477 // refcount of 1 for the entry in the hashtable. When deleting
4478 // it and the refcount is more than one, it should be kept.
4479 // A numbered function and lambda should be kept if the refcount is
4480 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004481 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004482 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004483 // Function is still referenced somewhere. Don't free it but
4484 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004485 if (func_remove(fp))
4486 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004487 }
4488 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004489 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004490 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 }
4492}
4493
4494/*
4495 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004496 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 */
4498 void
4499func_unref(char_u *name)
4500{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004501 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004503 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004505 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004506 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004507 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004509 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004511 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004512 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004513 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004514}
4515
4516/*
4517 * Unreference a Function: decrement the reference count and free it when it
4518 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004519 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004520 */
4521 void
4522func_ptr_unref(ufunc_T *fp)
4523{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004524 if (fp != NULL && (--fp->uf_refcount <= 0
4525 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4526 && fp->uf_partial->pt_refcount <= 1
4527 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004528 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004529 // Only delete it when it's not being used. Otherwise it's done
4530 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004531 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004532 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533 }
4534}
4535
4536/*
4537 * Count a reference to a Function.
4538 */
4539 void
4540func_ref(char_u *name)
4541{
4542 ufunc_T *fp;
4543
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004544 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004546 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004547 if (fp != NULL)
4548 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004550 // Only give an error for a numbered function.
4551 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004552 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004553}
4554
4555/*
4556 * Count a reference to a Function.
4557 */
4558 void
4559func_ptr_ref(ufunc_T *fp)
4560{
4561 if (fp != NULL)
4562 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563}
4564
4565/*
4566 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4567 * referenced from anywhere that is in use.
4568 */
4569 static int
4570can_free_funccal(funccall_T *fc, int copyID)
4571{
4572 return (fc->l_varlist.lv_copyID != copyID
4573 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004574 && fc->l_avars.dv_copyID != copyID
4575 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576}
4577
4578/*
4579 * ":return [expr]"
4580 */
4581 void
4582ex_return(exarg_T *eap)
4583{
4584 char_u *arg = eap->arg;
4585 typval_T rettv;
4586 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004587 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004588
4589 if (current_funccal == NULL)
4590 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004591 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592 return;
4593 }
4594
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004595 CLEAR_FIELD(evalarg);
4596 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4597
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598 if (eap->skip)
4599 ++emsg_skip;
4600
4601 eap->nextcmd = NULL;
4602 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004603 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 {
4605 if (!eap->skip)
4606 returning = do_return(eap, FALSE, TRUE, &rettv);
4607 else
4608 clear_tv(&rettv);
4609 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004610 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004611 else if (!eap->skip)
4612 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004613 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004614 update_force_abort();
4615
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616 /*
4617 * Return unless the expression evaluation has been cancelled due to an
4618 * aborting error, an interrupt, or an exception.
4619 */
4620 if (!aborting())
4621 returning = do_return(eap, FALSE, TRUE, NULL);
4622 }
4623
Bram Moolenaare38eab22019-12-05 21:50:01 +01004624 // When skipping or the return gets pending, advance to the next command
4625 // in this line (!returning). Otherwise, ignore the rest of the line.
4626 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627 if (returning)
4628 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004629 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630 eap->nextcmd = check_nextcmd(arg);
4631
4632 if (eap->skip)
4633 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004634 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004635}
4636
4637/*
4638 * ":1,25call func(arg1, arg2)" function call.
4639 */
4640 void
4641ex_call(exarg_T *eap)
4642{
4643 char_u *arg = eap->arg;
4644 char_u *startarg;
4645 char_u *name;
4646 char_u *tofree;
4647 int len;
4648 typval_T rettv;
4649 linenr_T lnum;
4650 int doesrange;
4651 int failed = FALSE;
4652 funcdict_T fudi;
4653 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004654 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004655 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656
Bram Moolenaare6b53242020-07-01 17:28:33 +02004657 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658 if (eap->skip)
4659 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004660 // trans_function_name() doesn't work well when skipping, use eval0()
4661 // instead to skip to any following command, e.g. for:
4662 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004663 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004664 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665 clear_tv(&rettv);
4666 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004667 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668 return;
4669 }
4670
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004671 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4672 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004673 if (fudi.fd_newkey != NULL)
4674 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004675 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004676 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004677 vim_free(fudi.fd_newkey);
4678 }
4679 if (tofree == NULL)
4680 return;
4681
Bram Moolenaare38eab22019-12-05 21:50:01 +01004682 // Increase refcount on dictionary, it could get deleted when evaluating
4683 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 if (fudi.fd_dict != NULL)
4685 ++fudi.fd_dict->dv_refcount;
4686
Bram Moolenaare38eab22019-12-05 21:50:01 +01004687 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4688 // contents. For VAR_PARTIAL get its partial, unless we already have one
4689 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004691 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4692 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693
Bram Moolenaare38eab22019-12-05 21:50:01 +01004694 // Skip white space to allow ":call func ()". Not good, but required for
4695 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004697 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698
4699 if (*startarg != '(')
4700 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004701 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 goto end;
4703 }
4704
4705 /*
4706 * When skipping, evaluate the function once, to find the end of the
4707 * arguments.
4708 * When the function takes a range, this is discovered after the first
4709 * call, and the loop is broken.
4710 */
4711 if (eap->skip)
4712 {
4713 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004714 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715 }
4716 else
4717 lnum = eap->line1;
4718 for ( ; lnum <= eap->line2; ++lnum)
4719 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004720 funcexe_T funcexe;
4721
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004722 if (!eap->skip && eap->addr_count > 0)
4723 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004724 if (lnum > curbuf->b_ml.ml_line_count)
4725 {
4726 // If the function deleted lines or switched to another buffer
4727 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004728 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004729 break;
4730 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 curwin->w_cursor.lnum = lnum;
4732 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004734 }
4735 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004736
Bram Moolenaara80faa82020-04-12 19:37:17 +02004737 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004738 funcexe.firstline = eap->line1;
4739 funcexe.lastline = eap->line2;
4740 funcexe.doesrange = &doesrange;
4741 funcexe.evaluate = !eap->skip;
4742 funcexe.partial = partial;
4743 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004744 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004745 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 {
4747 failed = TRUE;
4748 break;
4749 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004750 if (has_watchexpr())
4751 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004753 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004754 if (handle_subscript(&arg, &rettv,
4755 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 {
4757 failed = TRUE;
4758 break;
4759 }
4760
4761 clear_tv(&rettv);
4762 if (doesrange || eap->skip)
4763 break;
4764
Bram Moolenaare38eab22019-12-05 21:50:01 +01004765 // Stop when immediately aborting on error, or when an interrupt
4766 // occurred or an exception was thrown but not caught.
4767 // get_func_tv() returned OK, so that the check for trailing
4768 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 if (aborting())
4770 break;
4771 }
4772 if (eap->skip)
4773 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004774 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004775
Bram Moolenaare51bb172020-02-16 19:42:23 +01004776 // When inside :try we need to check for following "| catch".
4777 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004779 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004780 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004781 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004783 if (!failed)
4784 {
4785 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004786 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004787 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788 }
4789 else
4790 eap->nextcmd = check_nextcmd(arg);
4791 }
4792
4793end:
4794 dict_unref(fudi.fd_dict);
4795 vim_free(tofree);
4796}
4797
4798/*
4799 * Return from a function. Possibly makes the return pending. Also called
4800 * for a pending return at the ":endtry" or after returning from an extra
4801 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4802 * when called due to a ":return" command. "rettv" may point to a typval_T
4803 * with the return rettv. Returns TRUE when the return can be carried out,
4804 * FALSE when the return gets pending.
4805 */
4806 int
4807do_return(
4808 exarg_T *eap,
4809 int reanimate,
4810 int is_cmd,
4811 void *rettv)
4812{
4813 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004814 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004815
4816 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004817 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818 current_funccal->returned = FALSE;
4819
4820 /*
4821 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4822 * not in its finally clause (which then is to be executed next) is found.
4823 * In this case, make the ":return" pending for execution at the ":endtry".
4824 * Otherwise, return normally.
4825 */
4826 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4827 if (idx >= 0)
4828 {
4829 cstack->cs_pending[idx] = CSTP_RETURN;
4830
4831 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004832 // A pending return again gets pending. "rettv" points to an
4833 // allocated variable with the rettv of the original ":return"'s
4834 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004835 cstack->cs_rettv[idx] = rettv;
4836 else
4837 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004838 // When undoing a return in order to make it pending, get the stored
4839 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004840 if (reanimate)
4841 rettv = current_funccal->rettv;
4842
4843 if (rettv != NULL)
4844 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004845 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004846 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4847 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4848 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004849 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004850 }
4851 else
4852 cstack->cs_rettv[idx] = NULL;
4853
4854 if (reanimate)
4855 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004856 // The pending return value could be overwritten by a ":return"
4857 // without argument in a finally clause; reset the default
4858 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004859 current_funccal->rettv->v_type = VAR_NUMBER;
4860 current_funccal->rettv->vval.v_number = 0;
4861 }
4862 }
4863 report_make_pending(CSTP_RETURN, rettv);
4864 }
4865 else
4866 {
4867 current_funccal->returned = TRUE;
4868
Bram Moolenaare38eab22019-12-05 21:50:01 +01004869 // If the return is carried out now, store the return value. For
4870 // a return immediately after reanimation, the value is already
4871 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004872 if (!reanimate && rettv != NULL)
4873 {
4874 clear_tv(current_funccal->rettv);
4875 *current_funccal->rettv = *(typval_T *)rettv;
4876 if (!is_cmd)
4877 vim_free(rettv);
4878 }
4879 }
4880
4881 return idx < 0;
4882}
4883
4884/*
4885 * Free the variable with a pending return value.
4886 */
4887 void
4888discard_pending_return(void *rettv)
4889{
4890 free_tv((typval_T *)rettv);
4891}
4892
4893/*
4894 * Generate a return command for producing the value of "rettv". The result
4895 * is an allocated string. Used by report_pending() for verbose messages.
4896 */
4897 char_u *
4898get_return_cmd(void *rettv)
4899{
4900 char_u *s = NULL;
4901 char_u *tofree = NULL;
4902 char_u numbuf[NUMBUFLEN];
4903
4904 if (rettv != NULL)
4905 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4906 if (s == NULL)
4907 s = (char_u *)"";
4908
4909 STRCPY(IObuff, ":return ");
4910 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4911 if (STRLEN(s) + 8 >= IOSIZE)
4912 STRCPY(IObuff + IOSIZE - 4, "...");
4913 vim_free(tofree);
4914 return vim_strsave(IObuff);
4915}
4916
4917/*
4918 * Get next function line.
4919 * Called by do_cmdline() to get the next line.
4920 * Returns allocated string, or NULL for end of function.
4921 */
4922 char_u *
4923get_func_line(
4924 int c UNUSED,
4925 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004926 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004927 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004928{
4929 funccall_T *fcp = (funccall_T *)cookie;
4930 ufunc_T *fp = fcp->func;
4931 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004932 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004933
Bram Moolenaare38eab22019-12-05 21:50:01 +01004934 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 if (fcp->dbg_tick != debug_tick)
4936 {
4937 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004938 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939 fcp->dbg_tick = debug_tick;
4940 }
4941#ifdef FEAT_PROFILE
4942 if (do_profiling == PROF_YES)
4943 func_line_end(cookie);
4944#endif
4945
4946 gap = &fp->uf_lines;
4947 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4948 || fcp->returned)
4949 retval = NULL;
4950 else
4951 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004952 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 while (fcp->linenr < gap->ga_len
4954 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4955 ++fcp->linenr;
4956 if (fcp->linenr >= gap->ga_len)
4957 retval = NULL;
4958 else
4959 {
4960 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004961 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962#ifdef FEAT_PROFILE
4963 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004964 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965#endif
4966 }
4967 }
4968
Bram Moolenaare38eab22019-12-05 21:50:01 +01004969 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004970 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004972 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004973 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004975 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004976 fcp->dbg_tick = debug_tick;
4977 }
4978
4979 return retval;
4980}
4981
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982/*
4983 * Return TRUE if the currently active function should be ended, because a
4984 * return was encountered or an error occurred. Used inside a ":while".
4985 */
4986 int
4987func_has_ended(void *cookie)
4988{
4989 funccall_T *fcp = (funccall_T *)cookie;
4990
Bram Moolenaare38eab22019-12-05 21:50:01 +01004991 // Ignore the "abort" flag if the abortion behavior has been changed due to
4992 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4994 || fcp->returned);
4995}
4996
4997/*
4998 * return TRUE if cookie indicates a function which "abort"s on errors.
4999 */
5000 int
5001func_has_abort(
5002 void *cookie)
5003{
5004 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5005}
5006
5007
5008/*
5009 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5010 * Don't do this when "Func" is already a partial that was bound
5011 * explicitly (pt_auto is FALSE).
5012 * Changes "rettv" in-place.
5013 * Returns the updated "selfdict_in".
5014 */
5015 dict_T *
5016make_partial(dict_T *selfdict_in, typval_T *rettv)
5017{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005018 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005019 char_u *tofree = NULL;
5020 ufunc_T *fp;
5021 char_u fname_buf[FLEN_FIXED + 1];
5022 int error;
5023 dict_T *selfdict = selfdict_in;
5024
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005025 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5026 fp = rettv->vval.v_partial->pt_func;
5027 else
5028 {
5029 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5030 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005031 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005032 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005033 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005034 vim_free(tofree);
5035 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005036
5037 if (fp != NULL && (fp->uf_flags & FC_DICT))
5038 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005039 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005040
5041 if (pt != NULL)
5042 {
5043 pt->pt_refcount = 1;
5044 pt->pt_dict = selfdict;
5045 pt->pt_auto = TRUE;
5046 selfdict = NULL;
5047 if (rettv->v_type == VAR_FUNC)
5048 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005049 // Just a function: Take over the function name and use
5050 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005051 pt->pt_name = rettv->vval.v_string;
5052 }
5053 else
5054 {
5055 partial_T *ret_pt = rettv->vval.v_partial;
5056 int i;
5057
Bram Moolenaare38eab22019-12-05 21:50:01 +01005058 // Partial: copy the function name, use selfdict and copy
5059 // args. Can't take over name or args, the partial might
5060 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005061 if (ret_pt->pt_name != NULL)
5062 {
5063 pt->pt_name = vim_strsave(ret_pt->pt_name);
5064 func_ref(pt->pt_name);
5065 }
5066 else
5067 {
5068 pt->pt_func = ret_pt->pt_func;
5069 func_ptr_ref(pt->pt_func);
5070 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005071 if (ret_pt->pt_argc > 0)
5072 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005073 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005075 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005076 pt->pt_argc = 0;
5077 else
5078 {
5079 pt->pt_argc = ret_pt->pt_argc;
5080 for (i = 0; i < pt->pt_argc; i++)
5081 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5082 }
5083 }
5084 partial_unref(ret_pt);
5085 }
5086 rettv->v_type = VAR_PARTIAL;
5087 rettv->vval.v_partial = pt;
5088 }
5089 }
5090 return selfdict;
5091}
5092
5093/*
5094 * Return the name of the executed function.
5095 */
5096 char_u *
5097func_name(void *cookie)
5098{
5099 return ((funccall_T *)cookie)->func->uf_name;
5100}
5101
5102/*
5103 * Return the address holding the next breakpoint line for a funccall cookie.
5104 */
5105 linenr_T *
5106func_breakpoint(void *cookie)
5107{
5108 return &((funccall_T *)cookie)->breakpoint;
5109}
5110
5111/*
5112 * Return the address holding the debug tick for a funccall cookie.
5113 */
5114 int *
5115func_dbg_tick(void *cookie)
5116{
5117 return &((funccall_T *)cookie)->dbg_tick;
5118}
5119
5120/*
5121 * Return the nesting level for a funccall cookie.
5122 */
5123 int
5124func_level(void *cookie)
5125{
5126 return ((funccall_T *)cookie)->level;
5127}
5128
5129/*
5130 * Return TRUE when a function was ended by a ":return" command.
5131 */
5132 int
5133current_func_returned(void)
5134{
5135 return current_funccal->returned;
5136}
5137
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005138 int
5139free_unref_funccal(int copyID, int testing)
5140{
5141 int did_free = FALSE;
5142 int did_free_funccal = FALSE;
5143 funccall_T *fc, **pfc;
5144
5145 for (pfc = &previous_funccal; *pfc != NULL; )
5146 {
5147 if (can_free_funccal(*pfc, copyID))
5148 {
5149 fc = *pfc;
5150 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005151 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 did_free = TRUE;
5153 did_free_funccal = TRUE;
5154 }
5155 else
5156 pfc = &(*pfc)->caller;
5157 }
5158 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005159 // When a funccal was freed some more items might be garbage
5160 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005161 (void)garbage_collect(testing);
5162
5163 return did_free;
5164}
5165
5166/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005167 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005168 */
5169 static funccall_T *
5170get_funccal(void)
5171{
5172 int i;
5173 funccall_T *funccal;
5174 funccall_T *temp_funccal;
5175
5176 funccal = current_funccal;
5177 if (debug_backtrace_level > 0)
5178 {
5179 for (i = 0; i < debug_backtrace_level; i++)
5180 {
5181 temp_funccal = funccal->caller;
5182 if (temp_funccal)
5183 funccal = temp_funccal;
5184 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005185 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005186 debug_backtrace_level = i;
5187 }
5188 }
5189 return funccal;
5190}
5191
5192/*
5193 * Return the hashtable used for local variables in the current funccal.
5194 * Return NULL if there is no current funccal.
5195 */
5196 hashtab_T *
5197get_funccal_local_ht()
5198{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005199 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200 return NULL;
5201 return &get_funccal()->l_vars.dv_hashtab;
5202}
5203
5204/*
5205 * Return the l: scope variable.
5206 * Return NULL if there is no current funccal.
5207 */
5208 dictitem_T *
5209get_funccal_local_var()
5210{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005211 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 return NULL;
5213 return &get_funccal()->l_vars_var;
5214}
5215
5216/*
5217 * Return the hashtable used for argument in the current funccal.
5218 * Return NULL if there is no current funccal.
5219 */
5220 hashtab_T *
5221get_funccal_args_ht()
5222{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005223 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224 return NULL;
5225 return &get_funccal()->l_avars.dv_hashtab;
5226}
5227
5228/*
5229 * Return the a: scope variable.
5230 * Return NULL if there is no current funccal.
5231 */
5232 dictitem_T *
5233get_funccal_args_var()
5234{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005235 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005237 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005238}
5239
5240/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241 * List function variables, if there is a function.
5242 */
5243 void
5244list_func_vars(int *first)
5245{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005246 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005248 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249}
5250
5251/*
5252 * If "ht" is the hashtable for local variables in the current funccal, return
5253 * the dict that contains it.
5254 * Otherwise return NULL.
5255 */
5256 dict_T *
5257get_current_funccal_dict(hashtab_T *ht)
5258{
5259 if (current_funccal != NULL
5260 && ht == &current_funccal->l_vars.dv_hashtab)
5261 return &current_funccal->l_vars;
5262 return NULL;
5263}
5264
5265/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005266 * Search hashitem in parent scope.
5267 */
5268 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005269find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005270{
5271 funccall_T *old_current_funccal = current_funccal;
5272 hashtab_T *ht;
5273 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005274 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005275
5276 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5277 return NULL;
5278
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005279 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005280 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005281 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005282 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005283 ht = find_var_ht(name, &varname);
5284 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005285 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005286 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005287 if (!HASHITEM_EMPTY(hi))
5288 {
5289 *pht = ht;
5290 break;
5291 }
5292 }
5293 if (current_funccal == current_funccal->func->uf_scoped)
5294 break;
5295 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005296 }
5297 current_funccal = old_current_funccal;
5298
5299 return hi;
5300}
5301
5302/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005303 * Search variable in parent scope.
5304 */
5305 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005306find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005307{
5308 dictitem_T *v = NULL;
5309 funccall_T *old_current_funccal = current_funccal;
5310 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005311 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005312
5313 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5314 return NULL;
5315
Bram Moolenaare38eab22019-12-05 21:50:01 +01005316 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005317 current_funccal = current_funccal->func->uf_scoped;
5318 while (current_funccal)
5319 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005320 ht = find_var_ht(name, &varname);
5321 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005322 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005323 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005324 if (v != NULL)
5325 break;
5326 }
5327 if (current_funccal == current_funccal->func->uf_scoped)
5328 break;
5329 current_funccal = current_funccal->func->uf_scoped;
5330 }
5331 current_funccal = old_current_funccal;
5332
5333 return v;
5334}
5335
5336/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337 * Set "copyID + 1" in previous_funccal and callers.
5338 */
5339 int
5340set_ref_in_previous_funccal(int copyID)
5341{
5342 int abort = FALSE;
5343 funccall_T *fc;
5344
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005345 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005346 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005347 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005348 abort = abort
5349 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5350 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005351 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005352 }
5353 return abort;
5354}
5355
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005356 static int
5357set_ref_in_funccal(funccall_T *fc, int copyID)
5358{
5359 int abort = FALSE;
5360
5361 if (fc->fc_copyID != copyID)
5362 {
5363 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005364 abort = abort
5365 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5366 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005367 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005368 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005369 }
5370 return abort;
5371}
5372
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005373/*
5374 * Set "copyID" in all local vars and arguments in the call stack.
5375 */
5376 int
5377set_ref_in_call_stack(int copyID)
5378{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005379 int abort = FALSE;
5380 funccall_T *fc;
5381 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005383 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005384 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005385
5386 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005387 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5388 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005389 abort = abort || set_ref_in_funccal(fc, copyID);
5390
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005391 return abort;
5392}
5393
5394/*
5395 * Set "copyID" in all functions available by name.
5396 */
5397 int
5398set_ref_in_functions(int copyID)
5399{
5400 int todo;
5401 hashitem_T *hi = NULL;
5402 int abort = FALSE;
5403 ufunc_T *fp;
5404
5405 todo = (int)func_hashtab.ht_used;
5406 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005407 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005408 if (!HASHITEM_EMPTY(hi))
5409 {
5410 --todo;
5411 fp = HI2UF(hi);
5412 if (!func_name_refcount(fp->uf_name))
5413 abort = abort || set_ref_in_func(NULL, fp, copyID);
5414 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005415 }
5416 return abort;
5417}
5418
5419/*
5420 * Set "copyID" in all function arguments.
5421 */
5422 int
5423set_ref_in_func_args(int copyID)
5424{
5425 int i;
5426 int abort = FALSE;
5427
5428 for (i = 0; i < funcargs.ga_len; ++i)
5429 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5430 copyID, NULL, NULL);
5431 return abort;
5432}
5433
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005434/*
5435 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005436 * Returns TRUE if setting references failed somehow.
5437 */
5438 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005439set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005440{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005441 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005442 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005443 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005444 char_u fname_buf[FLEN_FIXED + 1];
5445 char_u *tofree = NULL;
5446 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005447 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005448
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005449 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005450 return FALSE;
5451
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005452 if (fp_in == NULL)
5453 {
5454 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005455 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005456 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005457 if (fp != NULL)
5458 {
5459 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005460 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005461 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005462
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005463 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005464 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005465}
5466
Bram Moolenaare38eab22019-12-05 21:50:01 +01005467#endif // FEAT_EVAL