blob: 99d4e0334edff578d6587f43ed8acfcca674ed12 [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 Moolenaarb47bed22021-04-14 17:06:43 +02002191 typval_T *tv_to_free[MAX_FUNC_ARGS];
2192 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002193#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002194 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002196 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002197
Bram Moolenaarb2049902021-01-24 12:53:53 +01002198#ifdef FEAT_PROFILE
2199 CLEAR_FIELD(profile_info);
2200#endif
2201
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002202 // If depth of calling is getting too high, don't execute the function.
2203 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002204 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002205 rettv->v_type = VAR_NUMBER;
2206 rettv->vval.v_number = -1;
2207 return;
2208 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002209
Bram Moolenaare38eab22019-12-05 21:50:01 +01002210 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002211
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002212 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002213 if (fc == NULL)
2214 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002215 fc->caller = current_funccal;
2216 current_funccal = fc;
2217 fc->func = fp;
2218 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002220 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002221 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2222 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002223 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002224 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002225 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002227 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002228 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002229#ifdef FEAT_PROFILE
2230 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2231#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002232 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002233#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002234 if (do_profiling == PROF_YES)
2235 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002236#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002237 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002238 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002239#ifdef FEAT_PROFILE
2240 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002241 || (caller != NULL && caller->uf_profiling)))
2242 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002243#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002244 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002245 free_funccal(fc);
2246 return;
2247 }
2248
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002249 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2250 islambda = TRUE;
2251
2252 /*
2253 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2254 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2255 * each argument variable and saves a lot of time.
2256 */
2257 /*
2258 * Init l: variables.
2259 */
2260 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2261 if (selfdict != NULL)
2262 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002263 // Set l:self to "selfdict". Use "name" to avoid a warning from
2264 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265 v = &fc->fixvar[fixvar_idx++].var;
2266 name = v->di_key;
2267 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002268 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2270 v->di_tv.v_type = VAR_DICT;
2271 v->di_tv.v_lock = 0;
2272 v->di_tv.vval.v_dict = selfdict;
2273 ++selfdict->dv_refcount;
2274 }
2275
2276 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002277 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002278 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002279 * Set a:000 to a list with room for the "..." arguments.
2280 */
2281 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002282 if ((fp->uf_flags & FC_NOARGS) == 0)
2283 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002284 (varnumber_T)(argcount >= fp->uf_args.ga_len
2285 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002286 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002287 if ((fp->uf_flags & FC_NOARGS) == 0)
2288 {
2289 // Use "name" to avoid a warning from some compiler that checks the
2290 // destination size.
2291 v = &fc->fixvar[fixvar_idx++].var;
2292 name = v->di_key;
2293 STRCPY(name, "000");
2294 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2295 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2296 v->di_tv.v_type = VAR_LIST;
2297 v->di_tv.v_lock = VAR_FIXED;
2298 v->di_tv.vval.v_list = &fc->l_varlist;
2299 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002300 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2302 fc->l_varlist.lv_lock = VAR_FIXED;
2303
2304 /*
2305 * Set a:firstline to "firstline" and a:lastline to "lastline".
2306 * Set a:name to named arguments.
2307 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002308 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002309 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002310 if ((fp->uf_flags & FC_NOARGS) == 0)
2311 {
2312 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002313 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002314 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002315 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002316 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002317 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002318 {
2319 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002320 typval_T def_rettv;
2321 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002322
2323 ai = i - fp->uf_args.ga_len;
2324 if (ai < 0)
2325 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002326 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 name = FUNCARG(fp, i);
2328 if (islambda)
2329 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002330
2331 // evaluate named argument default expression
2332 isdefault = ai + fp->uf_def_args.ga_len >= 0
2333 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2334 && argvars[i].vval.v_number == VVAL_NONE));
2335 if (isdefault)
2336 {
2337 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002338
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002339 def_rettv.v_type = VAR_NUMBER;
2340 def_rettv.vval.v_number = -1;
2341
2342 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2343 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002344 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002345 {
2346 default_arg_err = 1;
2347 break;
2348 }
2349 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350 }
2351 else
2352 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002353 if ((fp->uf_flags & FC_NOARGS) != 0)
2354 // Bail out if no a: arguments used (in lambda).
2355 break;
2356
Bram Moolenaare38eab22019-12-05 21:50:01 +01002357 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358 sprintf((char *)numbuf, "%d", ai + 1);
2359 name = numbuf;
2360 }
2361 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2362 {
2363 v = &fc->fixvar[fixvar_idx++].var;
2364 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002365 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002366 }
2367 else
2368 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002369 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002370 if (v == NULL)
2371 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002372 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002373 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002374
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002375 // Note: the values are copied directly to avoid alloc/free.
2376 // "argvars" must have VAR_FIXED for v_lock.
2377 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002378 v->di_tv.v_lock = VAR_FIXED;
2379
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002380 if (isdefault)
2381 // Need to free this later, no matter where it's stored.
2382 tv_to_free[tv_to_free_len++] = &v->di_tv;
2383
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384 if (addlocal)
2385 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002386 // Named arguments should be accessed without the "a:" prefix in
2387 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002388 copy_tv(&v->di_tv, &v->di_tv);
2389 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002391 else
2392 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393
2394 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2395 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002396 listitem_T *li = &fc->l_listitems[ai];
2397
2398 li->li_tv = argvars[i];
2399 li->li_tv.v_lock = VAR_FIXED;
2400 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401 }
2402 }
2403
Bram Moolenaare38eab22019-12-05 21:50:01 +01002404 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002405 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002406
2407 if (fp->uf_flags & FC_SANDBOX)
2408 {
2409 using_sandbox = TRUE;
2410 ++sandbox;
2411 }
2412
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002413 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002414 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002415 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002417 ++no_wait_return;
2418 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002419
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002420 smsg(_("calling %s"), SOURCING_NAME);
2421 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002423 char_u buf[MSG_BUF_LEN];
2424 char_u numbuf2[NUMBUFLEN];
2425 char_u *tofree;
2426 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002427
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002428 msg_puts("(");
2429 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002431 if (i > 0)
2432 msg_puts(", ");
2433 if (argvars[i].v_type == VAR_NUMBER)
2434 msg_outnum((long)argvars[i].vval.v_number);
2435 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002436 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002437 // Do not want errors such as E724 here.
2438 ++emsg_off;
2439 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2440 --emsg_off;
2441 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002443 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002445 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2446 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002448 msg_puts((char *)s);
2449 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450 }
2451 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002453 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002455 msg_puts("\n"); // don't overwrite this either
2456
2457 verbose_leave_scroll();
2458 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002459 }
2460#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002461 if (do_profiling == PROF_YES)
2462 profile_may_start_func(&profile_info, fp,
2463 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464#endif
2465
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002466 save_current_sctx = current_sctx;
2467 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468 save_did_emsg = did_emsg;
2469 did_emsg = FALSE;
2470
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002471 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2472 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002473 else if (islambda)
2474 {
2475 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2476
2477 // A Lambda always has the command "return {expr}". It is much faster
2478 // to evaluate {expr} directly.
2479 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002480 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002481 --ex_nesting_level;
2482 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002483 else
2484 // call do_cmdline() to execute the lines
2485 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2487
2488 --RedrawingDisabled;
2489
Bram Moolenaare38eab22019-12-05 21:50:01 +01002490 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2492 {
2493 clear_tv(rettv);
2494 rettv->v_type = VAR_NUMBER;
2495 rettv->vval.v_number = -1;
2496 }
2497
2498#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002499 if (do_profiling == PROF_YES)
2500 {
2501 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2502
2503 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2504 profile_may_end_func(&profile_info, fp, caller);
2505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506#endif
2507
Bram Moolenaare38eab22019-12-05 21:50:01 +01002508 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 if (p_verbose >= 12)
2510 {
2511 ++no_wait_return;
2512 verbose_enter_scroll();
2513
2514 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002515 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002517 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 (long)fc->rettv->vval.v_number);
2519 else
2520 {
2521 char_u buf[MSG_BUF_LEN];
2522 char_u numbuf2[NUMBUFLEN];
2523 char_u *tofree;
2524 char_u *s;
2525
Bram Moolenaare38eab22019-12-05 21:50:01 +01002526 // The value may be very long. Skip the middle part, so that we
2527 // have some idea how it starts and ends. smsg() would always
2528 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 ++emsg_off;
2530 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2531 --emsg_off;
2532 if (s != NULL)
2533 {
2534 if (vim_strsize(s) > MSG_BUF_CLEN)
2535 {
2536 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2537 s = buf;
2538 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002539 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540 vim_free(tofree);
2541 }
2542 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002543 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544
2545 verbose_leave_scroll();
2546 --no_wait_return;
2547 }
2548
Bram Moolenaare31ee862020-01-07 20:59:34 +01002549 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002550 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002551 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552#ifdef FEAT_PROFILE
2553 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002554 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002556 if (using_sandbox)
2557 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002559 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002560 {
2561 ++no_wait_return;
2562 verbose_enter_scroll();
2563
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002564 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002565 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566
2567 verbose_leave_scroll();
2568 --no_wait_return;
2569 }
2570
2571 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002572 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002573 for (i = 0; i < tv_to_free_len; ++i)
2574 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002575 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576}
2577
2578/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002579 * Check the argument count for user function "fp".
2580 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2581 */
2582 int
2583check_user_func_argcount(ufunc_T *fp, int argcount)
2584{
2585 int regular_args = fp->uf_args.ga_len;
2586
2587 if (argcount < regular_args - fp->uf_def_args.ga_len)
2588 return FCERR_TOOFEW;
2589 else if (!has_varargs(fp) && argcount > regular_args)
2590 return FCERR_TOOMANY;
2591 return FCERR_UNKNOWN;
2592}
2593
2594/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002596 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002597 int
2598call_user_func_check(
2599 ufunc_T *fp,
2600 int argcount,
2601 typval_T *argvars,
2602 typval_T *rettv,
2603 funcexe_T *funcexe,
2604 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002605{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002606 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002607
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002608 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2609 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002610 error = check_user_func_argcount(fp, argcount);
2611 if (error != FCERR_UNKNOWN)
2612 return error;
2613 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002614 error = FCERR_DICT;
2615 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002616 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002617 int did_save_redo = FALSE;
2618 save_redo_T save_redo;
2619
2620 /*
2621 * Call the user function.
2622 * Save and restore search patterns, script variables and
2623 * redo buffer.
2624 */
2625 save_search_patterns();
2626 if (!ins_compl_active())
2627 {
2628 saveRedobuff(&save_redo);
2629 did_save_redo = TRUE;
2630 }
2631 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002632 call_user_func(fp, argcount, argvars, rettv, funcexe,
2633 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002634 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2635 // Function was unreferenced while being used, free it now.
2636 func_clear_free(fp, FALSE);
2637 if (did_save_redo)
2638 restoreRedobuff(&save_redo);
2639 restore_search_patterns();
2640 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002641 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002642 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002643}
2644
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002645static funccal_entry_T *funccal_stack = NULL;
2646
2647/*
2648 * Save the current function call pointer, and set it to NULL.
2649 * Used when executing autocommands and for ":source".
2650 */
2651 void
2652save_funccal(funccal_entry_T *entry)
2653{
2654 entry->top_funccal = current_funccal;
2655 entry->next = funccal_stack;
2656 funccal_stack = entry;
2657 current_funccal = NULL;
2658}
2659
2660 void
2661restore_funccal(void)
2662{
2663 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002664 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002665 else
2666 {
2667 current_funccal = funccal_stack->top_funccal;
2668 funccal_stack = funccal_stack->next;
2669 }
2670}
2671
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002672 funccall_T *
2673get_current_funccal(void)
2674{
2675 return current_funccal;
2676}
2677
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002678/*
2679 * Mark all functions of script "sid" as deleted.
2680 */
2681 void
2682delete_script_functions(int sid)
2683{
2684 hashitem_T *hi;
2685 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002686 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002687 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002688 size_t len;
2689
2690 buf[0] = K_SPECIAL;
2691 buf[1] = KS_EXTRA;
2692 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002693 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002694 len = STRLEN(buf);
2695
Bram Moolenaarce658352020-07-31 23:47:12 +02002696 while (todo > 0)
2697 {
2698 todo = func_hashtab.ht_used;
2699 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2700 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002701 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002702 fp = HI2UF(hi);
2703 if (STRNCMP(fp->uf_name, buf, len) == 0)
2704 {
2705 int changed = func_hashtab.ht_changed;
2706
2707 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002708
2709 if (fp->uf_calls > 0)
2710 {
2711 // Function is executing, don't free it but do remove
2712 // it from the hashtable.
2713 if (func_remove(fp))
2714 fp->uf_refcount--;
2715 }
2716 else
2717 {
2718 func_clear(fp, TRUE);
2719 // When clearing a function another function can be
2720 // cleared as a side effect. When that happens start
2721 // over.
2722 if (changed != func_hashtab.ht_changed)
2723 break;
2724 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002725 }
2726 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002727 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002728 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002729}
2730
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731#if defined(EXITFREE) || defined(PROTO)
2732 void
2733free_all_functions(void)
2734{
2735 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002736 ufunc_T *fp;
2737 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002738 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002739 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002740
Bram Moolenaare38eab22019-12-05 21:50:01 +01002741 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002742 while (current_funccal != NULL)
2743 {
2744 clear_tv(current_funccal->rettv);
2745 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002746 if (current_funccal == NULL && funccal_stack != NULL)
2747 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002748 }
2749
Bram Moolenaare38eab22019-12-05 21:50:01 +01002750 // First clear what the functions contain. Since this may lower the
2751 // reference count of a function, it may also free a function and change
2752 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002753 while (todo > 0)
2754 {
2755 todo = func_hashtab.ht_used;
2756 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2757 if (!HASHITEM_EMPTY(hi))
2758 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002759 // clear the def function index now
2760 fp = HI2UF(hi);
2761 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002762 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002763
Bram Moolenaare38eab22019-12-05 21:50:01 +01002764 // Only free functions that are not refcounted, those are
2765 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002766 if (func_name_refcount(fp->uf_name))
2767 ++skipped;
2768 else
2769 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002770 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002771 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002772 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002773 {
2774 skipped = 0;
2775 break;
2776 }
2777 }
2778 --todo;
2779 }
2780 }
2781
Bram Moolenaare38eab22019-12-05 21:50:01 +01002782 // Now actually free the functions. Need to start all over every time,
2783 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002784 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002785 while (func_hashtab.ht_used > skipped)
2786 {
2787 todo = func_hashtab.ht_used;
2788 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789 if (!HASHITEM_EMPTY(hi))
2790 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002791 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002792 // Only free functions that are not refcounted, those are
2793 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002794 fp = HI2UF(hi);
2795 if (func_name_refcount(fp->uf_name))
2796 ++skipped;
2797 else
2798 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002799 if (func_free(fp, FALSE) == OK)
2800 {
2801 skipped = 0;
2802 break;
2803 }
2804 // did not actually free it
2805 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002806 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002808 }
2809 if (skipped == 0)
2810 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002811
2812 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813}
2814#endif
2815
2816/*
2817 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002818 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 * "len" is the length of "name", or -1 for NUL terminated.
2820 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002821 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822builtin_function(char_u *name, int len)
2823{
2824 char_u *p;
2825
Bram Moolenaara26b9702020-04-18 19:53:28 +02002826 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 return FALSE;
2828 p = vim_strchr(name, AUTOLOAD_CHAR);
2829 return p == NULL || (len > 0 && p > name + len);
2830}
2831
2832 int
2833func_call(
2834 char_u *name,
2835 typval_T *args,
2836 partial_T *partial,
2837 dict_T *selfdict,
2838 typval_T *rettv)
2839{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002840 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841 listitem_T *item;
2842 typval_T argv[MAX_FUNC_ARGS + 1];
2843 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 int r = 0;
2845
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002846 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002847 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 {
2849 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2850 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002851 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 break;
2853 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002854 // Make a copy of each argument. This is needed to be able to set
2855 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856 copy_tv(&item->li_tv, &argv[argc++]);
2857 }
2858
2859 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002860 {
2861 funcexe_T funcexe;
2862
Bram Moolenaara80faa82020-04-12 19:37:17 +02002863 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002864 funcexe.firstline = curwin->w_cursor.lnum;
2865 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002866 funcexe.evaluate = TRUE;
2867 funcexe.partial = partial;
2868 funcexe.selfdict = selfdict;
2869 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2870 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871
Bram Moolenaare38eab22019-12-05 21:50:01 +01002872 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 while (argc > 0)
2874 clear_tv(&argv[--argc]);
2875
2876 return r;
2877}
2878
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002879static int callback_depth = 0;
2880
2881 int
2882get_callback_depth(void)
2883{
2884 return callback_depth;
2885}
2886
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002888 * Invoke call_func() with a callback.
2889 */
2890 int
2891call_callback(
2892 callback_T *callback,
2893 int len, // length of "name" or -1 to use strlen()
2894 typval_T *rettv, // return value goes here
2895 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002896 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002897 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002898{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002899 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002900 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002901
Bram Moolenaara80faa82020-04-12 19:37:17 +02002902 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002903 funcexe.evaluate = TRUE;
2904 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002905 ++callback_depth;
2906 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2907 --callback_depth;
2908 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002909}
2910
2911/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002912 * Give an error message for the result of a function.
2913 * Nothing if "error" is FCERR_NONE.
2914 */
2915 void
2916user_func_error(int error, char_u *name)
2917{
2918 switch (error)
2919 {
2920 case FCERR_UNKNOWN:
2921 emsg_funcname(e_unknownfunc, name);
2922 break;
2923 case FCERR_NOTMETHOD:
2924 emsg_funcname(
2925 N_("E276: Cannot use function as a method: %s"), name);
2926 break;
2927 case FCERR_DELETED:
2928 emsg_funcname(N_(e_func_deleted), name);
2929 break;
2930 case FCERR_TOOMANY:
2931 emsg_funcname((char *)e_toomanyarg, name);
2932 break;
2933 case FCERR_TOOFEW:
2934 emsg_funcname((char *)e_toofewarg, name);
2935 break;
2936 case FCERR_SCRIPT:
2937 emsg_funcname(
2938 N_("E120: Using <SID> not in a script context: %s"), name);
2939 break;
2940 case FCERR_DICT:
2941 emsg_funcname(
2942 N_("E725: Calling dict function without Dictionary: %s"),
2943 name);
2944 break;
2945 }
2946}
2947
2948/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002950 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951 * Return FAIL when the function can't be called, OK otherwise.
2952 * Also returns OK when an error was encountered while executing the function.
2953 */
2954 int
2955call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002956 char_u *funcname, // name of the function
2957 int len, // length of "name" or -1 to use strlen()
2958 typval_T *rettv, // return value goes here
2959 int argcount_in, // number of "argvars"
2960 typval_T *argvars_in, // vars for arguments, must have "argcount"
2961 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002962 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002963{
2964 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002965 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002967 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 char_u fname_buf[FLEN_FIXED + 1];
2969 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002970 char_u *fname = NULL;
2971 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972 int argcount = argcount_in;
2973 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002974 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002975 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2976 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002977 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002978 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002979 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002981 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2982 // even when call_func() returns FAIL.
2983 rettv->v_type = VAR_UNKNOWN;
2984
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002985 if (partial != NULL)
2986 fp = partial->pt_func;
2987 if (fp == NULL)
2988 {
2989 // Make a copy of the name, if it comes from a funcref variable it
2990 // could be changed or deleted in the called function.
2991 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2992 if (name == NULL)
2993 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002995 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2996 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002997
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002998 if (funcexe->doesrange != NULL)
2999 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000
3001 if (partial != NULL)
3002 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003003 // When the function has a partial with a dict and there is a dict
3004 // argument, use the dict argument. That is backwards compatible.
3005 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003006 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003008 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009 {
3010 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003011 {
3012 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3013 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003014 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003015 goto theend;
3016 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003018 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019 for (i = 0; i < argcount_in; ++i)
3020 argv[i + argv_clear] = argvars_in[i];
3021 argvars = argv;
3022 argcount = partial->pt_argc + argcount_in;
3023 }
3024 }
3025
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003026 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3027 {
3028 // Check that the argument types are OK for the types of the funcref.
3029 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003030 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003031 error = FCERR_OTHER;
3032 }
3033
Bram Moolenaaref140542019-12-31 21:27:13 +01003034 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 {
3036 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003037 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038
Bram Moolenaar333894b2020-08-01 18:53:07 +02003039 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003040 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003041 {
3042 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003044 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003045
Bram Moolenaare38eab22019-12-05 21:50:01 +01003046 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003048 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003050 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 {
3052 /*
3053 * User defined function.
3054 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003055 if (fp == NULL)
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 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059 if (fp == NULL
3060 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003061 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 && !aborting())
3063 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003064 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003065 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003067 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3069 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003070 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003071 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003072 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003073 if (fp == NULL)
3074 {
3075 char_u *p = untrans_function_name(rfname);
3076
3077 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003078 // Don't do this if the name starts with "s:".
3079 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003080 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003081 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003083 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003084 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003085#ifdef FEAT_LUA
3086 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3087 {
3088 cfunc_T cb = fp->uf_cb;
3089
3090 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3091 }
3092#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003093 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003094 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003095 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003096 // postponed filling in the arguments, do it now
3097 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003098 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003099
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003100 if (funcexe->basetv != NULL)
3101 {
3102 // Method call: base->Method()
3103 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3104 argv[0] = *funcexe->basetv;
3105 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003106 argvars = argv;
3107 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003108 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003109
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003110 error = call_user_func_check(fp, argcount, argvars, rettv,
3111 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 }
3113 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003114 else if (funcexe->basetv != NULL)
3115 {
3116 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003117 * expr->method(): Find the method name in the table, call its
3118 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003119 */
3120 error = call_internal_method(fname, argcount, argvars, rettv,
3121 funcexe->basetv);
3122 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 else
3124 {
3125 /*
3126 * Find the function name in the table, call its implementation.
3127 */
3128 error = call_internal_func(fname, argcount, argvars, rettv);
3129 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003130
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 /*
3132 * The function call (or "FuncUndefined" autocommand sequence) might
3133 * have been aborted by an error, an interrupt, or an explicitly thrown
3134 * exception that has not been caught so far. This situation can be
3135 * tested for by calling aborting(). For an error in an internal
3136 * function or for the "E132" error in call_user_func(), however, the
3137 * throw point at which the "force_abort" flag (temporarily reset by
3138 * emsg()) is normally updated has not been reached yet. We need to
3139 * update that flag first to make aborting() reliable.
3140 */
3141 update_force_abort();
3142 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003143 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 ret = OK;
3145
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003146theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147 /*
3148 * Report an error unless the argument evaluation or function call has been
3149 * cancelled due to an aborting error, an interrupt, or an exception.
3150 */
3151 if (!aborting())
3152 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003153 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003154 }
3155
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003156 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003158 clear_tv(&argv[--argv_clear + argv_base]);
3159
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 vim_free(tofree);
3161 vim_free(name);
3162
3163 return ret;
3164}
3165
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003166 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003167printable_func_name(ufunc_T *fp)
3168{
3169 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3170}
3171
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003172/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003173 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174 */
3175 static void
3176list_func_head(ufunc_T *fp, int indent)
3177{
3178 int j;
3179
3180 msg_start();
3181 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003182 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003183 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003184 msg_puts("def ");
3185 else
3186 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003187 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003188 msg_putchar('(');
3189 for (j = 0; j < fp->uf_args.ga_len; ++j)
3190 {
3191 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003192 msg_puts(", ");
3193 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003194 if (fp->uf_arg_types != NULL)
3195 {
3196 char *tofree;
3197
3198 msg_puts(": ");
3199 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3200 vim_free(tofree);
3201 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003202 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3203 {
3204 msg_puts(" = ");
3205 msg_puts(((char **)(fp->uf_def_args.ga_data))
3206 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3207 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003208 }
3209 if (fp->uf_varargs)
3210 {
3211 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003212 msg_puts(", ");
3213 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003215 if (fp->uf_va_name != NULL)
3216 {
3217 if (j)
3218 msg_puts(", ");
3219 msg_puts("...");
3220 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003221 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003222 {
3223 char *tofree;
3224
3225 msg_puts(": ");
3226 msg_puts(type_name(fp->uf_va_type, &tofree));
3227 vim_free(tofree);
3228 }
3229 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003231
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003232 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003233 {
3234 if (fp->uf_ret_type != &t_void)
3235 {
3236 char *tofree;
3237
3238 msg_puts(": ");
3239 msg_puts(type_name(fp->uf_ret_type, &tofree));
3240 vim_free(tofree);
3241 }
3242 }
3243 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003244 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003246 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003248 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003249 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003250 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003251 msg_clr_eos();
3252 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003253 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254}
3255
3256/*
3257 * Get a function name, translating "<SID>" and "<SNR>".
3258 * Also handles a Funcref in a List or Dictionary.
3259 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003260 * Set "*is_global" to TRUE when the function must be global, unless
3261 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003262 * flags:
3263 * TFN_INT: internal function name OK
3264 * TFN_QUIET: be quiet
3265 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003266 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 * Advances "pp" to just after the function name (if no error).
3268 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003269 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270trans_function_name(
3271 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003272 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003273 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003275 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003276 partial_T **partial, // return: partial of a FuncRef
3277 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278{
3279 char_u *name = NULL;
3280 char_u *start;
3281 char_u *end;
3282 int lead;
3283 char_u sid_buf[20];
3284 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003287 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003288 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289
3290 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003291 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 start = *pp;
3293
Bram Moolenaare38eab22019-12-05 21:50:01 +01003294 // Check for hard coded <SNR>: already translated function ID (from a user
3295 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3297 && (*pp)[2] == (int)KE_SNR)
3298 {
3299 *pp += 3;
3300 len = get_id_len(pp) + 3;
3301 return vim_strnsave(start, len);
3302 }
3303
Bram Moolenaare38eab22019-12-05 21:50:01 +01003304 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3305 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 lead = eval_fname_script(start);
3307 if (lead > 2)
3308 start += lead;
3309
Bram Moolenaare38eab22019-12-05 21:50:01 +01003310 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003311 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003312 lead > 2 ? 0 : FNE_CHECK_START);
3313 if (end == start)
3314 {
3315 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003316 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317 goto theend;
3318 }
3319 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3320 {
3321 /*
3322 * Report an invalid expression in braces, unless the expression
3323 * evaluation has been cancelled due to an aborting error, an
3324 * interrupt, or an exception.
3325 */
3326 if (!aborting())
3327 {
3328 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003329 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 }
3331 else
3332 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3333 goto theend;
3334 }
3335
3336 if (lv.ll_tv != NULL)
3337 {
3338 if (fdp != NULL)
3339 {
3340 fdp->fd_dict = lv.ll_dict;
3341 fdp->fd_newkey = lv.ll_newkey;
3342 lv.ll_newkey = NULL;
3343 fdp->fd_di = lv.ll_di;
3344 }
3345 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3346 {
3347 name = vim_strsave(lv.ll_tv->vval.v_string);
3348 *pp = end;
3349 }
3350 else if (lv.ll_tv->v_type == VAR_PARTIAL
3351 && lv.ll_tv->vval.v_partial != NULL)
3352 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003353 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 *pp = end;
3355 if (partial != NULL)
3356 *partial = lv.ll_tv->vval.v_partial;
3357 }
3358 else
3359 {
3360 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3361 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003362 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363 else
3364 *pp = end;
3365 name = NULL;
3366 }
3367 goto theend;
3368 }
3369
3370 if (lv.ll_name == NULL)
3371 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003372 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 *pp = end;
3374 goto theend;
3375 }
3376
Bram Moolenaare38eab22019-12-05 21:50:01 +01003377 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 if (lv.ll_exp_name != NULL)
3379 {
3380 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003381 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 flags & TFN_NO_AUTOLOAD);
3383 if (name == lv.ll_exp_name)
3384 name = NULL;
3385 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003386 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 {
3388 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003389 name = deref_func_name(*pp, &len, partial, type,
3390 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391 if (name == *pp)
3392 name = NULL;
3393 }
3394 if (name != NULL)
3395 {
3396 name = vim_strsave(name);
3397 *pp = end;
3398 if (STRNCMP(name, "<SNR>", 5) == 0)
3399 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003400 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 name[0] = K_SPECIAL;
3402 name[1] = KS_EXTRA;
3403 name[2] = (int)KE_SNR;
3404 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3405 }
3406 goto theend;
3407 }
3408
3409 if (lv.ll_exp_name != NULL)
3410 {
3411 len = (int)STRLEN(lv.ll_exp_name);
3412 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3413 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3414 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003415 // When there was "s:" already or the name expanded to get a
3416 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 lv.ll_name += 2;
3418 len -= 2;
3419 lead = 2;
3420 }
3421 }
3422 else
3423 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003424 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003426 {
3427 if (is_global != NULL && lv.ll_name[0] == 'g')
3428 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003430 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431 len = (int)(end - lv.ll_name);
3432 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003433 if (len <= 0)
3434 {
3435 if (!skip)
3436 emsg(_(e_function_name));
3437 goto theend;
3438 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003440 // In Vim9 script a user function is script-local by default, unless it
3441 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003442 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003443 if (vim9script)
3444 {
3445 char_u *p;
3446
3447 // SomeScript#func() is a global function.
3448 for (p = start; *p != NUL && *p != '('; ++p)
3449 if (*p == AUTOLOAD_CHAR)
3450 vim9script = FALSE;
3451 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453 /*
3454 * Copy the function name to allocated memory.
3455 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3456 * Accept <SNR>123_name() outside a script.
3457 */
3458 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003459 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003460 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462 if (!vim9script)
3463 lead = 3;
3464 if (vim9script || (lv.ll_exp_name != NULL
3465 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 || eval_fname_sid(*pp))
3467 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003468 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003469 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003471 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 goto theend;
3473 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003474 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003475 if (vim9script)
3476 extra = 3 + (int)STRLEN(sid_buf);
3477 else
3478 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 }
3480 }
3481 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3482 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003483 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 start);
3485 goto theend;
3486 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003487 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003488 {
3489 char_u *cp = vim_strchr(lv.ll_name, ':');
3490
3491 if (cp != NULL && cp < end)
3492 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003493 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003494 goto theend;
3495 }
3496 }
3497
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003498 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 if (name != NULL)
3500 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003501 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 {
3503 name[0] = K_SPECIAL;
3504 name[1] = KS_EXTRA;
3505 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003506 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 STRCPY(name + 3, sid_buf);
3508 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003509 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3510 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511 }
3512 *pp = end;
3513
3514theend:
3515 clear_lval(&lv);
3516 return name;
3517}
3518
3519/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003520 * Assuming "name" is the result of trans_function_name() and it was prefixed
3521 * to use the script-local name, return the unmodified name (points into
3522 * "name"). Otherwise return NULL.
3523 * This can be used to first search for a script-local function and fall back
3524 * to the global function if not found.
3525 */
3526 char_u *
3527untrans_function_name(char_u *name)
3528{
3529 char_u *p;
3530
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003531 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003532 {
3533 p = vim_strchr(name, '_');
3534 if (p != NULL)
3535 return p + 1;
3536 }
3537 return NULL;
3538}
3539
3540/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003541 * List functions. When "regmatch" is NULL all of then.
3542 * Otherwise functions matching "regmatch".
3543 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003544 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003545list_functions(regmatch_T *regmatch)
3546{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003547 int changed = func_hashtab.ht_changed;
3548 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003549 hashitem_T *hi;
3550
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003551 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003552 {
3553 if (!HASHITEM_EMPTY(hi))
3554 {
3555 ufunc_T *fp = HI2UF(hi);
3556
3557 --todo;
3558 if ((fp->uf_flags & FC_DEAD) == 0
3559 && (regmatch == NULL
3560 ? !message_filtered(fp->uf_name)
3561 && !func_name_refcount(fp->uf_name)
3562 : !isdigit(*fp->uf_name)
3563 && vim_regexec(regmatch, fp->uf_name, 0)))
3564 {
3565 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003566 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003567 {
3568 emsg(_("E454: function list was modified"));
3569 return;
3570 }
3571 }
3572 }
3573 }
3574}
3575
3576/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003577 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003578 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3579 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003580 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003582 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003583define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003585 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 int j;
3587 int c;
3588 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003589 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003590 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 char_u *p;
3592 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003593 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594 char_u *line_arg = NULL;
3595 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003596 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003597 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 garray_T newlines;
3599 int varargs = FALSE;
3600 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003601 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003602 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003603 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 dictitem_T *v;
3605 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003606 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003609 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003610 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003611 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612
3613 /*
3614 * ":function" without argument: list functions.
3615 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003616 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 {
3618 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003619 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003621 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 }
3623
3624 /*
3625 * ":function /pat": list functions matching pattern.
3626 */
3627 if (*eap->arg == '/')
3628 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003629 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 if (!eap->skip)
3631 {
3632 regmatch_T regmatch;
3633
3634 c = *p;
3635 *p = NUL;
3636 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3637 *p = c;
3638 if (regmatch.regprog != NULL)
3639 {
3640 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003641 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 vim_regfree(regmatch.regprog);
3643 }
3644 }
3645 if (*p == '/')
3646 ++p;
3647 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003648 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 }
3650
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003651 ga_init(&newargs);
3652 ga_init(&argtypes);
3653 ga_init(&default_args);
3654
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 /*
3656 * Get the function name. There are these situations:
3657 * func normal function name
3658 * "name" == func, "fudi.fd_dict" == NULL
3659 * dict.func new dictionary entry
3660 * "name" == NULL, "fudi.fd_dict" set,
3661 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3662 * dict.func existing dict entry with a Funcref
3663 * "name" == func, "fudi.fd_dict" set,
3664 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3665 * dict.func existing dict entry that's not a Funcref
3666 * "name" == NULL, "fudi.fd_dict" set,
3667 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3668 * s:func script-local function name
3669 * g:func global function name, same as "func"
3670 */
3671 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003672 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003674 // nested function, argument is (args).
3675 paren = TRUE;
3676 CLEAR_FIELD(fudi);
3677 }
3678 else
3679 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003680 if (STRNCMP(p, "<lambda>", 8) == 0)
3681 {
3682 p += 8;
3683 (void)getdigits(&p);
3684 name = vim_strnsave(eap->arg, p - eap->arg);
3685 CLEAR_FIELD(fudi);
3686 }
3687 else
3688 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003689 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003690 paren = (vim_strchr(p, '(') != NULL);
3691 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003693 /*
3694 * Return on an invalid expression in braces, unless the expression
3695 * evaluation has been cancelled due to an aborting error, an
3696 * interrupt, or an exception.
3697 */
3698 if (!aborting())
3699 {
3700 if (!eap->skip && fudi.fd_newkey != NULL)
3701 semsg(_(e_dictkey), fudi.fd_newkey);
3702 vim_free(fudi.fd_newkey);
3703 return NULL;
3704 }
3705 else
3706 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708 }
3709
Bram Moolenaare38eab22019-12-05 21:50:01 +01003710 // An error in a function call during evaluation of an expression in magic
3711 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 saved_did_emsg = did_emsg;
3713 did_emsg = FALSE;
3714
3715 /*
3716 * ":function func" with only function name: list function.
3717 */
3718 if (!paren)
3719 {
3720 if (!ends_excmd(*skipwhite(p)))
3721 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003722 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 goto ret_free;
3724 }
3725 eap->nextcmd = check_nextcmd(p);
3726 if (eap->nextcmd != NULL)
3727 *p = NUL;
3728 if (!eap->skip && !got_int)
3729 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003730 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003731 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3732 {
3733 char_u *up = untrans_function_name(name);
3734
3735 // With Vim9 script the name was made script-local, if not
3736 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003737 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003738 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003739 }
3740
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 if (fp != NULL)
3742 {
3743 list_func_head(fp, TRUE);
3744 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3745 {
3746 if (FUNCLINE(fp, j) == NULL)
3747 continue;
3748 msg_putchar('\n');
3749 msg_outnum((long)(j + 1));
3750 if (j < 9)
3751 msg_putchar(' ');
3752 if (j < 99)
3753 msg_putchar(' ');
3754 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003755 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 ui_breakcheck();
3757 }
3758 if (!got_int)
3759 {
3760 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003761 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003762 msg_puts(" enddef");
3763 else
3764 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 }
3766 }
3767 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003768 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 }
3770 goto ret_free;
3771 }
3772
3773 /*
3774 * ":function name(arg1, arg2)" Define function.
3775 */
3776 p = skipwhite(p);
3777 if (*p != '(')
3778 {
3779 if (!eap->skip)
3780 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003781 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782 goto ret_free;
3783 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003784 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 if (vim_strchr(p, '(') != NULL)
3786 p = vim_strchr(p, '(');
3787 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003789 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3790 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003791 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003792 goto ret_free;
3793 }
3794
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003795 // In Vim9 script only global functions can be redefined.
3796 if (vim9script && eap->forceit && !is_global)
3797 {
3798 emsg(_(e_nobang));
3799 goto ret_free;
3800 }
3801
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003802 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803
Bram Moolenaar04b12692020-05-04 23:24:44 +02003804 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003806 // Check the name of the function. Unless it's a dictionary function
3807 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 if (name != NULL)
3809 arg = name;
3810 else
3811 arg = fudi.fd_newkey;
3812 if (arg != NULL && (fudi.fd_di == NULL
3813 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3814 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3815 {
3816 if (*arg == K_SPECIAL)
3817 j = 3;
3818 else
3819 j = 0;
3820 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3821 : eval_isnamec(arg[j])))
3822 ++j;
3823 if (arg[j] != NUL)
3824 emsg_funcname((char *)e_invarg2, arg);
3825 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003826 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003828 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 }
3830
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003831 // This may get more lines and make the pointers into the first line
3832 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003833 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003834 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003835 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003836 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003837 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003839 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003843 // find the return type: :def Func(): type
3844 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003845 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003846 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003847 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003848 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003849 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003850 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003851 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003852 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003853 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003854 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003855 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003856 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003857 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003858 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003860 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003862 else
3863 // find extra arguments "range", "dict", "abort" and "closure"
3864 for (;;)
3865 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003866 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003867 p = skipwhite(p);
3868 if (STRNCMP(p, "range", 5) == 0)
3869 {
3870 flags |= FC_RANGE;
3871 p += 5;
3872 }
3873 else if (STRNCMP(p, "dict", 4) == 0)
3874 {
3875 flags |= FC_DICT;
3876 p += 4;
3877 }
3878 else if (STRNCMP(p, "abort", 5) == 0)
3879 {
3880 flags |= FC_ABORT;
3881 p += 5;
3882 }
3883 else if (STRNCMP(p, "closure", 7) == 0)
3884 {
3885 flags |= FC_CLOSURE;
3886 p += 7;
3887 if (current_funccal == NULL)
3888 {
3889 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3890 name == NULL ? (char_u *)"" : name);
3891 goto erret;
3892 }
3893 }
3894 else
3895 break;
3896 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897
Bram Moolenaare38eab22019-12-05 21:50:01 +01003898 // When there is a line break use what follows for the function body.
3899 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003900 if (*p == '\n')
3901 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003902 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003903 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3904 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003905 && !(VIM_ISWHITE(*whitep) && *p == '#'
3906 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003907 && !eap->skip
3908 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003909 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910
3911 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003912 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3913 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914 */
3915 if (KeyTyped)
3916 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003917 // Check if the function already exists, don't let the user type the
3918 // whole function before telling him it doesn't work! For a script we
3919 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 if (!eap->skip && !eap->forceit)
3921 {
3922 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003923 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003924 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925 emsg_funcname(e_funcexts, name);
3926 }
3927
3928 if (!eap->skip && did_emsg)
3929 goto erret;
3930
Bram Moolenaare38eab22019-12-05 21:50:01 +01003931 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003932 cmdline_row = msg_row;
3933 }
3934
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003935 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003936 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003937
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003938 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 goto erret;
3940
3941 /*
3942 * If there are no errors, add the function
3943 */
3944 if (fudi.fd_dict == NULL)
3945 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003946 hashtab_T *ht;
3947
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003948 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3950 {
3951 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3952 name);
3953 goto erret;
3954 }
3955
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003956 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003957 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003959 char_u *uname = untrans_function_name(name);
3960
3961 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3962 }
3963
3964 if (fp != NULL || import != NULL)
3965 {
3966 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003967
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003968 // Function can be replaced with "function!" and when sourcing the
3969 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003970 // A name that is used by an import can not be overruled.
3971 if (import != NULL
3972 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003973 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003974 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003975 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003976 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003977 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003978 else
3979 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980 goto erret;
3981 }
3982 if (fp->uf_calls > 0)
3983 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003984 emsg_funcname(
3985 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 name);
3987 goto erret;
3988 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003989 if (fp->uf_refcount > 1)
3990 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003991 // This function is referenced somewhere, don't redefine it but
3992 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003993 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003994 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003995 fp = NULL;
3996 overwrite = TRUE;
3997 }
3998 else
3999 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004000 char_u *exp_name = fp->uf_name_exp;
4001
4002 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004003 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004004 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004005 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004006 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004007 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004008#ifdef FEAT_PROFILE
4009 fp->uf_profiling = FALSE;
4010 fp->uf_prof_initialized = FALSE;
4011#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004012 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004013 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 }
4015 }
4016 else
4017 {
4018 char numbuf[20];
4019
4020 fp = NULL;
4021 if (fudi.fd_newkey == NULL && !eap->forceit)
4022 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004023 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024 goto erret;
4025 }
4026 if (fudi.fd_di == NULL)
4027 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004028 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004029 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030 goto erret;
4031 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004032 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004033 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034 goto erret;
4035
Bram Moolenaare38eab22019-12-05 21:50:01 +01004036 // Give the function a sequential number. Can only be used with a
4037 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 vim_free(name);
4039 sprintf(numbuf, "%d", ++func_nr);
4040 name = vim_strsave((char_u *)numbuf);
4041 if (name == NULL)
4042 goto erret;
4043 }
4044
4045 if (fp == NULL)
4046 {
4047 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4048 {
4049 int slen, plen;
4050 char_u *scriptname;
4051
Bram Moolenaare38eab22019-12-05 21:50:01 +01004052 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004054 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 {
4056 scriptname = autoload_name(name);
4057 if (scriptname != NULL)
4058 {
4059 p = vim_strchr(scriptname, '/');
4060 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004061 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004063 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004064 j = OK;
4065 vim_free(scriptname);
4066 }
4067 }
4068 if (j == FAIL)
4069 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004070 linenr_T save_lnum = SOURCING_LNUM;
4071
4072 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004073 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004074 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 goto erret;
4076 }
4077 }
4078
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004079 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 if (fp == NULL)
4081 goto erret;
4082
4083 if (fudi.fd_dict != NULL)
4084 {
4085 if (fudi.fd_di == NULL)
4086 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004087 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4089 if (fudi.fd_di == NULL)
4090 {
4091 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004092 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 goto erret;
4094 }
4095 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4096 {
4097 vim_free(fudi.fd_di);
4098 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004099 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004100 goto erret;
4101 }
4102 }
4103 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004104 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004105 clear_tv(&fudi.fd_di->di_tv);
4106 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108
Bram Moolenaare38eab22019-12-05 21:50:01 +01004109 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 flags |= FC_DICT;
4111 }
4112
Bram Moolenaare38eab22019-12-05 21:50:01 +01004113 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004114 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004115 if (overwrite)
4116 {
4117 hi = hash_find(&func_hashtab, name);
4118 hi->hi_key = UF2HIKEY(fp);
4119 }
4120 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121 {
4122 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004123 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 goto erret;
4125 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004126 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004127 }
4128 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004129 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004130 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004131 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004132
4133 if (eap->cmdidx == CMD_def)
4134 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004135 int lnum_save = SOURCING_LNUM;
4136 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004137
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004138 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004139
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004140 // error messages are for the first function line
4141 SOURCING_LNUM = sourcing_lnum_top;
4142
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004143 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004144 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004145 int count = cstack->cs_idx + 1;
4146 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004147
4148 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004149 // a block that is visible now but not when the function is called
4150 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004151 fp->uf_block_ids = ALLOC_MULT(int, count);
4152 if (fp->uf_block_ids != NULL)
4153 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004154 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004155 sizeof(int) * count);
4156 fp->uf_block_depth = count;
4157 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004158
4159 // Set flag in each block to indicate a function was defined. This
4160 // is used to keep the variable when leaving the block, see
4161 // hide_script_var().
4162 for (i = 0; i <= cstack->cs_idx; ++i)
4163 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004164 }
4165
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004166 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004167 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004168 SOURCING_LNUM = lnum_save;
4169 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004170 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004171 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004172
4173 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004174 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004175 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004176 SOURCING_LNUM = lnum_save;
4177 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004178 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004179 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004180 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004181 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004182 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004183
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004185 if ((flags & FC_CLOSURE) != 0)
4186 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004187 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004188 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004189 }
4190 else
4191 fp->uf_scoped = NULL;
4192
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 if (prof_def_func())
4195 func_do_profile(fp);
4196#endif
4197 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004198 if (sandbox)
4199 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004200 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004201 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 fp->uf_flags = flags;
4203 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004204 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004205 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004206 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004207 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004208 if (is_export)
4209 {
4210 fp->uf_flags |= FC_EXPORT;
4211 // let ex_export() know the export worked.
4212 is_export = FALSE;
4213 }
4214
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004215 if (eap->cmdidx == CMD_def)
4216 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004217 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4218 // :func does not use Vim9 script syntax, even in a Vim9 script file
4219 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004220
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 goto ret_free;
4222
4223erret:
4224 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004225 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004226 if (fp != NULL)
4227 {
4228 ga_init(&fp->uf_args);
4229 ga_init(&fp->uf_def_args);
4230 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231errret_2:
4232 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004233 if (fp != NULL)
4234 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004236 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004237 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004239 if (name != name_arg)
4240 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004241 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004242 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004243
4244 return fp;
4245}
4246
4247/*
4248 * ":function"
4249 */
4250 void
4251ex_function(exarg_T *eap)
4252{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004253 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004254}
4255
4256/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004257 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004258 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004259 */
4260 void
4261ex_defcompile(exarg_T *eap UNUSED)
4262{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004263 long todo = (long)func_hashtab.ht_used;
4264 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004265 hashitem_T *hi;
4266 ufunc_T *ufunc;
4267
4268 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4269 {
4270 if (!HASHITEM_EMPTY(hi))
4271 {
4272 --todo;
4273 ufunc = HI2UF(hi);
4274 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004275 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4276 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004277 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004278 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004279
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004280 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004281 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004282 // a function has been added or removed, need to start over
4283 todo = (long)func_hashtab.ht_used;
4284 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004285 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004286 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004287 }
4288 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004289 }
4290 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004291}
4292
4293/*
4294 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4295 * Return 2 if "p" starts with "s:".
4296 * Return 0 otherwise.
4297 */
4298 int
4299eval_fname_script(char_u *p)
4300{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004301 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4302 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4304 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4305 return 5;
4306 if (p[0] == 's' && p[1] == ':')
4307 return 2;
4308 return 0;
4309}
4310
4311 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004312translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313{
4314 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004315 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004316 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004317}
4318
4319/*
4320 * Return TRUE when "ufunc" has old-style "..." varargs
4321 * or named varargs "...name: type".
4322 */
4323 int
4324has_varargs(ufunc_T *ufunc)
4325{
4326 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327}
4328
4329/*
4330 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004331 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332 */
4333 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004334function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335{
4336 char_u *nm = name;
4337 char_u *p;
4338 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004339 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004340 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004342 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4343 if (no_deref)
4344 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004345 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 nm = skipwhite(nm);
4347
Bram Moolenaare38eab22019-12-05 21:50:01 +01004348 // Only accept "funcname", "funcname ", "funcname (..." and
4349 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004350 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004351 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 vim_free(p);
4353 return n;
4354}
4355
Bram Moolenaar113e1072019-01-20 15:30:40 +01004356#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357 char_u *
4358get_expanded_name(char_u *name, int check)
4359{
4360 char_u *nm = name;
4361 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004362 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004364 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004365 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004367 if (p != NULL && *nm == NUL
4368 && (!check || translated_function_exists(p, is_global)))
4369 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370
4371 vim_free(p);
4372 return NULL;
4373}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004374#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376/*
4377 * Function given to ExpandGeneric() to obtain the list of user defined
4378 * function names.
4379 */
4380 char_u *
4381get_user_func_name(expand_T *xp, int idx)
4382{
4383 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004384 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004385 static hashitem_T *hi;
4386 ufunc_T *fp;
4387
4388 if (idx == 0)
4389 {
4390 done = 0;
4391 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004392 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004394 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004395 {
4396 if (done++ > 0)
4397 ++hi;
4398 while (HASHITEM_EMPTY(hi))
4399 ++hi;
4400 fp = HI2UF(hi);
4401
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004402 // don't show dead, dict and lambda functions
4403 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004404 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004405 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004406
4407 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004408 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004409
4410 cat_func_name(IObuff, fp);
4411 if (xp->xp_context != EXPAND_USER_FUNC)
4412 {
4413 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004414 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415 STRCAT(IObuff, ")");
4416 }
4417 return IObuff;
4418 }
4419 return NULL;
4420}
4421
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004422/*
4423 * ":delfunction {name}"
4424 */
4425 void
4426ex_delfunction(exarg_T *eap)
4427{
4428 ufunc_T *fp = NULL;
4429 char_u *p;
4430 char_u *name;
4431 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004432 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433
4434 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004435 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4436 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 vim_free(fudi.fd_newkey);
4438 if (name == NULL)
4439 {
4440 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004441 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 return;
4443 }
4444 if (!ends_excmd(*skipwhite(p)))
4445 {
4446 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004447 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448 return;
4449 }
4450 eap->nextcmd = check_nextcmd(p);
4451 if (eap->nextcmd != NULL)
4452 *p = NUL;
4453
4454 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004455 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004456 vim_free(name);
4457
4458 if (!eap->skip)
4459 {
4460 if (fp == NULL)
4461 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004462 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004463 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 return;
4465 }
4466 if (fp->uf_calls > 0)
4467 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004468 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 return;
4470 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004471 if (fp->uf_flags & FC_VIM9)
4472 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004473 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004474 return;
4475 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476
4477 if (fudi.fd_dict != NULL)
4478 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004479 // Delete the dict item that refers to the function, it will
4480 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4482 }
4483 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004484 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004485 // A normal function (not a numbered function or lambda) has a
4486 // refcount of 1 for the entry in the hashtable. When deleting
4487 // it and the refcount is more than one, it should be kept.
4488 // A numbered function and lambda should be kept if the refcount is
4489 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004490 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004491 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004492 // Function is still referenced somewhere. Don't free it but
4493 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004494 if (func_remove(fp))
4495 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004496 }
4497 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004498 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004499 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500 }
4501}
4502
4503/*
4504 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004505 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 */
4507 void
4508func_unref(char_u *name)
4509{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004510 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004512 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004513 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004514 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004515 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004518 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004520 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004521 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004522 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004523}
4524
4525/*
4526 * Unreference a Function: decrement the reference count and free it when it
4527 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004528 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004529 */
4530 void
4531func_ptr_unref(ufunc_T *fp)
4532{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004533 if (fp != NULL && (--fp->uf_refcount <= 0
4534 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4535 && fp->uf_partial->pt_refcount <= 1
4536 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004537 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004538 // Only delete it when it's not being used. Otherwise it's done
4539 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004540 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004541 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004542 }
4543}
4544
4545/*
4546 * Count a reference to a Function.
4547 */
4548 void
4549func_ref(char_u *name)
4550{
4551 ufunc_T *fp;
4552
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004553 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004555 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004556 if (fp != NULL)
4557 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004559 // Only give an error for a numbered function.
4560 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004561 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004562}
4563
4564/*
4565 * Count a reference to a Function.
4566 */
4567 void
4568func_ptr_ref(ufunc_T *fp)
4569{
4570 if (fp != NULL)
4571 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572}
4573
4574/*
4575 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4576 * referenced from anywhere that is in use.
4577 */
4578 static int
4579can_free_funccal(funccall_T *fc, int copyID)
4580{
4581 return (fc->l_varlist.lv_copyID != copyID
4582 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004583 && fc->l_avars.dv_copyID != copyID
4584 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585}
4586
4587/*
4588 * ":return [expr]"
4589 */
4590 void
4591ex_return(exarg_T *eap)
4592{
4593 char_u *arg = eap->arg;
4594 typval_T rettv;
4595 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004596 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004597
4598 if (current_funccal == NULL)
4599 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004600 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004601 return;
4602 }
4603
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004604 CLEAR_FIELD(evalarg);
4605 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4606
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607 if (eap->skip)
4608 ++emsg_skip;
4609
4610 eap->nextcmd = NULL;
4611 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004612 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004613 {
4614 if (!eap->skip)
4615 returning = do_return(eap, FALSE, TRUE, &rettv);
4616 else
4617 clear_tv(&rettv);
4618 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004619 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004620 else if (!eap->skip)
4621 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004622 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004623 update_force_abort();
4624
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625 /*
4626 * Return unless the expression evaluation has been cancelled due to an
4627 * aborting error, an interrupt, or an exception.
4628 */
4629 if (!aborting())
4630 returning = do_return(eap, FALSE, TRUE, NULL);
4631 }
4632
Bram Moolenaare38eab22019-12-05 21:50:01 +01004633 // When skipping or the return gets pending, advance to the next command
4634 // in this line (!returning). Otherwise, ignore the rest of the line.
4635 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004636 if (returning)
4637 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004638 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639 eap->nextcmd = check_nextcmd(arg);
4640
4641 if (eap->skip)
4642 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004643 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004644}
4645
4646/*
4647 * ":1,25call func(arg1, arg2)" function call.
4648 */
4649 void
4650ex_call(exarg_T *eap)
4651{
4652 char_u *arg = eap->arg;
4653 char_u *startarg;
4654 char_u *name;
4655 char_u *tofree;
4656 int len;
4657 typval_T rettv;
4658 linenr_T lnum;
4659 int doesrange;
4660 int failed = FALSE;
4661 funcdict_T fudi;
4662 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004663 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004664 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665
Bram Moolenaare6b53242020-07-01 17:28:33 +02004666 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 if (eap->skip)
4668 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004669 // trans_function_name() doesn't work well when skipping, use eval0()
4670 // instead to skip to any following command, e.g. for:
4671 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004673 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 clear_tv(&rettv);
4675 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004676 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004677 return;
4678 }
4679
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004680 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4681 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682 if (fudi.fd_newkey != NULL)
4683 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004684 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004685 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004686 vim_free(fudi.fd_newkey);
4687 }
4688 if (tofree == NULL)
4689 return;
4690
Bram Moolenaare38eab22019-12-05 21:50:01 +01004691 // Increase refcount on dictionary, it could get deleted when evaluating
4692 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 if (fudi.fd_dict != NULL)
4694 ++fudi.fd_dict->dv_refcount;
4695
Bram Moolenaare38eab22019-12-05 21:50:01 +01004696 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4697 // contents. For VAR_PARTIAL get its partial, unless we already have one
4698 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004700 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4701 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702
Bram Moolenaare38eab22019-12-05 21:50:01 +01004703 // Skip white space to allow ":call func ()". Not good, but required for
4704 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004705 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004706 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707
4708 if (*startarg != '(')
4709 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004710 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 goto end;
4712 }
4713
4714 /*
4715 * When skipping, evaluate the function once, to find the end of the
4716 * arguments.
4717 * When the function takes a range, this is discovered after the first
4718 * call, and the loop is broken.
4719 */
4720 if (eap->skip)
4721 {
4722 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004723 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724 }
4725 else
4726 lnum = eap->line1;
4727 for ( ; lnum <= eap->line2; ++lnum)
4728 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004729 funcexe_T funcexe;
4730
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 if (!eap->skip && eap->addr_count > 0)
4732 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004733 if (lnum > curbuf->b_ml.ml_line_count)
4734 {
4735 // If the function deleted lines or switched to another buffer
4736 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004737 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004738 break;
4739 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004740 curwin->w_cursor.lnum = lnum;
4741 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004742 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004743 }
4744 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004745
Bram Moolenaara80faa82020-04-12 19:37:17 +02004746 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004747 funcexe.firstline = eap->line1;
4748 funcexe.lastline = eap->line2;
4749 funcexe.doesrange = &doesrange;
4750 funcexe.evaluate = !eap->skip;
4751 funcexe.partial = partial;
4752 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004753 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004754 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004755 {
4756 failed = TRUE;
4757 break;
4758 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004759 if (has_watchexpr())
4760 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004762 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004763 if (handle_subscript(&arg, &rettv,
4764 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004765 {
4766 failed = TRUE;
4767 break;
4768 }
4769
4770 clear_tv(&rettv);
4771 if (doesrange || eap->skip)
4772 break;
4773
Bram Moolenaare38eab22019-12-05 21:50:01 +01004774 // Stop when immediately aborting on error, or when an interrupt
4775 // occurred or an exception was thrown but not caught.
4776 // get_func_tv() returned OK, so that the check for trailing
4777 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 if (aborting())
4779 break;
4780 }
4781 if (eap->skip)
4782 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004783 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784
Bram Moolenaare51bb172020-02-16 19:42:23 +01004785 // When inside :try we need to check for following "| catch".
4786 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004787 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004788 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004789 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004790 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004791 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004792 if (!failed)
4793 {
4794 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004795 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004796 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004797 }
4798 else
4799 eap->nextcmd = check_nextcmd(arg);
4800 }
4801
4802end:
4803 dict_unref(fudi.fd_dict);
4804 vim_free(tofree);
4805}
4806
4807/*
4808 * Return from a function. Possibly makes the return pending. Also called
4809 * for a pending return at the ":endtry" or after returning from an extra
4810 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4811 * when called due to a ":return" command. "rettv" may point to a typval_T
4812 * with the return rettv. Returns TRUE when the return can be carried out,
4813 * FALSE when the return gets pending.
4814 */
4815 int
4816do_return(
4817 exarg_T *eap,
4818 int reanimate,
4819 int is_cmd,
4820 void *rettv)
4821{
4822 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004823 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824
4825 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004826 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 current_funccal->returned = FALSE;
4828
4829 /*
4830 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4831 * not in its finally clause (which then is to be executed next) is found.
4832 * In this case, make the ":return" pending for execution at the ":endtry".
4833 * Otherwise, return normally.
4834 */
4835 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4836 if (idx >= 0)
4837 {
4838 cstack->cs_pending[idx] = CSTP_RETURN;
4839
4840 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004841 // A pending return again gets pending. "rettv" points to an
4842 // allocated variable with the rettv of the original ":return"'s
4843 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844 cstack->cs_rettv[idx] = rettv;
4845 else
4846 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004847 // When undoing a return in order to make it pending, get the stored
4848 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 if (reanimate)
4850 rettv = current_funccal->rettv;
4851
4852 if (rettv != NULL)
4853 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004854 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4856 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4857 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004858 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004859 }
4860 else
4861 cstack->cs_rettv[idx] = NULL;
4862
4863 if (reanimate)
4864 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004865 // The pending return value could be overwritten by a ":return"
4866 // without argument in a finally clause; reset the default
4867 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004868 current_funccal->rettv->v_type = VAR_NUMBER;
4869 current_funccal->rettv->vval.v_number = 0;
4870 }
4871 }
4872 report_make_pending(CSTP_RETURN, rettv);
4873 }
4874 else
4875 {
4876 current_funccal->returned = TRUE;
4877
Bram Moolenaare38eab22019-12-05 21:50:01 +01004878 // If the return is carried out now, store the return value. For
4879 // a return immediately after reanimation, the value is already
4880 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004881 if (!reanimate && rettv != NULL)
4882 {
4883 clear_tv(current_funccal->rettv);
4884 *current_funccal->rettv = *(typval_T *)rettv;
4885 if (!is_cmd)
4886 vim_free(rettv);
4887 }
4888 }
4889
4890 return idx < 0;
4891}
4892
4893/*
4894 * Free the variable with a pending return value.
4895 */
4896 void
4897discard_pending_return(void *rettv)
4898{
4899 free_tv((typval_T *)rettv);
4900}
4901
4902/*
4903 * Generate a return command for producing the value of "rettv". The result
4904 * is an allocated string. Used by report_pending() for verbose messages.
4905 */
4906 char_u *
4907get_return_cmd(void *rettv)
4908{
4909 char_u *s = NULL;
4910 char_u *tofree = NULL;
4911 char_u numbuf[NUMBUFLEN];
4912
4913 if (rettv != NULL)
4914 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4915 if (s == NULL)
4916 s = (char_u *)"";
4917
4918 STRCPY(IObuff, ":return ");
4919 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4920 if (STRLEN(s) + 8 >= IOSIZE)
4921 STRCPY(IObuff + IOSIZE - 4, "...");
4922 vim_free(tofree);
4923 return vim_strsave(IObuff);
4924}
4925
4926/*
4927 * Get next function line.
4928 * Called by do_cmdline() to get the next line.
4929 * Returns allocated string, or NULL for end of function.
4930 */
4931 char_u *
4932get_func_line(
4933 int c UNUSED,
4934 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004935 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004936 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937{
4938 funccall_T *fcp = (funccall_T *)cookie;
4939 ufunc_T *fp = fcp->func;
4940 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004941 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942
Bram Moolenaare38eab22019-12-05 21:50:01 +01004943 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004944 if (fcp->dbg_tick != debug_tick)
4945 {
4946 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004947 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004948 fcp->dbg_tick = debug_tick;
4949 }
4950#ifdef FEAT_PROFILE
4951 if (do_profiling == PROF_YES)
4952 func_line_end(cookie);
4953#endif
4954
4955 gap = &fp->uf_lines;
4956 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4957 || fcp->returned)
4958 retval = NULL;
4959 else
4960 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004961 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962 while (fcp->linenr < gap->ga_len
4963 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4964 ++fcp->linenr;
4965 if (fcp->linenr >= gap->ga_len)
4966 retval = NULL;
4967 else
4968 {
4969 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004970 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971#ifdef FEAT_PROFILE
4972 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004973 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974#endif
4975 }
4976 }
4977
Bram Moolenaare38eab22019-12-05 21:50:01 +01004978 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004979 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004981 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004982 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004983 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004984 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 fcp->dbg_tick = debug_tick;
4986 }
4987
4988 return retval;
4989}
4990
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004991/*
4992 * Return TRUE if the currently active function should be ended, because a
4993 * return was encountered or an error occurred. Used inside a ":while".
4994 */
4995 int
4996func_has_ended(void *cookie)
4997{
4998 funccall_T *fcp = (funccall_T *)cookie;
4999
Bram Moolenaare38eab22019-12-05 21:50:01 +01005000 // Ignore the "abort" flag if the abortion behavior has been changed due to
5001 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005002 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5003 || fcp->returned);
5004}
5005
5006/*
5007 * return TRUE if cookie indicates a function which "abort"s on errors.
5008 */
5009 int
5010func_has_abort(
5011 void *cookie)
5012{
5013 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5014}
5015
5016
5017/*
5018 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5019 * Don't do this when "Func" is already a partial that was bound
5020 * explicitly (pt_auto is FALSE).
5021 * Changes "rettv" in-place.
5022 * Returns the updated "selfdict_in".
5023 */
5024 dict_T *
5025make_partial(dict_T *selfdict_in, typval_T *rettv)
5026{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005027 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 char_u *tofree = NULL;
5029 ufunc_T *fp;
5030 char_u fname_buf[FLEN_FIXED + 1];
5031 int error;
5032 dict_T *selfdict = selfdict_in;
5033
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005034 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5035 fp = rettv->vval.v_partial->pt_func;
5036 else
5037 {
5038 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5039 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005040 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005041 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005042 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005043 vim_free(tofree);
5044 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005045
5046 if (fp != NULL && (fp->uf_flags & FC_DICT))
5047 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005048 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005049
5050 if (pt != NULL)
5051 {
5052 pt->pt_refcount = 1;
5053 pt->pt_dict = selfdict;
5054 pt->pt_auto = TRUE;
5055 selfdict = NULL;
5056 if (rettv->v_type == VAR_FUNC)
5057 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005058 // Just a function: Take over the function name and use
5059 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005060 pt->pt_name = rettv->vval.v_string;
5061 }
5062 else
5063 {
5064 partial_T *ret_pt = rettv->vval.v_partial;
5065 int i;
5066
Bram Moolenaare38eab22019-12-05 21:50:01 +01005067 // Partial: copy the function name, use selfdict and copy
5068 // args. Can't take over name or args, the partial might
5069 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005070 if (ret_pt->pt_name != NULL)
5071 {
5072 pt->pt_name = vim_strsave(ret_pt->pt_name);
5073 func_ref(pt->pt_name);
5074 }
5075 else
5076 {
5077 pt->pt_func = ret_pt->pt_func;
5078 func_ptr_ref(pt->pt_func);
5079 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080 if (ret_pt->pt_argc > 0)
5081 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005082 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005083 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005084 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085 pt->pt_argc = 0;
5086 else
5087 {
5088 pt->pt_argc = ret_pt->pt_argc;
5089 for (i = 0; i < pt->pt_argc; i++)
5090 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5091 }
5092 }
5093 partial_unref(ret_pt);
5094 }
5095 rettv->v_type = VAR_PARTIAL;
5096 rettv->vval.v_partial = pt;
5097 }
5098 }
5099 return selfdict;
5100}
5101
5102/*
5103 * Return the name of the executed function.
5104 */
5105 char_u *
5106func_name(void *cookie)
5107{
5108 return ((funccall_T *)cookie)->func->uf_name;
5109}
5110
5111/*
5112 * Return the address holding the next breakpoint line for a funccall cookie.
5113 */
5114 linenr_T *
5115func_breakpoint(void *cookie)
5116{
5117 return &((funccall_T *)cookie)->breakpoint;
5118}
5119
5120/*
5121 * Return the address holding the debug tick for a funccall cookie.
5122 */
5123 int *
5124func_dbg_tick(void *cookie)
5125{
5126 return &((funccall_T *)cookie)->dbg_tick;
5127}
5128
5129/*
5130 * Return the nesting level for a funccall cookie.
5131 */
5132 int
5133func_level(void *cookie)
5134{
5135 return ((funccall_T *)cookie)->level;
5136}
5137
5138/*
5139 * Return TRUE when a function was ended by a ":return" command.
5140 */
5141 int
5142current_func_returned(void)
5143{
5144 return current_funccal->returned;
5145}
5146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147 int
5148free_unref_funccal(int copyID, int testing)
5149{
5150 int did_free = FALSE;
5151 int did_free_funccal = FALSE;
5152 funccall_T *fc, **pfc;
5153
5154 for (pfc = &previous_funccal; *pfc != NULL; )
5155 {
5156 if (can_free_funccal(*pfc, copyID))
5157 {
5158 fc = *pfc;
5159 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005160 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005161 did_free = TRUE;
5162 did_free_funccal = TRUE;
5163 }
5164 else
5165 pfc = &(*pfc)->caller;
5166 }
5167 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005168 // When a funccal was freed some more items might be garbage
5169 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005170 (void)garbage_collect(testing);
5171
5172 return did_free;
5173}
5174
5175/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005176 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 */
5178 static funccall_T *
5179get_funccal(void)
5180{
5181 int i;
5182 funccall_T *funccal;
5183 funccall_T *temp_funccal;
5184
5185 funccal = current_funccal;
5186 if (debug_backtrace_level > 0)
5187 {
5188 for (i = 0; i < debug_backtrace_level; i++)
5189 {
5190 temp_funccal = funccal->caller;
5191 if (temp_funccal)
5192 funccal = temp_funccal;
5193 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005194 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005195 debug_backtrace_level = i;
5196 }
5197 }
5198 return funccal;
5199}
5200
5201/*
5202 * Return the hashtable used for local variables in the current funccal.
5203 * Return NULL if there is no current funccal.
5204 */
5205 hashtab_T *
5206get_funccal_local_ht()
5207{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005208 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209 return NULL;
5210 return &get_funccal()->l_vars.dv_hashtab;
5211}
5212
5213/*
5214 * Return the l: scope variable.
5215 * Return NULL if there is no current funccal.
5216 */
5217 dictitem_T *
5218get_funccal_local_var()
5219{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005220 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005221 return NULL;
5222 return &get_funccal()->l_vars_var;
5223}
5224
5225/*
5226 * Return the hashtable used for argument in the current funccal.
5227 * Return NULL if there is no current funccal.
5228 */
5229 hashtab_T *
5230get_funccal_args_ht()
5231{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005232 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005233 return NULL;
5234 return &get_funccal()->l_avars.dv_hashtab;
5235}
5236
5237/*
5238 * Return the a: scope variable.
5239 * Return NULL if there is no current funccal.
5240 */
5241 dictitem_T *
5242get_funccal_args_var()
5243{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005244 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005245 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005246 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247}
5248
5249/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005250 * List function variables, if there is a function.
5251 */
5252 void
5253list_func_vars(int *first)
5254{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005255 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005256 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005257 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258}
5259
5260/*
5261 * If "ht" is the hashtable for local variables in the current funccal, return
5262 * the dict that contains it.
5263 * Otherwise return NULL.
5264 */
5265 dict_T *
5266get_current_funccal_dict(hashtab_T *ht)
5267{
5268 if (current_funccal != NULL
5269 && ht == &current_funccal->l_vars.dv_hashtab)
5270 return &current_funccal->l_vars;
5271 return NULL;
5272}
5273
5274/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005275 * Search hashitem in parent scope.
5276 */
5277 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005278find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005279{
5280 funccall_T *old_current_funccal = current_funccal;
5281 hashtab_T *ht;
5282 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005283 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005284
5285 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5286 return NULL;
5287
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005288 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005289 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005290 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005291 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005292 ht = find_var_ht(name, &varname);
5293 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005294 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005295 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005296 if (!HASHITEM_EMPTY(hi))
5297 {
5298 *pht = ht;
5299 break;
5300 }
5301 }
5302 if (current_funccal == current_funccal->func->uf_scoped)
5303 break;
5304 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005305 }
5306 current_funccal = old_current_funccal;
5307
5308 return hi;
5309}
5310
5311/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005312 * Search variable in parent scope.
5313 */
5314 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005315find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005316{
5317 dictitem_T *v = NULL;
5318 funccall_T *old_current_funccal = current_funccal;
5319 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005320 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005321
5322 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5323 return NULL;
5324
Bram Moolenaare38eab22019-12-05 21:50:01 +01005325 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005326 current_funccal = current_funccal->func->uf_scoped;
5327 while (current_funccal)
5328 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005329 ht = find_var_ht(name, &varname);
5330 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005331 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005332 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005333 if (v != NULL)
5334 break;
5335 }
5336 if (current_funccal == current_funccal->func->uf_scoped)
5337 break;
5338 current_funccal = current_funccal->func->uf_scoped;
5339 }
5340 current_funccal = old_current_funccal;
5341
5342 return v;
5343}
5344
5345/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005346 * Set "copyID + 1" in previous_funccal and callers.
5347 */
5348 int
5349set_ref_in_previous_funccal(int copyID)
5350{
5351 int abort = FALSE;
5352 funccall_T *fc;
5353
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005354 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005355 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005356 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005357 abort = abort
5358 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5359 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005360 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005361 }
5362 return abort;
5363}
5364
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005365 static int
5366set_ref_in_funccal(funccall_T *fc, int copyID)
5367{
5368 int abort = FALSE;
5369
5370 if (fc->fc_copyID != copyID)
5371 {
5372 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005373 abort = abort
5374 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5375 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005376 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005377 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005378 }
5379 return abort;
5380}
5381
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382/*
5383 * Set "copyID" in all local vars and arguments in the call stack.
5384 */
5385 int
5386set_ref_in_call_stack(int copyID)
5387{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005388 int abort = FALSE;
5389 funccall_T *fc;
5390 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005391
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005392 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005393 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005394
5395 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005396 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5397 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005398 abort = abort || set_ref_in_funccal(fc, copyID);
5399
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005400 return abort;
5401}
5402
5403/*
5404 * Set "copyID" in all functions available by name.
5405 */
5406 int
5407set_ref_in_functions(int copyID)
5408{
5409 int todo;
5410 hashitem_T *hi = NULL;
5411 int abort = FALSE;
5412 ufunc_T *fp;
5413
5414 todo = (int)func_hashtab.ht_used;
5415 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005416 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005417 if (!HASHITEM_EMPTY(hi))
5418 {
5419 --todo;
5420 fp = HI2UF(hi);
5421 if (!func_name_refcount(fp->uf_name))
5422 abort = abort || set_ref_in_func(NULL, fp, copyID);
5423 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005424 }
5425 return abort;
5426}
5427
5428/*
5429 * Set "copyID" in all function arguments.
5430 */
5431 int
5432set_ref_in_func_args(int copyID)
5433{
5434 int i;
5435 int abort = FALSE;
5436
5437 for (i = 0; i < funcargs.ga_len; ++i)
5438 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5439 copyID, NULL, NULL);
5440 return abort;
5441}
5442
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005443/*
5444 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005445 * Returns TRUE if setting references failed somehow.
5446 */
5447 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005448set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005449{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005450 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005451 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005452 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005453 char_u fname_buf[FLEN_FIXED + 1];
5454 char_u *tofree = NULL;
5455 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005456 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005457
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005458 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005459 return FALSE;
5460
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005461 if (fp_in == NULL)
5462 {
5463 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005464 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005465 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005466 if (fp != NULL)
5467 {
5468 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005469 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005470 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005471
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005472 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005473 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005474}
5475
Bram Moolenaare38eab22019-12-05 21:50:01 +01005476#endif // FEAT_EVAL