blob: 64e815d04207c93732ce28aa8f6cc69f3083abad [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".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200609 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100610 * "newlines" must already have been initialized.
611 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
612 */
613 static int
614get_function_body(
615 exarg_T *eap,
616 garray_T *newlines,
617 char_u *line_arg_in,
618 char_u **line_to_free)
619{
620 linenr_T sourcing_lnum_top = SOURCING_LNUM;
621 linenr_T sourcing_lnum_off;
622 int saved_wait_return = need_wait_return;
623 char_u *line_arg = line_arg_in;
624 int vim9_function = eap->cmdidx == CMD_def
625 || eap->cmdidx == CMD_block;
626#define MAX_FUNC_NESTING 50
627 char nesting_def[MAX_FUNC_NESTING];
628 int nesting = 0;
629 getline_opt_T getline_options;
630 int indent = 2;
631 char_u *skip_until = NULL;
632 int ret = FAIL;
633 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200634 int heredoc_concat_len = 0;
635 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100636 char_u *heredoc_trimmed = NULL;
637
Bram Moolenaar20677332021-06-06 17:02:53 +0200638 ga_init2(&heredoc_ga, 1, 500);
639
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100640 // Detect having skipped over comment lines to find the return
641 // type. Add NULL lines to keep the line count correct.
642 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
643 if (SOURCING_LNUM < sourcing_lnum_off)
644 {
645 sourcing_lnum_off -= SOURCING_LNUM;
646 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
647 goto theend;
648 while (sourcing_lnum_off-- > 0)
649 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
650 }
651
652 nesting_def[nesting] = vim9_function;
653 getline_options = vim9_function
654 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
655 for (;;)
656 {
657 char_u *theline;
658 char_u *p;
659 char_u *arg;
660
661 if (KeyTyped)
662 {
663 msg_scroll = TRUE;
664 saved_wait_return = FALSE;
665 }
666 need_wait_return = FALSE;
667
668 if (line_arg != NULL)
669 {
670 // Use eap->arg, split up in parts by line breaks.
671 theline = line_arg;
672 p = vim_strchr(theline, '\n');
673 if (p == NULL)
674 line_arg += STRLEN(line_arg);
675 else
676 {
677 *p = NUL;
678 line_arg = p + 1;
679 }
680 }
681 else
682 {
683 vim_free(*line_to_free);
684 if (eap->getline == NULL)
685 theline = getcmdline(':', 0L, indent, getline_options);
686 else
687 theline = eap->getline(':', eap->cookie, indent,
688 getline_options);
689 *line_to_free = theline;
690 }
691 if (KeyTyped)
692 lines_left = Rows - 1;
693 if (theline == NULL)
694 {
695 // Use the start of the function for the line number.
696 SOURCING_LNUM = sourcing_lnum_top;
697 if (skip_until != NULL)
698 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
699 else if (eap->cmdidx == CMD_def)
700 emsg(_(e_missing_enddef));
701 else if (eap->cmdidx == CMD_block)
702 emsg(_(e_missing_end_block));
703 else
704 emsg(_("E126: Missing :endfunction"));
705 goto theend;
706 }
707
708 // Detect line continuation: SOURCING_LNUM increased more than one.
709 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
710 if (SOURCING_LNUM < sourcing_lnum_off)
711 sourcing_lnum_off -= SOURCING_LNUM;
712 else
713 sourcing_lnum_off = 0;
714
715 if (skip_until != NULL)
716 {
717 // Don't check for ":endfunc"/":enddef" between
718 // * ":append" and "."
719 // * ":python <<EOF" and "EOF"
720 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
721 if (heredoc_trimmed == NULL
722 || (is_heredoc && skipwhite(theline) == theline)
723 || STRNCMP(theline, heredoc_trimmed,
724 STRLEN(heredoc_trimmed)) == 0)
725 {
726 if (heredoc_trimmed == NULL)
727 p = theline;
728 else if (is_heredoc)
729 p = skipwhite(theline) == theline
730 ? theline : theline + STRLEN(heredoc_trimmed);
731 else
732 p = theline + STRLEN(heredoc_trimmed);
733 if (STRCMP(p, skip_until) == 0)
734 {
735 VIM_CLEAR(skip_until);
736 VIM_CLEAR(heredoc_trimmed);
737 getline_options = vim9_function
738 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
739 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200740
741 if (heredoc_concat_len > 0)
742 {
743 // Replace the starting line with all the concatenated
744 // lines.
745 ga_concat(&heredoc_ga, theline);
746 vim_free(((char_u **)(newlines->ga_data))[
747 heredoc_concat_len - 1]);
748 ((char_u **)(newlines->ga_data))[
749 heredoc_concat_len - 1] = heredoc_ga.ga_data;
750 ga_init(&heredoc_ga);
751 heredoc_concat_len = 0;
752 theline += STRLEN(theline); // skip the "EOF"
753 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100754 }
755 }
756 }
757 else
758 {
759 int c;
760
761 // skip ':' and blanks
762 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
763 ;
764
765 // Check for "endfunction", "enddef" or "}".
766 // When a ":" follows it must be a dict key; "enddef: value,"
767 if ((nesting == 0 && eap->cmdidx == CMD_block)
768 ? *p == '}'
769 : (checkforcmd(&p, nesting_def[nesting]
770 ? "enddef" : "endfunction", 4)
771 && *p != ':'))
772 {
773 if (nesting-- == 0)
774 {
775 char_u *nextcmd = NULL;
776
777 if (*p == '|' || *p == '}')
778 nextcmd = p + 1;
779 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
780 nextcmd = line_arg;
781 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100782 && (vim9_function || p_verbose > 0))
783 {
784 if (eap->cmdidx == CMD_def)
785 semsg(_(e_text_found_after_enddef_str), p);
786 else
787 give_warning2((char_u *)
788 _("W22: Text found after :endfunction: %s"),
789 p, TRUE);
790 }
791 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100792 {
793 // Another command follows. If the line came from "eap"
794 // we can simply point into it, otherwise we need to
795 // change "eap->cmdlinep".
796 eap->nextcmd = nextcmd;
797 if (*line_to_free != NULL)
798 {
799 vim_free(*eap->cmdlinep);
800 *eap->cmdlinep = *line_to_free;
801 *line_to_free = NULL;
802 }
803 }
804 break;
805 }
806 }
807
808 // Check for mismatched "endfunc" or "enddef".
809 // We don't check for "def" inside "func" thus we also can't check
810 // for "enddef".
811 // We continue to find the end of the function, although we might
812 // not find it.
813 else if (nesting_def[nesting])
814 {
815 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
816 emsg(_(e_mismatched_endfunction));
817 }
818 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
819 emsg(_(e_mismatched_enddef));
820
821 // Increase indent inside "if", "while", "for" and "try", decrease
822 // at "end".
823 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
824 indent -= 2;
825 else if (STRNCMP(p, "if", 2) == 0
826 || STRNCMP(p, "wh", 2) == 0
827 || STRNCMP(p, "for", 3) == 0
828 || STRNCMP(p, "try", 3) == 0)
829 indent += 2;
830
831 // Check for defining a function inside this function.
832 // Only recognize "def" inside "def", not inside "function",
833 // For backwards compatibility, see Test_function_python().
834 c = *p;
835 if (is_function_cmd(&p)
836 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
837 {
838 if (*p == '!')
839 p = skipwhite(p + 1);
840 p += eval_fname_script(p);
841 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
842 NULL, NULL));
843 if (*skipwhite(p) == '(')
844 {
845 if (nesting == MAX_FUNC_NESTING - 1)
846 emsg(_(e_function_nesting_too_deep));
847 else
848 {
849 ++nesting;
850 nesting_def[nesting] = (c == 'd');
851 indent += 2;
852 }
853 }
854 }
855
856 // Check for ":append", ":change", ":insert". Not for :def.
857 p = skip_range(p, FALSE, NULL);
858 if (!vim9_function
859 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
860 || (p[0] == 'c'
861 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
862 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
863 && (STRNCMP(&p[3], "nge", 3) != 0
864 || !ASCII_ISALPHA(p[6])))))))
865 || (p[0] == 'i'
866 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
867 && (!ASCII_ISALPHA(p[2])
868 || (p[2] == 's'
869 && (!ASCII_ISALPHA(p[3])
870 || p[3] == 'e'))))))))
871 skip_until = vim_strsave((char_u *)".");
872
873 // Check for ":python <<EOF", ":tcl <<EOF", etc.
874 arg = skipwhite(skiptowhite(p));
875 if (arg[0] == '<' && arg[1] =='<'
876 && ((p[0] == 'p' && p[1] == 'y'
877 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
878 || ((p[2] == '3' || p[2] == 'x')
879 && !ASCII_ISALPHA(p[3]))))
880 || (p[0] == 'p' && p[1] == 'e'
881 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
882 || (p[0] == 't' && p[1] == 'c'
883 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
884 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
885 && !ASCII_ISALPHA(p[3]))
886 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
887 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
888 || (p[0] == 'm' && p[1] == 'z'
889 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
890 ))
891 {
892 // ":python <<" continues until a dot, like ":append"
893 p = skipwhite(arg + 2);
894 if (STRNCMP(p, "trim", 4) == 0)
895 {
896 // Ignore leading white space.
897 p = skipwhite(p + 4);
898 heredoc_trimmed = vim_strnsave(theline,
899 skipwhite(theline) - theline);
900 }
901 if (*p == NUL)
902 skip_until = vim_strsave((char_u *)".");
903 else
904 skip_until = vim_strnsave(p, skiptowhite(p) - p);
905 getline_options = GETLINE_NONE;
906 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200907 if (eap->cmdidx == CMD_def)
908 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100909 }
910
911 // Check for ":cmd v =<< [trim] EOF"
912 // and ":cmd [a, b] =<< [trim] EOF"
913 // and "lines =<< [trim] EOF" for Vim9
914 // Where "cmd" can be "let", "var", "final" or "const".
915 arg = skipwhite(skiptowhite(p));
916 if (*arg == '[')
917 arg = vim_strchr(arg, ']');
918 if (arg != NULL)
919 {
920 int found = (eap->cmdidx == CMD_def && arg[0] == '='
921 && arg[1] == '<' && arg[2] =='<');
922
923 if (!found)
924 // skip over the argument after "cmd"
925 arg = skipwhite(skiptowhite(arg));
926 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
927 && (checkforcmd(&p, "let", 2)
928 || checkforcmd(&p, "var", 3)
929 || checkforcmd(&p, "final", 5)
930 || checkforcmd(&p, "const", 5))))
931 {
932 p = skipwhite(arg + 3);
933 if (STRNCMP(p, "trim", 4) == 0)
934 {
935 // Ignore leading white space.
936 p = skipwhite(p + 4);
937 heredoc_trimmed = vim_strnsave(theline,
938 skipwhite(theline) - theline);
939 }
940 skip_until = vim_strnsave(p, skiptowhite(p) - p);
941 getline_options = GETLINE_NONE;
942 is_heredoc = TRUE;
943 }
944 }
945 }
946
947 // Add the line to the function.
948 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
949 goto theend;
950
Bram Moolenaar20677332021-06-06 17:02:53 +0200951 if (heredoc_concat_len > 0)
952 {
953 // For a :def function "python << EOF" concatenats all the lines,
954 // to be used for the instruction later.
955 ga_concat(&heredoc_ga, theline);
956 ga_concat(&heredoc_ga, (char_u *)"\n");
957 p = vim_strsave((char_u *)"");
958 }
959 else
960 {
961 // Copy the line to newly allocated memory. get_one_sourceline()
962 // allocates 250 bytes per line, this saves 80% on average. The
963 // cost is an extra alloc/free.
964 p = vim_strsave(theline);
965 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100966 if (p == NULL)
967 goto theend;
968 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
969
970 // Add NULL lines for continuation lines, so that the line count is
971 // equal to the index in the growarray.
972 while (sourcing_lnum_off-- > 0)
973 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
974
975 // Check for end of eap->arg.
976 if (line_arg != NULL && *line_arg == NUL)
977 line_arg = NULL;
978 }
979
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200980 // Return OK when no error was detected.
981 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100982 ret = OK;
983
984theend:
985 vim_free(skip_until);
986 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +0200987 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100988 need_wait_return |= saved_wait_return;
989 return ret;
990}
991
992/*
993 * Handle the body of a lambda. *arg points to the "{", process statements
994 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200995 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100996 * When successful "rettv" is set to a funcref.
997 */
998 static int
999lambda_function_body(
1000 char_u **arg,
1001 typval_T *rettv,
1002 evalarg_T *evalarg,
1003 garray_T *newargs,
1004 garray_T *argtypes,
1005 int varargs,
1006 garray_T *default_args,
1007 char_u *ret_type)
1008{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001009 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001010 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001011 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001012 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001013 exarg_T eap;
1014 garray_T newlines;
1015 char_u *cmdline = NULL;
1016 int ret = FAIL;
1017 char_u *line_to_free = NULL;
1018 partial_T *pt;
1019 char_u *name;
1020 int lnum_save = -1;
1021 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1022
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001023 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1024 {
1025 semsg(_(e_trailing_arg), *arg + 1);
1026 return FAIL;
1027 }
1028
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001029 CLEAR_FIELD(eap);
1030 eap.cmdidx = CMD_block;
1031 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001032 eap.cmdlinep = &cmdline;
1033 eap.skip = !evaluate;
1034 if (evalarg->eval_cctx != NULL)
1035 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1036 else
1037 {
1038 eap.getline = evalarg->eval_getline;
1039 eap.cookie = evalarg->eval_cookie;
1040 }
1041
1042 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1043 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001044 {
1045 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001046 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001047 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001048
1049 // When inside a lambda must add the function lines to evalarg.eval_ga.
1050 evalarg->eval_break_count += newlines.ga_len;
1051 if (gap->ga_itemsize > 0)
1052 {
1053 int idx;
1054 char_u *last;
1055 size_t plen;
1056 char_u *pnl;
1057
1058 for (idx = 0; idx < newlines.ga_len; ++idx)
1059 {
1060 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1061
Bram Moolenaarecb66452021-05-18 15:09:18 +02001062 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001063 goto erret;
1064
1065 // Going to concatenate the lines after parsing. For an empty or
1066 // comment line use an empty string.
1067 // Insert NL characters at the start of each line, the string will
1068 // be split again later in .get_lambda_tv().
1069 if (*p == NUL || vim9_comment_start(p))
1070 p = (char_u *)"";
1071 plen = STRLEN(p);
1072 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1073 if (pnl != NULL)
1074 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001075 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1076 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001077 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001078 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001079 goto erret;
1080 if (cmdline != NULL)
1081 // more is following after the "}", which was skipped
1082 last = cmdline;
1083 else
1084 // nothing is following the "}"
1085 last = (char_u *)"}";
1086 plen = STRLEN(last);
1087 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1088 if (pnl != NULL)
1089 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001090 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1091 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001092 }
1093
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001094 if (cmdline != NULL)
1095 {
1096 // Something comes after the "}".
1097 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001098
1099 // "arg" points into cmdline, need to keep the line and free it later.
1100 vim_free(evalarg->eval_tofree_cmdline);
1101 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001102 }
1103 else
1104 *arg = (char_u *)"";
1105
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001106 if (!evaluate)
1107 {
1108 ret = OK;
1109 goto erret;
1110 }
1111
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001112 name = get_lambda_name();
1113 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1114 if (ufunc == NULL)
1115 goto erret;
1116 set_ufunc_name(ufunc, name);
1117 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001118 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001119 ufunc->uf_refcount = 1;
1120 ufunc->uf_args = *newargs;
1121 newargs->ga_data = NULL;
1122 ufunc->uf_def_args = *default_args;
1123 default_args->ga_data = NULL;
1124 ufunc->uf_func_type = &t_func_any;
1125
1126 // error messages are for the first function line
1127 lnum_save = SOURCING_LNUM;
1128 SOURCING_LNUM = sourcing_lnum_top;
1129
1130 // parse argument types
1131 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1132 {
1133 SOURCING_LNUM = lnum_save;
1134 goto erret;
1135 }
1136
1137 // parse the return type, if any
1138 if (parse_return_type(ufunc, ret_type) == FAIL)
1139 goto erret;
1140
1141 pt = ALLOC_CLEAR_ONE(partial_T);
1142 if (pt == NULL)
1143 goto erret;
1144 pt->pt_func = ufunc;
1145 pt->pt_refcount = 1;
1146
1147 ufunc->uf_lines = newlines;
1148 newlines.ga_data = NULL;
1149 if (sandbox)
1150 ufunc->uf_flags |= FC_SANDBOX;
1151 if (!ASCII_ISUPPER(*ufunc->uf_name))
1152 ufunc->uf_flags |= FC_VIM9;
1153 ufunc->uf_script_ctx = current_sctx;
1154 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1155 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1156 set_function_type(ufunc);
1157
1158 rettv->vval.v_partial = pt;
1159 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001160 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001161 ret = OK;
1162
1163erret:
1164 if (lnum_save >= 0)
1165 SOURCING_LNUM = lnum_save;
1166 vim_free(line_to_free);
1167 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001168 if (newargs != NULL)
1169 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001170 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001171 if (ufunc != NULL)
1172 {
1173 func_clear(ufunc, TRUE);
1174 func_free(ufunc, TRUE);
1175 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001176 return ret;
1177}
1178
1179/*
1180 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001181 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001182 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001183 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1184 */
1185 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001186get_lambda_tv(
1187 char_u **arg,
1188 typval_T *rettv,
1189 int types_optional,
1190 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001191{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001192 int evaluate = evalarg != NULL
1193 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001194 garray_T newargs;
1195 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001196 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001197 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001198 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001199 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001200 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001201 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001202 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001203 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001204 char_u *s;
1205 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001206 int *old_eval_lavars = eval_lavars_used;
1207 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001208 char_u *tofree1 = NULL;
1209 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001210 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001211 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001212 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001213
1214 if (equal_arrow && !in_vim9script())
1215 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001216
1217 ga_init(&newargs);
1218 ga_init(&newlines);
1219
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001220 // First, check if this is really a lambda expression. "->" or "=>" must
1221 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001222 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001223 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001224 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001225 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001226 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001227 {
1228 if (types_optional)
1229 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001230 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001231 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001232
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001233 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001234 if (evaluate)
1235 pnewargs = &newargs;
1236 else
1237 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001238 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001239 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001240 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001241 &varargs, &default_args,
1242 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001243 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001244 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001245 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001246 {
1247 if (types_optional)
1248 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001249 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001250 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001251 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001252 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001253
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001254 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1255 if (ret_type != NULL)
1256 {
1257 ret_type = vim_strsave(ret_type);
1258 tofree2 = ret_type;
1259 }
1260
Bram Moolenaare38eab22019-12-05 21:50:01 +01001261 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001262 if (evaluate)
1263 eval_lavars_used = &eval_lavars;
1264
Bram Moolenaar65c44152020-12-24 15:14:01 +01001265 *arg = skipwhite_and_linebreak(*arg, evalarg);
1266
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001267 // Recognize "{" as the start of a function body.
1268 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001269 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001270 if (evalarg == NULL)
1271 // cannot happen?
1272 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001273 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1274 types_optional ? &argtypes : NULL, varargs,
1275 &default_args, ret_type) == FAIL)
1276 goto errret;
1277 goto theend;
1278 }
1279 if (default_args.ga_len > 0)
1280 {
1281 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001282 goto errret;
1283 }
1284
Bram Moolenaare38eab22019-12-05 21:50:01 +01001285 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001286 start = *arg;
1287 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001288 if (ret == FAIL)
1289 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001290 if (evalarg != NULL)
1291 {
1292 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001293 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001294 evalarg->eval_tofree = NULL;
1295 }
1296
Bram Moolenaar65c44152020-12-24 15:14:01 +01001297 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001298 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001299 *arg = skipwhite_and_linebreak(*arg, evalarg);
1300 if (**arg != '}')
1301 {
1302 semsg(_("E451: Expected }: %s"), *arg);
1303 goto errret;
1304 }
1305 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001306 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001307
1308 if (evaluate)
1309 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001310 int len;
1311 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001312 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001313 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001314 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001315
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001316 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 if (fp == NULL)
1318 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001319 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001320 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001321 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001322 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001323
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1325 if (ga_grow(&newlines, 1) == FAIL)
1326 goto errret;
1327
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001328 // If there are line breaks, we need to split up the string.
1329 line_end = vim_strchr(start, '\n');
1330 if (line_end == NULL)
1331 line_end = end;
1332
1333 // Add "return " before the expression (or the first line).
1334 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001335 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001336 if (p == NULL)
1337 goto errret;
1338 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1339 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001340 vim_strncpy(p + 7, start, line_end - start);
1341
1342 if (line_end != end)
1343 {
1344 // Add more lines, split by line breaks. Thus is used when a
1345 // lambda with { cmds } is encountered.
1346 while (*line_end == '\n')
1347 {
1348 if (ga_grow(&newlines, 1) == FAIL)
1349 goto errret;
1350 start = line_end + 1;
1351 line_end = vim_strchr(start, '\n');
1352 if (line_end == NULL)
1353 line_end = end;
1354 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1355 vim_strnsave(start, line_end - start);
1356 }
1357 }
1358
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001359 if (strstr((char *)p + 7, "a:") == NULL)
1360 // No a: variables are used for sure.
1361 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001362
1363 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001364 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001366 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001367 if (types_optional)
1368 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001369 if (parse_argument_types(fp, &argtypes,
1370 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001371 goto errret;
1372 if (ret_type != NULL)
1373 {
1374 fp->uf_ret_type = parse_type(&ret_type,
1375 &fp->uf_type_list, TRUE);
1376 if (fp->uf_ret_type == NULL)
1377 goto errret;
1378 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001379 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001380 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001381 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001382
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001384 if (current_funccal != NULL && eval_lavars)
1385 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001386 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001387 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001388 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001389 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001390
1391#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001392 if (prof_def_func())
1393 func_do_profile(fp);
1394#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001395 if (sandbox)
1396 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001397 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001398 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1399 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001400 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001401 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001402 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001403 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001404
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001405 pt->pt_func = fp;
1406 pt->pt_refcount = 1;
1407 rettv->vval.v_partial = pt;
1408 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001409
1410 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001411 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001412
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001413theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001414 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001415 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001416 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001417 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001418 vim_free(tofree1);
1419 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001420 if (types_optional)
1421 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422 return OK;
1423
1424errret:
1425 ga_clear_strings(&newargs);
1426 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001427 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001428 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001429 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001430 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001431 if (fp != NULL)
1432 vim_free(fp->uf_arg_types);
1433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001434 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001435 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001436 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001437 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001438 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001439 vim_free(tofree1);
1440 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001441 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001442 return FAIL;
1443}
1444
1445/*
1446 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1447 * name it contains, otherwise return "name".
1448 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1449 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001450 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1451 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452 */
1453 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001454deref_func_name(
1455 char_u *name,
1456 int *lenp,
1457 partial_T **partialp,
1458 type_T **type,
1459 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460{
1461 dictitem_T *v;
1462 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001463 char_u *s = NULL;
1464 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465
1466 if (partialp != NULL)
1467 *partialp = NULL;
1468
1469 cc = name[*lenp];
1470 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001471
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001472 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001473 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001474 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001476 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001478 if (v->di_tv.vval.v_string == NULL)
1479 {
1480 *lenp = 0;
1481 return (char_u *)""; // just in case
1482 }
1483 s = v->di_tv.vval.v_string;
1484 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001487 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001489 partial_T *pt = v->di_tv.vval.v_partial;
1490
1491 if (pt == NULL)
1492 {
1493 *lenp = 0;
1494 return (char_u *)""; // just in case
1495 }
1496 if (partialp != NULL)
1497 *partialp = pt;
1498 s = partial_name(pt);
1499 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001501
1502 if (s != NULL)
1503 {
1504 if (type != NULL && ht == get_script_local_ht())
1505 {
1506 svar_T *sv = find_typval_in_script(&v->di_tv);
1507
1508 if (sv != NULL)
1509 *type = sv->sv_type;
1510 }
1511 return s;
1512 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001513 }
1514
1515 return name;
1516}
1517
1518/*
1519 * Give an error message with a function name. Handle <SNR> things.
1520 * "ermsg" is to be passed without translation, use N_() instead of _().
1521 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001522 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523emsg_funcname(char *ermsg, char_u *name)
1524{
1525 char_u *p;
1526
1527 if (*name == K_SPECIAL)
1528 p = concat_str((char_u *)"<SNR>", name + 3);
1529 else
1530 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001531 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 if (p != name)
1533 vim_free(p);
1534}
1535
1536/*
1537 * Allocate a variable for the result of a function.
1538 * Return OK or FAIL.
1539 */
1540 int
1541get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001542 char_u *name, // name of the function
1543 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001545 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001546 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001547 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548{
1549 char_u *argp;
1550 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001551 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1552 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001553 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554
1555 /*
1556 * Get the arguments.
1557 */
1558 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001559 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1560 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001562 // skip the '(' or ',' and possibly line breaks
1563 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1564
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565 if (*argp == ')' || *argp == ',' || *argp == NUL)
1566 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001567 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001568 {
1569 ret = FAIL;
1570 break;
1571 }
1572 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001573 // The comma should come right after the argument, but this wasn't
1574 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001575 if (vim9script)
1576 {
1577 if (*argp != ',' && *skipwhite(argp) == ',')
1578 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001579 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001580 ret = FAIL;
1581 break;
1582 }
1583 }
1584 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001585 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001586 if (*argp != ',')
1587 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001588 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1589 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001590 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001591 ret = FAIL;
1592 break;
1593 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001595 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001596 if (*argp == ')')
1597 ++argp;
1598 else
1599 ret = FAIL;
1600
1601 if (ret == OK)
1602 {
1603 int i = 0;
1604
1605 if (get_vim_var_nr(VV_TESTING))
1606 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001607 // Prepare for calling test_garbagecollect_now(), need to know
1608 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609 if (funcargs.ga_itemsize == 0)
1610 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1611 for (i = 0; i < argcount; ++i)
1612 if (ga_grow(&funcargs, 1) == OK)
1613 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1614 &argvars[i];
1615 }
1616
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001617 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618
1619 funcargs.ga_len -= i;
1620 }
1621 else if (!aborting())
1622 {
1623 if (argcount == MAX_FUNC_ARGS)
1624 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1625 else
1626 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1627 }
1628
1629 while (--argcount >= 0)
1630 clear_tv(&argvars[argcount]);
1631
Bram Moolenaar8294d492020-08-10 22:40:56 +02001632 if (in_vim9script())
1633 *arg = argp;
1634 else
1635 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 return ret;
1637}
1638
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639/*
1640 * Return TRUE if "p" starts with "<SID>" or "s:".
1641 * Only works if eval_fname_script() returned non-zero for "p"!
1642 */
1643 static int
1644eval_fname_sid(char_u *p)
1645{
1646 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1647}
1648
1649/*
1650 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1651 * Change <SNR>123_name() to K_SNR 123_name().
1652 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1653 * (slow).
1654 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001655 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001656fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1657{
1658 int llen;
1659 char_u *fname;
1660 int i;
1661
1662 llen = eval_fname_script(name);
1663 if (llen > 0)
1664 {
1665 fname_buf[0] = K_SPECIAL;
1666 fname_buf[1] = KS_EXTRA;
1667 fname_buf[2] = (int)KE_SNR;
1668 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001669 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001670 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001671 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001672 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001673 else
1674 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001675 sprintf((char *)fname_buf + 3, "%ld_",
1676 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001677 i = (int)STRLEN(fname_buf);
1678 }
1679 }
1680 if (i + STRLEN(name + llen) < FLEN_FIXED)
1681 {
1682 STRCPY(fname_buf + i, name + llen);
1683 fname = fname_buf;
1684 }
1685 else
1686 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001687 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001689 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001690 else
1691 {
1692 *tofree = fname;
1693 mch_memmove(fname, fname_buf, (size_t)i);
1694 STRCPY(fname + i, name + llen);
1695 }
1696 }
1697 }
1698 else
1699 fname = name;
1700 return fname;
1701}
1702
1703/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001704 * Find a function "name" in script "sid".
1705 */
1706 static ufunc_T *
1707find_func_with_sid(char_u *name, int sid)
1708{
1709 hashitem_T *hi;
1710 char_u buffer[200];
1711
1712 buffer[0] = K_SPECIAL;
1713 buffer[1] = KS_EXTRA;
1714 buffer[2] = (int)KE_SNR;
1715 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1716 (long)sid, name);
1717 hi = hash_find(&func_hashtab, buffer);
1718 if (!HASHITEM_EMPTY(hi))
1719 return HI2UF(hi);
1720
1721 return NULL;
1722}
1723
1724/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001726 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001727 * Return NULL for unknown function.
1728 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001729 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001730find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001731{
1732 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001733 ufunc_T *func;
1734 imported_T *imported;
1735
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001736 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001737 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001738 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001739 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001740 int find_script_local = in_vim9script()
1741 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001742
Bram Moolenaar95006e32020-08-29 17:47:08 +02001743 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001744 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001745 // Find script-local function before global one.
1746 func = find_func_with_sid(name, current_sctx.sc_sid);
1747 if (func != NULL)
1748 return func;
1749 }
1750
Bram Moolenaarefa94442020-08-08 22:16:00 +02001751 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001752 && name[1] == KS_EXTRA
1753 && name[2] == KE_SNR)
1754 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001755 // Caller changes s: to <SNR>99_name.
1756
1757 after_script = name + 3;
1758 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001759 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001760 ++after_script;
1761 else
1762 after_script = NULL;
1763 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001764 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001765 {
1766 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001767 if (after_script != NULL && sid != current_sctx.sc_sid)
1768 imported = find_imported_in_script(after_script, 0, sid);
1769 else
1770 imported = find_imported(after_script == NULL
1771 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001772 if (imported != NULL && imported->imp_funcname != NULL)
1773 {
1774 hi = hash_find(&func_hashtab, imported->imp_funcname);
1775 if (!HASHITEM_EMPTY(hi))
1776 return HI2UF(hi);
1777 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001778 }
1779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780
Bram Moolenaara26b9702020-04-18 19:53:28 +02001781 hi = hash_find(&func_hashtab,
1782 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783 if (!HASHITEM_EMPTY(hi))
1784 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001785
1786 return NULL;
1787}
1788
1789/*
1790 * Find a function by name, return pointer to it in ufuncs.
1791 * "cctx" is passed in a :def function to find imported functions.
1792 * Return NULL for unknown or dead function.
1793 */
1794 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001795find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001796{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001797 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001798
1799 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1800 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001801 return NULL;
1802}
1803
1804/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001805 * Return TRUE if "ufunc" is a global function.
1806 */
1807 int
1808func_is_global(ufunc_T *ufunc)
1809{
1810 return ufunc->uf_name[0] != K_SPECIAL;
1811}
1812
1813/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001814 * Copy the function name of "fp" to buffer "buf".
1815 * "buf" must be able to hold the function name plus three bytes.
1816 * Takes care of script-local function names.
1817 */
1818 static void
1819cat_func_name(char_u *buf, ufunc_T *fp)
1820{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001821 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 {
1823 STRCPY(buf, "<SNR>");
1824 STRCAT(buf, fp->uf_name + 3);
1825 }
1826 else
1827 STRCPY(buf, fp->uf_name);
1828}
1829
1830/*
1831 * Add a number variable "name" to dict "dp" with value "nr".
1832 */
1833 static void
1834add_nr_var(
1835 dict_T *dp,
1836 dictitem_T *v,
1837 char *name,
1838 varnumber_T nr)
1839{
1840 STRCPY(v->di_key, name);
1841 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1842 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1843 v->di_tv.v_type = VAR_NUMBER;
1844 v->di_tv.v_lock = VAR_FIXED;
1845 v->di_tv.vval.v_number = nr;
1846}
1847
1848/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001849 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001851 static void
1852free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001854 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001855
1856 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1857 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001858 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001859
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001860 // When garbage collecting a funccall_T may be freed before the
1861 // function that references it, clear its uf_scoped field.
1862 // The function may have been redefined and point to another
1863 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001864 if (fp != NULL && fp->uf_scoped == fc)
1865 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001866 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001867 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001869 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001870 vim_free(fc);
1871}
1872
1873/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001874 * Free "fc" and what it contains.
1875 * Can be called only when "fc" is kept beyond the period of it called,
1876 * i.e. after cleanup_function_call(fc).
1877 */
1878 static void
1879free_funccal_contents(funccall_T *fc)
1880{
1881 listitem_T *li;
1882
1883 // Free all l: variables.
1884 vars_clear(&fc->l_vars.dv_hashtab);
1885
1886 // Free all a: variables.
1887 vars_clear(&fc->l_avars.dv_hashtab);
1888
1889 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001890 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001891 clear_tv(&li->li_tv);
1892
1893 free_funccal(fc);
1894}
1895
1896/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001897 * Handle the last part of returning from a function: free the local hashtable.
1898 * Unless it is still in use by a closure.
1899 */
1900 static void
1901cleanup_function_call(funccall_T *fc)
1902{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001903 int may_free_fc = fc->fc_refcount <= 0;
1904 int free_fc = TRUE;
1905
Bram Moolenaar6914c642017-04-01 21:21:30 +02001906 current_funccal = fc->caller;
1907
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001908 // Free all l: variables if not referred.
1909 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1910 vars_clear(&fc->l_vars.dv_hashtab);
1911 else
1912 free_fc = FALSE;
1913
1914 // If the a:000 list and the l: and a: dicts are not referenced and
1915 // there is no closure using it, we can free the funccall_T and what's
1916 // in it.
1917 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1918 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001919 else
1920 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001921 int todo;
1922 hashitem_T *hi;
1923 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001924
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001925 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001926
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001927 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001928 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1929 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1930 {
1931 if (!HASHITEM_EMPTY(hi))
1932 {
1933 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001934 di = HI2DI(hi);
1935 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001936 }
1937 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001938 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001939
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001940 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1941 fc->l_varlist.lv_first = NULL;
1942 else
1943 {
1944 listitem_T *li;
1945
1946 free_fc = FALSE;
1947
1948 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001949 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001950 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001951 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001952
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001953 if (free_fc)
1954 free_funccal(fc);
1955 else
1956 {
1957 static int made_copy = 0;
1958
1959 // "fc" is still in use. This can happen when returning "a:000",
1960 // assigning "l:" to a global variable or defining a closure.
1961 // Link "fc" in the list for garbage collection later.
1962 fc->caller = previous_funccal;
1963 previous_funccal = fc;
1964
1965 if (want_garbage_collect)
1966 // If garbage collector is ready, clear count.
1967 made_copy = 0;
1968 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001969 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001970 // We have made a lot of copies, worth 4 Mbyte. This can happen
1971 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001972 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001973 // too much memory.
1974 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001975 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001976 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001977 }
1978}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001979
1980/*
1981 * There are two kinds of function names:
1982 * 1. ordinary names, function defined with :function or :def
1983 * 2. numbered functions and lambdas
1984 * For the first we only count the name stored in func_hashtab as a reference,
1985 * using function() does not count as a reference, because the function is
1986 * looked up by name.
1987 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001988 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001989func_name_refcount(char_u *name)
1990{
1991 return isdigit(*name) || *name == '<';
1992}
1993
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001994/*
1995 * Unreference "fc": decrement the reference count and free it when it
1996 * becomes zero. "fp" is detached from "fc".
1997 * When "force" is TRUE we are exiting.
1998 */
1999 static void
2000funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2001{
2002 funccall_T **pfc;
2003 int i;
2004
2005 if (fc == NULL)
2006 return;
2007
2008 if (--fc->fc_refcount <= 0 && (force || (
2009 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2010 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2011 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2012 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2013 {
2014 if (fc == *pfc)
2015 {
2016 *pfc = fc->caller;
2017 free_funccal_contents(fc);
2018 return;
2019 }
2020 }
2021 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2022 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2023 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2024}
2025
2026/*
2027 * Remove the function from the function hashtable. If the function was
2028 * deleted while it still has references this was already done.
2029 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2030 */
2031 static int
2032func_remove(ufunc_T *fp)
2033{
2034 hashitem_T *hi;
2035
2036 // Return if it was already virtually deleted.
2037 if (fp->uf_flags & FC_DEAD)
2038 return FALSE;
2039
2040 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2041 if (!HASHITEM_EMPTY(hi))
2042 {
2043 // When there is a def-function index do not actually remove the
2044 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002045 // Do remove it when it's a copy.
2046 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002047 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002048 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002049 return FALSE;
2050 }
2051 hash_remove(&func_hashtab, hi);
2052 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002053 return TRUE;
2054 }
2055 return FALSE;
2056}
2057
2058 static void
2059func_clear_items(ufunc_T *fp)
2060{
2061 ga_clear_strings(&(fp->uf_args));
2062 ga_clear_strings(&(fp->uf_def_args));
2063 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002064 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002065 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002066 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002067 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002068
2069 // Increment the refcount of this function to avoid it being freed
2070 // recursively when the partial is freed.
2071 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002072 partial_unref(fp->uf_partial);
2073 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002074 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002075
2076#ifdef FEAT_LUA
2077 if (fp->uf_cb_free != NULL)
2078 {
2079 fp->uf_cb_free(fp->uf_cb_state);
2080 fp->uf_cb_free = NULL;
2081 }
2082
2083 fp->uf_cb_state = NULL;
2084 fp->uf_cb = NULL;
2085#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002086#ifdef FEAT_PROFILE
2087 VIM_CLEAR(fp->uf_tml_count);
2088 VIM_CLEAR(fp->uf_tml_total);
2089 VIM_CLEAR(fp->uf_tml_self);
2090#endif
2091}
2092
2093/*
2094 * Free all things that a function contains. Does not free the function
2095 * itself, use func_free() for that.
2096 * When "force" is TRUE we are exiting.
2097 */
2098 static void
2099func_clear(ufunc_T *fp, int force)
2100{
2101 if (fp->uf_cleared)
2102 return;
2103 fp->uf_cleared = TRUE;
2104
2105 // clear this function
2106 func_clear_items(fp);
2107 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002108 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002109}
2110
2111/*
2112 * Free a function and remove it from the list of functions. Does not free
2113 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002114 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002115 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002116 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002117 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002118func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002119{
2120 // Only remove it when not done already, otherwise we would remove a newer
2121 // version of the function with the same name.
2122 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2123 func_remove(fp);
2124
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002125 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002126 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002127 if (fp->uf_dfunc_idx > 0)
2128 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002129 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002130 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002131 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002132 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002133 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002134}
2135
2136/*
2137 * Free all things that a function contains and free the function itself.
2138 * When "force" is TRUE we are exiting.
2139 */
2140 static void
2141func_clear_free(ufunc_T *fp, int force)
2142{
2143 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002144 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2145 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002146 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002147 else
2148 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002149}
2150
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002151/*
2152 * Copy already defined function "lambda" to a new function with name "global".
2153 * This is for when a compiled function defines a global function.
2154 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002155 int
2156copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002157{
2158 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002159 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002160
2161 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002162 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002163 semsg(_(e_lambda_function_not_found_str), lambda);
2164 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002165 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002166
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002167 fp = find_func(global, TRUE, NULL);
2168 if (fp != NULL)
2169 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002170 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002171 semsg(_(e_funcexts), global);
2172 return FAIL;
2173 }
2174
2175 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2176 if (fp == NULL)
2177 return FAIL;
2178
2179 fp->uf_varargs = ufunc->uf_varargs;
2180 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2181 fp->uf_def_status = ufunc->uf_def_status;
2182 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2183 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2184 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2185 == FAIL
2186 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2187 goto failed;
2188
2189 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2190 : vim_strsave(ufunc->uf_name_exp);
2191 if (ufunc->uf_arg_types != NULL)
2192 {
2193 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2194 if (fp->uf_arg_types == NULL)
2195 goto failed;
2196 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2197 sizeof(type_T *) * fp->uf_args.ga_len);
2198 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002199 if (ufunc->uf_va_name != NULL)
2200 {
2201 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2202 if (fp->uf_va_name == NULL)
2203 goto failed;
2204 }
2205 fp->uf_ret_type = ufunc->uf_ret_type;
2206
2207 fp->uf_refcount = 1;
2208 STRCPY(fp->uf_name, global);
2209 hash_add(&func_hashtab, UF2HIKEY(fp));
2210
2211 // the referenced dfunc_T is now used one more time
2212 link_def_function(fp);
2213
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002214 // Create a partial to store the context of the function where it was
2215 // instantiated. Only needs to be done once. Do this on the original
2216 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002217 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2218 {
2219 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2220
2221 if (pt == NULL)
2222 goto failed;
2223 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002224 {
2225 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002226 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002227 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002228 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002229 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002230 }
2231
2232 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002233
2234failed:
2235 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002236 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002237}
2238
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002239static int funcdepth = 0;
2240
2241/*
2242 * Increment the function call depth count.
2243 * Return FAIL when going over 'maxfuncdepth'.
2244 * Otherwise return OK, must call funcdepth_decrement() later!
2245 */
2246 int
2247funcdepth_increment(void)
2248{
2249 if (funcdepth >= p_mfd)
2250 {
2251 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2252 return FAIL;
2253 }
2254 ++funcdepth;
2255 return OK;
2256}
2257
2258 void
2259funcdepth_decrement(void)
2260{
2261 --funcdepth;
2262}
2263
2264/*
2265 * Get the current function call depth.
2266 */
2267 int
2268funcdepth_get(void)
2269{
2270 return funcdepth;
2271}
2272
2273/*
2274 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002275 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002276 * times as funcdepth_increment().
2277 */
2278 void
2279funcdepth_restore(int depth)
2280{
2281 funcdepth = depth;
2282}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002283
2284/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285 * Call a user function.
2286 */
2287 static void
2288call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002289 ufunc_T *fp, // pointer to function
2290 int argcount, // nr of args
2291 typval_T *argvars, // arguments
2292 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002293 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002294 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002296 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002297 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298 funccall_T *fc;
2299 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002300 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002302 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002303 int i;
2304 int ai;
2305 int islambda = FALSE;
2306 char_u numbuf[NUMBUFLEN];
2307 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002308 typval_T *tv_to_free[MAX_FUNC_ARGS];
2309 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002310#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002311 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002312#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002313 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002314
Bram Moolenaarb2049902021-01-24 12:53:53 +01002315#ifdef FEAT_PROFILE
2316 CLEAR_FIELD(profile_info);
2317#endif
2318
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002319 // If depth of calling is getting too high, don't execute the function.
2320 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002321 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002322 rettv->v_type = VAR_NUMBER;
2323 rettv->vval.v_number = -1;
2324 return;
2325 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002326
Bram Moolenaare38eab22019-12-05 21:50:01 +01002327 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002328
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002329 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002330 if (fc == NULL)
2331 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332 fc->caller = current_funccal;
2333 current_funccal = fc;
2334 fc->func = fp;
2335 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002337 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002338 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2339 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002340 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002341 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002342 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002344 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002345 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002346#ifdef FEAT_PROFILE
2347 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2348#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002349 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002350#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002351 if (do_profiling == PROF_YES)
2352 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002353#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002354 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002355 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002356#ifdef FEAT_PROFILE
2357 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002358 || (caller != NULL && caller->uf_profiling)))
2359 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002360#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002361 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002362 free_funccal(fc);
2363 return;
2364 }
2365
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002366 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2367 islambda = TRUE;
2368
2369 /*
2370 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2371 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2372 * each argument variable and saves a lot of time.
2373 */
2374 /*
2375 * Init l: variables.
2376 */
2377 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2378 if (selfdict != NULL)
2379 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002380 // Set l:self to "selfdict". Use "name" to avoid a warning from
2381 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382 v = &fc->fixvar[fixvar_idx++].var;
2383 name = v->di_key;
2384 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002385 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002386 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2387 v->di_tv.v_type = VAR_DICT;
2388 v->di_tv.v_lock = 0;
2389 v->di_tv.vval.v_dict = selfdict;
2390 ++selfdict->dv_refcount;
2391 }
2392
2393 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002394 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002395 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396 * Set a:000 to a list with room for the "..." arguments.
2397 */
2398 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002399 if ((fp->uf_flags & FC_NOARGS) == 0)
2400 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002401 (varnumber_T)(argcount >= fp->uf_args.ga_len
2402 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002403 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002404 if ((fp->uf_flags & FC_NOARGS) == 0)
2405 {
2406 // Use "name" to avoid a warning from some compiler that checks the
2407 // destination size.
2408 v = &fc->fixvar[fixvar_idx++].var;
2409 name = v->di_key;
2410 STRCPY(name, "000");
2411 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2412 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2413 v->di_tv.v_type = VAR_LIST;
2414 v->di_tv.v_lock = VAR_FIXED;
2415 v->di_tv.vval.v_list = &fc->l_varlist;
2416 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002417 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2419 fc->l_varlist.lv_lock = VAR_FIXED;
2420
2421 /*
2422 * Set a:firstline to "firstline" and a:lastline to "lastline".
2423 * Set a:name to named arguments.
2424 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002425 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002427 if ((fp->uf_flags & FC_NOARGS) == 0)
2428 {
2429 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002430 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002431 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002432 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002433 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002434 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002435 {
2436 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002437 typval_T def_rettv;
2438 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439
2440 ai = i - fp->uf_args.ga_len;
2441 if (ai < 0)
2442 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002443 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444 name = FUNCARG(fp, i);
2445 if (islambda)
2446 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002447
2448 // evaluate named argument default expression
2449 isdefault = ai + fp->uf_def_args.ga_len >= 0
2450 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2451 && argvars[i].vval.v_number == VVAL_NONE));
2452 if (isdefault)
2453 {
2454 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002455
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002456 def_rettv.v_type = VAR_NUMBER;
2457 def_rettv.vval.v_number = -1;
2458
2459 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2460 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002461 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002462 {
2463 default_arg_err = 1;
2464 break;
2465 }
2466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 }
2468 else
2469 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002470 if ((fp->uf_flags & FC_NOARGS) != 0)
2471 // Bail out if no a: arguments used (in lambda).
2472 break;
2473
Bram Moolenaare38eab22019-12-05 21:50:01 +01002474 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 sprintf((char *)numbuf, "%d", ai + 1);
2476 name = numbuf;
2477 }
2478 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2479 {
2480 v = &fc->fixvar[fixvar_idx++].var;
2481 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002482 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483 }
2484 else
2485 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002486 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 if (v == NULL)
2488 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002489 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002490 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002492 // Note: the values are copied directly to avoid alloc/free.
2493 // "argvars" must have VAR_FIXED for v_lock.
2494 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 v->di_tv.v_lock = VAR_FIXED;
2496
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002497 if (isdefault)
2498 // Need to free this later, no matter where it's stored.
2499 tv_to_free[tv_to_free_len++] = &v->di_tv;
2500
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501 if (addlocal)
2502 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002503 // Named arguments should be accessed without the "a:" prefix in
2504 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002505 copy_tv(&v->di_tv, &v->di_tv);
2506 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002508 else
2509 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510
2511 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2512 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002513 listitem_T *li = &fc->l_listitems[ai];
2514
2515 li->li_tv = argvars[i];
2516 li->li_tv.v_lock = VAR_FIXED;
2517 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 }
2519 }
2520
Bram Moolenaare38eab22019-12-05 21:50:01 +01002521 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002523
2524 if (fp->uf_flags & FC_SANDBOX)
2525 {
2526 using_sandbox = TRUE;
2527 ++sandbox;
2528 }
2529
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002530 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002531 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002532 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002534 ++no_wait_return;
2535 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002537 smsg(_("calling %s"), SOURCING_NAME);
2538 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002540 char_u buf[MSG_BUF_LEN];
2541 char_u numbuf2[NUMBUFLEN];
2542 char_u *tofree;
2543 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002545 msg_puts("(");
2546 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002548 if (i > 0)
2549 msg_puts(", ");
2550 if (argvars[i].v_type == VAR_NUMBER)
2551 msg_outnum((long)argvars[i].vval.v_number);
2552 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002554 // Do not want errors such as E724 here.
2555 ++emsg_off;
2556 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2557 --emsg_off;
2558 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002560 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002562 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2563 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002565 msg_puts((char *)s);
2566 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002567 }
2568 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002570 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002572 msg_puts("\n"); // don't overwrite this either
2573
2574 verbose_leave_scroll();
2575 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576 }
2577#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002578 if (do_profiling == PROF_YES)
2579 profile_may_start_func(&profile_info, fp,
2580 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002581#endif
2582
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002583 save_current_sctx = current_sctx;
2584 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585 save_did_emsg = did_emsg;
2586 did_emsg = FALSE;
2587
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002588 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2589 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002590 else if (islambda)
2591 {
2592 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2593
2594 // A Lambda always has the command "return {expr}". It is much faster
2595 // to evaluate {expr} directly.
2596 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002597 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002598 --ex_nesting_level;
2599 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002600 else
2601 // call do_cmdline() to execute the lines
2602 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2604
2605 --RedrawingDisabled;
2606
Bram Moolenaare38eab22019-12-05 21:50:01 +01002607 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2609 {
2610 clear_tv(rettv);
2611 rettv->v_type = VAR_NUMBER;
2612 rettv->vval.v_number = -1;
2613 }
2614
2615#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002616 if (do_profiling == PROF_YES)
2617 {
2618 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2619
2620 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2621 profile_may_end_func(&profile_info, fp, caller);
2622 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623#endif
2624
Bram Moolenaare38eab22019-12-05 21:50:01 +01002625 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 if (p_verbose >= 12)
2627 {
2628 ++no_wait_return;
2629 verbose_enter_scroll();
2630
2631 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002632 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002634 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002635 (long)fc->rettv->vval.v_number);
2636 else
2637 {
2638 char_u buf[MSG_BUF_LEN];
2639 char_u numbuf2[NUMBUFLEN];
2640 char_u *tofree;
2641 char_u *s;
2642
Bram Moolenaare38eab22019-12-05 21:50:01 +01002643 // The value may be very long. Skip the middle part, so that we
2644 // have some idea how it starts and ends. smsg() would always
2645 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 ++emsg_off;
2647 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2648 --emsg_off;
2649 if (s != NULL)
2650 {
2651 if (vim_strsize(s) > MSG_BUF_CLEN)
2652 {
2653 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2654 s = buf;
2655 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002656 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 vim_free(tofree);
2658 }
2659 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002660 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661
2662 verbose_leave_scroll();
2663 --no_wait_return;
2664 }
2665
Bram Moolenaare31ee862020-01-07 20:59:34 +01002666 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002667 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002668 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002669#ifdef FEAT_PROFILE
2670 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002671 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002673 if (using_sandbox)
2674 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002676 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 {
2678 ++no_wait_return;
2679 verbose_enter_scroll();
2680
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002681 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002682 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683
2684 verbose_leave_scroll();
2685 --no_wait_return;
2686 }
2687
2688 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002689 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002690 for (i = 0; i < tv_to_free_len; ++i)
2691 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002692 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693}
2694
2695/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002696 * Check the argument count for user function "fp".
2697 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2698 */
2699 int
2700check_user_func_argcount(ufunc_T *fp, int argcount)
2701{
2702 int regular_args = fp->uf_args.ga_len;
2703
2704 if (argcount < regular_args - fp->uf_def_args.ga_len)
2705 return FCERR_TOOFEW;
2706 else if (!has_varargs(fp) && argcount > regular_args)
2707 return FCERR_TOOMANY;
2708 return FCERR_UNKNOWN;
2709}
2710
2711/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002712 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002713 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002714 int
2715call_user_func_check(
2716 ufunc_T *fp,
2717 int argcount,
2718 typval_T *argvars,
2719 typval_T *rettv,
2720 funcexe_T *funcexe,
2721 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002722{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002723 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002724
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002725 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2726 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002727 error = check_user_func_argcount(fp, argcount);
2728 if (error != FCERR_UNKNOWN)
2729 return error;
2730 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002731 error = FCERR_DICT;
2732 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002733 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002734 int did_save_redo = FALSE;
2735 save_redo_T save_redo;
2736
2737 /*
2738 * Call the user function.
2739 * Save and restore search patterns, script variables and
2740 * redo buffer.
2741 */
2742 save_search_patterns();
2743 if (!ins_compl_active())
2744 {
2745 saveRedobuff(&save_redo);
2746 did_save_redo = TRUE;
2747 }
2748 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002749 call_user_func(fp, argcount, argvars, rettv, funcexe,
2750 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002751 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2752 // Function was unreferenced while being used, free it now.
2753 func_clear_free(fp, FALSE);
2754 if (did_save_redo)
2755 restoreRedobuff(&save_redo);
2756 restore_search_patterns();
2757 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002758 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002759 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002760}
2761
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002762static funccal_entry_T *funccal_stack = NULL;
2763
2764/*
2765 * Save the current function call pointer, and set it to NULL.
2766 * Used when executing autocommands and for ":source".
2767 */
2768 void
2769save_funccal(funccal_entry_T *entry)
2770{
2771 entry->top_funccal = current_funccal;
2772 entry->next = funccal_stack;
2773 funccal_stack = entry;
2774 current_funccal = NULL;
2775}
2776
2777 void
2778restore_funccal(void)
2779{
2780 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002781 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002782 else
2783 {
2784 current_funccal = funccal_stack->top_funccal;
2785 funccal_stack = funccal_stack->next;
2786 }
2787}
2788
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002789 funccall_T *
2790get_current_funccal(void)
2791{
2792 return current_funccal;
2793}
2794
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002795/*
2796 * Mark all functions of script "sid" as deleted.
2797 */
2798 void
2799delete_script_functions(int sid)
2800{
2801 hashitem_T *hi;
2802 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002803 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002804 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002805 size_t len;
2806
2807 buf[0] = K_SPECIAL;
2808 buf[1] = KS_EXTRA;
2809 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002810 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002811 len = STRLEN(buf);
2812
Bram Moolenaarce658352020-07-31 23:47:12 +02002813 while (todo > 0)
2814 {
2815 todo = func_hashtab.ht_used;
2816 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2817 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002818 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002819 fp = HI2UF(hi);
2820 if (STRNCMP(fp->uf_name, buf, len) == 0)
2821 {
2822 int changed = func_hashtab.ht_changed;
2823
2824 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002825
2826 if (fp->uf_calls > 0)
2827 {
2828 // Function is executing, don't free it but do remove
2829 // it from the hashtable.
2830 if (func_remove(fp))
2831 fp->uf_refcount--;
2832 }
2833 else
2834 {
2835 func_clear(fp, TRUE);
2836 // When clearing a function another function can be
2837 // cleared as a side effect. When that happens start
2838 // over.
2839 if (changed != func_hashtab.ht_changed)
2840 break;
2841 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002842 }
2843 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002844 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002845 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002846}
2847
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848#if defined(EXITFREE) || defined(PROTO)
2849 void
2850free_all_functions(void)
2851{
2852 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002853 ufunc_T *fp;
2854 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002855 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002856 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857
Bram Moolenaare38eab22019-12-05 21:50:01 +01002858 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002859 while (current_funccal != NULL)
2860 {
2861 clear_tv(current_funccal->rettv);
2862 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002863 if (current_funccal == NULL && funccal_stack != NULL)
2864 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002865 }
2866
Bram Moolenaare38eab22019-12-05 21:50:01 +01002867 // First clear what the functions contain. Since this may lower the
2868 // reference count of a function, it may also free a function and change
2869 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002870 while (todo > 0)
2871 {
2872 todo = func_hashtab.ht_used;
2873 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2874 if (!HASHITEM_EMPTY(hi))
2875 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002876 // clear the def function index now
2877 fp = HI2UF(hi);
2878 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002879 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002880
Bram Moolenaare38eab22019-12-05 21:50:01 +01002881 // Only free functions that are not refcounted, those are
2882 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002883 if (func_name_refcount(fp->uf_name))
2884 ++skipped;
2885 else
2886 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002887 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002888 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002889 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002890 {
2891 skipped = 0;
2892 break;
2893 }
2894 }
2895 --todo;
2896 }
2897 }
2898
Bram Moolenaare38eab22019-12-05 21:50:01 +01002899 // Now actually free the functions. Need to start all over every time,
2900 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002901 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002902 while (func_hashtab.ht_used > skipped)
2903 {
2904 todo = func_hashtab.ht_used;
2905 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 if (!HASHITEM_EMPTY(hi))
2907 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002908 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002909 // Only free functions that are not refcounted, those are
2910 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002911 fp = HI2UF(hi);
2912 if (func_name_refcount(fp->uf_name))
2913 ++skipped;
2914 else
2915 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002916 if (func_free(fp, FALSE) == OK)
2917 {
2918 skipped = 0;
2919 break;
2920 }
2921 // did not actually free it
2922 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002923 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002925 }
2926 if (skipped == 0)
2927 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002928
2929 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930}
2931#endif
2932
2933/*
2934 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002935 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936 * "len" is the length of "name", or -1 for NUL terminated.
2937 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002938 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002939builtin_function(char_u *name, int len)
2940{
2941 char_u *p;
2942
Bram Moolenaara26b9702020-04-18 19:53:28 +02002943 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002944 return FALSE;
2945 p = vim_strchr(name, AUTOLOAD_CHAR);
2946 return p == NULL || (len > 0 && p > name + len);
2947}
2948
2949 int
2950func_call(
2951 char_u *name,
2952 typval_T *args,
2953 partial_T *partial,
2954 dict_T *selfdict,
2955 typval_T *rettv)
2956{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002957 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002958 listitem_T *item;
2959 typval_T argv[MAX_FUNC_ARGS + 1];
2960 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961 int r = 0;
2962
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002963 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002964 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 {
2966 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2967 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002968 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969 break;
2970 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002971 // Make a copy of each argument. This is needed to be able to set
2972 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002973 copy_tv(&item->li_tv, &argv[argc++]);
2974 }
2975
2976 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002977 {
2978 funcexe_T funcexe;
2979
Bram Moolenaara80faa82020-04-12 19:37:17 +02002980 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002981 funcexe.firstline = curwin->w_cursor.lnum;
2982 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002983 funcexe.evaluate = TRUE;
2984 funcexe.partial = partial;
2985 funcexe.selfdict = selfdict;
2986 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2987 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988
Bram Moolenaare38eab22019-12-05 21:50:01 +01002989 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002990 while (argc > 0)
2991 clear_tv(&argv[--argc]);
2992
2993 return r;
2994}
2995
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002996static int callback_depth = 0;
2997
2998 int
2999get_callback_depth(void)
3000{
3001 return callback_depth;
3002}
3003
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003005 * Invoke call_func() with a callback.
3006 */
3007 int
3008call_callback(
3009 callback_T *callback,
3010 int len, // length of "name" or -1 to use strlen()
3011 typval_T *rettv, // return value goes here
3012 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003013 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003014 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003015{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003016 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003017 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003018
Bram Moolenaara80faa82020-04-12 19:37:17 +02003019 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003020 funcexe.evaluate = TRUE;
3021 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003022 ++callback_depth;
3023 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3024 --callback_depth;
3025 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003026}
3027
3028/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003029 * Give an error message for the result of a function.
3030 * Nothing if "error" is FCERR_NONE.
3031 */
3032 void
3033user_func_error(int error, char_u *name)
3034{
3035 switch (error)
3036 {
3037 case FCERR_UNKNOWN:
3038 emsg_funcname(e_unknownfunc, name);
3039 break;
3040 case FCERR_NOTMETHOD:
3041 emsg_funcname(
3042 N_("E276: Cannot use function as a method: %s"), name);
3043 break;
3044 case FCERR_DELETED:
3045 emsg_funcname(N_(e_func_deleted), name);
3046 break;
3047 case FCERR_TOOMANY:
3048 emsg_funcname((char *)e_toomanyarg, name);
3049 break;
3050 case FCERR_TOOFEW:
3051 emsg_funcname((char *)e_toofewarg, name);
3052 break;
3053 case FCERR_SCRIPT:
3054 emsg_funcname(
3055 N_("E120: Using <SID> not in a script context: %s"), name);
3056 break;
3057 case FCERR_DICT:
3058 emsg_funcname(
3059 N_("E725: Calling dict function without Dictionary: %s"),
3060 name);
3061 break;
3062 }
3063}
3064
3065/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003067 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 * Return FAIL when the function can't be called, OK otherwise.
3069 * Also returns OK when an error was encountered while executing the function.
3070 */
3071 int
3072call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003073 char_u *funcname, // name of the function
3074 int len, // length of "name" or -1 to use strlen()
3075 typval_T *rettv, // return value goes here
3076 int argcount_in, // number of "argvars"
3077 typval_T *argvars_in, // vars for arguments, must have "argcount"
3078 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003079 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003080{
3081 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003082 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003083 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003084 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085 char_u fname_buf[FLEN_FIXED + 1];
3086 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003087 char_u *fname = NULL;
3088 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003089 int argcount = argcount_in;
3090 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003091 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003092 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3093 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003094 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003095 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003096 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003097
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003098 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3099 // even when call_func() returns FAIL.
3100 rettv->v_type = VAR_UNKNOWN;
3101
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003102 if (partial != NULL)
3103 fp = partial->pt_func;
3104 if (fp == NULL)
3105 {
3106 // Make a copy of the name, if it comes from a funcref variable it
3107 // could be changed or deleted in the called function.
3108 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3109 if (name == NULL)
3110 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003112 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3113 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003114
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003115 if (funcexe->doesrange != NULL)
3116 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003117
3118 if (partial != NULL)
3119 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003120 // When the function has a partial with a dict and there is a dict
3121 // argument, use the dict argument. That is backwards compatible.
3122 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003123 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003125 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126 {
3127 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003128 {
3129 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3130 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003131 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003132 goto theend;
3133 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003135 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136 for (i = 0; i < argcount_in; ++i)
3137 argv[i + argv_clear] = argvars_in[i];
3138 argvars = argv;
3139 argcount = partial->pt_argc + argcount_in;
3140 }
3141 }
3142
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003143 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3144 {
3145 // Check that the argument types are OK for the types of the funcref.
3146 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003147 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003148 error = FCERR_OTHER;
3149 }
3150
Bram Moolenaaref140542019-12-31 21:27:13 +01003151 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 {
3153 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003154 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003155
Bram Moolenaar333894b2020-08-01 18:53:07 +02003156 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003157 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003158 {
3159 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003161 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162
Bram Moolenaare38eab22019-12-05 21:50:01 +01003163 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003165 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003166
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003167 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003168 {
3169 /*
3170 * User defined function.
3171 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003172 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003173 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174
Bram Moolenaare38eab22019-12-05 21:50:01 +01003175 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003176 if (fp == NULL
3177 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003178 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179 && !aborting())
3180 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003181 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003182 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003183 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003184 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003185 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3186 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003187 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003188 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003189 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003190 if (fp == NULL)
3191 {
3192 char_u *p = untrans_function_name(rfname);
3193
3194 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003195 // Don't do this if the name starts with "s:".
3196 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003197 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003199
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003200 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003201 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003202#ifdef FEAT_LUA
3203 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3204 {
3205 cfunc_T cb = fp->uf_cb;
3206
3207 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3208 }
3209#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003210 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003212 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003213 // postponed filling in the arguments, do it now
3214 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003215 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003216
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003217 if (funcexe->basetv != NULL)
3218 {
3219 // Method call: base->Method()
3220 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3221 argv[0] = *funcexe->basetv;
3222 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003223 argvars = argv;
3224 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003225 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003226
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003227 error = call_user_func_check(fp, argcount, argvars, rettv,
3228 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 }
3230 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003231 else if (funcexe->basetv != NULL)
3232 {
3233 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003234 * expr->method(): Find the method name in the table, call its
3235 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003236 */
3237 error = call_internal_method(fname, argcount, argvars, rettv,
3238 funcexe->basetv);
3239 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003240 else
3241 {
3242 /*
3243 * Find the function name in the table, call its implementation.
3244 */
3245 error = call_internal_func(fname, argcount, argvars, rettv);
3246 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003247
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 /*
3249 * The function call (or "FuncUndefined" autocommand sequence) might
3250 * have been aborted by an error, an interrupt, or an explicitly thrown
3251 * exception that has not been caught so far. This situation can be
3252 * tested for by calling aborting(). For an error in an internal
3253 * function or for the "E132" error in call_user_func(), however, the
3254 * throw point at which the "force_abort" flag (temporarily reset by
3255 * emsg()) is normally updated has not been reached yet. We need to
3256 * update that flag first to make aborting() reliable.
3257 */
3258 update_force_abort();
3259 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003260 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 ret = OK;
3262
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003263theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264 /*
3265 * Report an error unless the argument evaluation or function call has been
3266 * cancelled due to an aborting error, an interrupt, or an exception.
3267 */
3268 if (!aborting())
3269 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003270 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271 }
3272
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003273 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003275 clear_tv(&argv[--argv_clear + argv_base]);
3276
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 vim_free(tofree);
3278 vim_free(name);
3279
3280 return ret;
3281}
3282
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003283 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003284printable_func_name(ufunc_T *fp)
3285{
3286 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3287}
3288
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003290 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003291 */
3292 static void
3293list_func_head(ufunc_T *fp, int indent)
3294{
3295 int j;
3296
3297 msg_start();
3298 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003299 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003300 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003301 msg_puts("def ");
3302 else
3303 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003304 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003305 msg_putchar('(');
3306 for (j = 0; j < fp->uf_args.ga_len; ++j)
3307 {
3308 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003309 msg_puts(", ");
3310 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003311 if (fp->uf_arg_types != NULL)
3312 {
3313 char *tofree;
3314
3315 msg_puts(": ");
3316 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3317 vim_free(tofree);
3318 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003319 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3320 {
3321 msg_puts(" = ");
3322 msg_puts(((char **)(fp->uf_def_args.ga_data))
3323 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3324 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325 }
3326 if (fp->uf_varargs)
3327 {
3328 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003329 msg_puts(", ");
3330 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003332 if (fp->uf_va_name != NULL)
3333 {
3334 if (j)
3335 msg_puts(", ");
3336 msg_puts("...");
3337 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003338 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003339 {
3340 char *tofree;
3341
3342 msg_puts(": ");
3343 msg_puts(type_name(fp->uf_va_type, &tofree));
3344 vim_free(tofree);
3345 }
3346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003348
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003349 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003350 {
3351 if (fp->uf_ret_type != &t_void)
3352 {
3353 char *tofree;
3354
3355 msg_puts(": ");
3356 msg_puts(type_name(fp->uf_ret_type, &tofree));
3357 vim_free(tofree);
3358 }
3359 }
3360 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003361 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003363 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003365 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003366 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003367 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 msg_clr_eos();
3369 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003370 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371}
3372
3373/*
3374 * Get a function name, translating "<SID>" and "<SNR>".
3375 * Also handles a Funcref in a List or Dictionary.
3376 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003377 * Set "*is_global" to TRUE when the function must be global, unless
3378 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003379 * flags:
3380 * TFN_INT: internal function name OK
3381 * TFN_QUIET: be quiet
3382 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003383 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 * Advances "pp" to just after the function name (if no error).
3385 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003386 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387trans_function_name(
3388 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003389 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003390 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003392 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003393 partial_T **partial, // return: partial of a FuncRef
3394 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395{
3396 char_u *name = NULL;
3397 char_u *start;
3398 char_u *end;
3399 int lead;
3400 char_u sid_buf[20];
3401 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003402 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003404 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003405 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003406
3407 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003408 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 start = *pp;
3410
Bram Moolenaare38eab22019-12-05 21:50:01 +01003411 // Check for hard coded <SNR>: already translated function ID (from a user
3412 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003413 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3414 && (*pp)[2] == (int)KE_SNR)
3415 {
3416 *pp += 3;
3417 len = get_id_len(pp) + 3;
3418 return vim_strnsave(start, len);
3419 }
3420
Bram Moolenaare38eab22019-12-05 21:50:01 +01003421 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3422 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423 lead = eval_fname_script(start);
3424 if (lead > 2)
3425 start += lead;
3426
Bram Moolenaare38eab22019-12-05 21:50:01 +01003427 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003428 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 lead > 2 ? 0 : FNE_CHECK_START);
3430 if (end == start)
3431 {
3432 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003433 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 goto theend;
3435 }
3436 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3437 {
3438 /*
3439 * Report an invalid expression in braces, unless the expression
3440 * evaluation has been cancelled due to an aborting error, an
3441 * interrupt, or an exception.
3442 */
3443 if (!aborting())
3444 {
3445 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003446 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 }
3448 else
3449 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3450 goto theend;
3451 }
3452
3453 if (lv.ll_tv != NULL)
3454 {
3455 if (fdp != NULL)
3456 {
3457 fdp->fd_dict = lv.ll_dict;
3458 fdp->fd_newkey = lv.ll_newkey;
3459 lv.ll_newkey = NULL;
3460 fdp->fd_di = lv.ll_di;
3461 }
3462 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3463 {
3464 name = vim_strsave(lv.ll_tv->vval.v_string);
3465 *pp = end;
3466 }
3467 else if (lv.ll_tv->v_type == VAR_PARTIAL
3468 && lv.ll_tv->vval.v_partial != NULL)
3469 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003470 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 *pp = end;
3472 if (partial != NULL)
3473 *partial = lv.ll_tv->vval.v_partial;
3474 }
3475 else
3476 {
3477 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3478 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003479 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480 else
3481 *pp = end;
3482 name = NULL;
3483 }
3484 goto theend;
3485 }
3486
3487 if (lv.ll_name == NULL)
3488 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003489 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 *pp = end;
3491 goto theend;
3492 }
3493
Bram Moolenaare38eab22019-12-05 21:50:01 +01003494 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003495 if (lv.ll_exp_name != NULL)
3496 {
3497 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003498 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 flags & TFN_NO_AUTOLOAD);
3500 if (name == lv.ll_exp_name)
3501 name = NULL;
3502 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003503 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 {
3505 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003506 name = deref_func_name(*pp, &len, partial, type,
3507 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508 if (name == *pp)
3509 name = NULL;
3510 }
3511 if (name != NULL)
3512 {
3513 name = vim_strsave(name);
3514 *pp = end;
3515 if (STRNCMP(name, "<SNR>", 5) == 0)
3516 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003517 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003518 name[0] = K_SPECIAL;
3519 name[1] = KS_EXTRA;
3520 name[2] = (int)KE_SNR;
3521 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3522 }
3523 goto theend;
3524 }
3525
3526 if (lv.ll_exp_name != NULL)
3527 {
3528 len = (int)STRLEN(lv.ll_exp_name);
3529 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3530 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3531 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003532 // When there was "s:" already or the name expanded to get a
3533 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534 lv.ll_name += 2;
3535 len -= 2;
3536 lead = 2;
3537 }
3538 }
3539 else
3540 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003541 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003543 {
3544 if (is_global != NULL && lv.ll_name[0] == 'g')
3545 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003547 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003548 len = (int)(end - lv.ll_name);
3549 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003550 if (len <= 0)
3551 {
3552 if (!skip)
3553 emsg(_(e_function_name));
3554 goto theend;
3555 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003557 // In Vim9 script a user function is script-local by default, unless it
3558 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003559 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003560 if (vim9script)
3561 {
3562 char_u *p;
3563
3564 // SomeScript#func() is a global function.
3565 for (p = start; *p != NUL && *p != '('; ++p)
3566 if (*p == AUTOLOAD_CHAR)
3567 vim9script = FALSE;
3568 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003569
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 /*
3571 * Copy the function name to allocated memory.
3572 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3573 * Accept <SNR>123_name() outside a script.
3574 */
3575 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003576 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003577 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003579 if (!vim9script)
3580 lead = 3;
3581 if (vim9script || (lv.ll_exp_name != NULL
3582 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 || eval_fname_sid(*pp))
3584 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003585 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003586 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003588 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 goto theend;
3590 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003591 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003592 if (vim9script)
3593 extra = 3 + (int)STRLEN(sid_buf);
3594 else
3595 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596 }
3597 }
3598 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3599 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003600 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601 start);
3602 goto theend;
3603 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003604 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 {
3606 char_u *cp = vim_strchr(lv.ll_name, ':');
3607
3608 if (cp != NULL && cp < end)
3609 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003610 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 goto theend;
3612 }
3613 }
3614
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003615 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 if (name != NULL)
3617 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003618 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 {
3620 name[0] = K_SPECIAL;
3621 name[1] = KS_EXTRA;
3622 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003623 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 STRCPY(name + 3, sid_buf);
3625 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003626 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3627 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 }
3629 *pp = end;
3630
3631theend:
3632 clear_lval(&lv);
3633 return name;
3634}
3635
3636/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003637 * Assuming "name" is the result of trans_function_name() and it was prefixed
3638 * to use the script-local name, return the unmodified name (points into
3639 * "name"). Otherwise return NULL.
3640 * This can be used to first search for a script-local function and fall back
3641 * to the global function if not found.
3642 */
3643 char_u *
3644untrans_function_name(char_u *name)
3645{
3646 char_u *p;
3647
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003648 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003649 {
3650 p = vim_strchr(name, '_');
3651 if (p != NULL)
3652 return p + 1;
3653 }
3654 return NULL;
3655}
3656
3657/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003658 * List functions. When "regmatch" is NULL all of then.
3659 * Otherwise functions matching "regmatch".
3660 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003661 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003662list_functions(regmatch_T *regmatch)
3663{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003664 int changed = func_hashtab.ht_changed;
3665 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003666 hashitem_T *hi;
3667
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003668 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003669 {
3670 if (!HASHITEM_EMPTY(hi))
3671 {
3672 ufunc_T *fp = HI2UF(hi);
3673
3674 --todo;
3675 if ((fp->uf_flags & FC_DEAD) == 0
3676 && (regmatch == NULL
3677 ? !message_filtered(fp->uf_name)
3678 && !func_name_refcount(fp->uf_name)
3679 : !isdigit(*fp->uf_name)
3680 && vim_regexec(regmatch, fp->uf_name, 0)))
3681 {
3682 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003683 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003684 {
3685 emsg(_("E454: function list was modified"));
3686 return;
3687 }
3688 }
3689 }
3690 }
3691}
3692
3693/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003694 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003695 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3696 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003697 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003699 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003700define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003702 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 int j;
3704 int c;
3705 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003706 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003707 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708 char_u *p;
3709 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003710 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711 char_u *line_arg = NULL;
3712 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003713 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003714 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 garray_T newlines;
3716 int varargs = FALSE;
3717 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003718 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003719 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003720 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 dictitem_T *v;
3722 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003723 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003726 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003727 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003728 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729
3730 /*
3731 * ":function" without argument: list functions.
3732 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003733 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 {
3735 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003736 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003738 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 }
3740
3741 /*
3742 * ":function /pat": list functions matching pattern.
3743 */
3744 if (*eap->arg == '/')
3745 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003746 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 if (!eap->skip)
3748 {
3749 regmatch_T regmatch;
3750
3751 c = *p;
3752 *p = NUL;
3753 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3754 *p = c;
3755 if (regmatch.regprog != NULL)
3756 {
3757 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003758 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759 vim_regfree(regmatch.regprog);
3760 }
3761 }
3762 if (*p == '/')
3763 ++p;
3764 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003765 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 }
3767
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003768 ga_init(&newargs);
3769 ga_init(&argtypes);
3770 ga_init(&default_args);
3771
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 /*
3773 * Get the function name. There are these situations:
3774 * func normal function name
3775 * "name" == func, "fudi.fd_dict" == NULL
3776 * dict.func new dictionary entry
3777 * "name" == NULL, "fudi.fd_dict" set,
3778 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3779 * dict.func existing dict entry with a Funcref
3780 * "name" == func, "fudi.fd_dict" set,
3781 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3782 * dict.func existing dict entry that's not a Funcref
3783 * "name" == NULL, "fudi.fd_dict" set,
3784 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3785 * s:func script-local function name
3786 * g:func global function name, same as "func"
3787 */
3788 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003789 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003791 // nested function, argument is (args).
3792 paren = TRUE;
3793 CLEAR_FIELD(fudi);
3794 }
3795 else
3796 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003797 if (STRNCMP(p, "<lambda>", 8) == 0)
3798 {
3799 p += 8;
3800 (void)getdigits(&p);
3801 name = vim_strnsave(eap->arg, p - eap->arg);
3802 CLEAR_FIELD(fudi);
3803 }
3804 else
3805 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003806 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003807 paren = (vim_strchr(p, '(') != NULL);
3808 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003810 /*
3811 * Return on an invalid expression in braces, unless the expression
3812 * evaluation has been cancelled due to an aborting error, an
3813 * interrupt, or an exception.
3814 */
3815 if (!aborting())
3816 {
3817 if (!eap->skip && fudi.fd_newkey != NULL)
3818 semsg(_(e_dictkey), fudi.fd_newkey);
3819 vim_free(fudi.fd_newkey);
3820 return NULL;
3821 }
3822 else
3823 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 }
3826
Bram Moolenaare38eab22019-12-05 21:50:01 +01003827 // An error in a function call during evaluation of an expression in magic
3828 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 saved_did_emsg = did_emsg;
3830 did_emsg = FALSE;
3831
3832 /*
3833 * ":function func" with only function name: list function.
3834 */
3835 if (!paren)
3836 {
3837 if (!ends_excmd(*skipwhite(p)))
3838 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003839 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 goto ret_free;
3841 }
3842 eap->nextcmd = check_nextcmd(p);
3843 if (eap->nextcmd != NULL)
3844 *p = NUL;
3845 if (!eap->skip && !got_int)
3846 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003847 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003848 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3849 {
3850 char_u *up = untrans_function_name(name);
3851
3852 // With Vim9 script the name was made script-local, if not
3853 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003854 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003855 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003856 }
3857
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858 if (fp != NULL)
3859 {
3860 list_func_head(fp, TRUE);
3861 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3862 {
3863 if (FUNCLINE(fp, j) == NULL)
3864 continue;
3865 msg_putchar('\n');
3866 msg_outnum((long)(j + 1));
3867 if (j < 9)
3868 msg_putchar(' ');
3869 if (j < 99)
3870 msg_putchar(' ');
3871 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003872 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 ui_breakcheck();
3874 }
3875 if (!got_int)
3876 {
3877 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003878 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003879 msg_puts(" enddef");
3880 else
3881 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882 }
3883 }
3884 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003885 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003886 }
3887 goto ret_free;
3888 }
3889
3890 /*
3891 * ":function name(arg1, arg2)" Define function.
3892 */
3893 p = skipwhite(p);
3894 if (*p != '(')
3895 {
3896 if (!eap->skip)
3897 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003898 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899 goto ret_free;
3900 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003901 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003902 if (vim_strchr(p, '(') != NULL)
3903 p = vim_strchr(p, '(');
3904 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003906 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3907 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003908 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003909 goto ret_free;
3910 }
3911
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003912 // In Vim9 script only global functions can be redefined.
3913 if (vim9script && eap->forceit && !is_global)
3914 {
3915 emsg(_(e_nobang));
3916 goto ret_free;
3917 }
3918
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003919 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920
Bram Moolenaar04b12692020-05-04 23:24:44 +02003921 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003922 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003923 // Check the name of the function. Unless it's a dictionary function
3924 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925 if (name != NULL)
3926 arg = name;
3927 else
3928 arg = fudi.fd_newkey;
3929 if (arg != NULL && (fudi.fd_di == NULL
3930 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3931 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3932 {
3933 if (*arg == K_SPECIAL)
3934 j = 3;
3935 else
3936 j = 0;
3937 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3938 : eval_isnamec(arg[j])))
3939 ++j;
3940 if (arg[j] != NUL)
3941 emsg_funcname((char *)e_invarg2, arg);
3942 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003943 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003945 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 }
3947
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003948 // This may get more lines and make the pointers into the first line
3949 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003950 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003951 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003952 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003953 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003954 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003956 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003958 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003959 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003960 // find the return type: :def Func(): type
3961 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003962 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003963 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003964 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003965 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003966 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003967 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003968 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003969 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003970 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003971 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003972 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003973 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003974 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003975 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003977 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003979 else
3980 // find extra arguments "range", "dict", "abort" and "closure"
3981 for (;;)
3982 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003983 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003984 p = skipwhite(p);
3985 if (STRNCMP(p, "range", 5) == 0)
3986 {
3987 flags |= FC_RANGE;
3988 p += 5;
3989 }
3990 else if (STRNCMP(p, "dict", 4) == 0)
3991 {
3992 flags |= FC_DICT;
3993 p += 4;
3994 }
3995 else if (STRNCMP(p, "abort", 5) == 0)
3996 {
3997 flags |= FC_ABORT;
3998 p += 5;
3999 }
4000 else if (STRNCMP(p, "closure", 7) == 0)
4001 {
4002 flags |= FC_CLOSURE;
4003 p += 7;
4004 if (current_funccal == NULL)
4005 {
4006 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4007 name == NULL ? (char_u *)"" : name);
4008 goto erret;
4009 }
4010 }
4011 else
4012 break;
4013 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014
Bram Moolenaare38eab22019-12-05 21:50:01 +01004015 // When there is a line break use what follows for the function body.
4016 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 if (*p == '\n')
4018 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004019 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004020 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4021 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004022 && !(VIM_ISWHITE(*whitep) && *p == '#'
4023 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004024 && !eap->skip
4025 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004026 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027
4028 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004029 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4030 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031 */
4032 if (KeyTyped)
4033 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004034 // Check if the function already exists, don't let the user type the
4035 // whole function before telling him it doesn't work! For a script we
4036 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 if (!eap->skip && !eap->forceit)
4038 {
4039 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004040 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004041 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 emsg_funcname(e_funcexts, name);
4043 }
4044
4045 if (!eap->skip && did_emsg)
4046 goto erret;
4047
Bram Moolenaare38eab22019-12-05 21:50:01 +01004048 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004049 cmdline_row = msg_row;
4050 }
4051
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004052 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004053 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004054
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004055 // Do not define the function when getting the body fails and when
4056 // skipping.
4057 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4058 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 goto erret;
4060
4061 /*
4062 * If there are no errors, add the function
4063 */
4064 if (fudi.fd_dict == NULL)
4065 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004066 hashtab_T *ht;
4067
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004068 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4070 {
4071 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4072 name);
4073 goto erret;
4074 }
4075
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004076 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004077 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004079 char_u *uname = untrans_function_name(name);
4080
4081 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4082 }
4083
4084 if (fp != NULL || import != NULL)
4085 {
4086 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004087
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004088 // Function can be replaced with "function!" and when sourcing the
4089 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004090 // A name that is used by an import can not be overruled.
4091 if (import != NULL
4092 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004093 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004094 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004096 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004097 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004098 else
4099 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004100 goto erret;
4101 }
4102 if (fp->uf_calls > 0)
4103 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004104 emsg_funcname(
4105 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106 name);
4107 goto erret;
4108 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004109 if (fp->uf_refcount > 1)
4110 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004111 // This function is referenced somewhere, don't redefine it but
4112 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004113 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004114 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004115 fp = NULL;
4116 overwrite = TRUE;
4117 }
4118 else
4119 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004120 char_u *exp_name = fp->uf_name_exp;
4121
4122 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004123 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004124 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004125 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004126 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004127 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004128#ifdef FEAT_PROFILE
4129 fp->uf_profiling = FALSE;
4130 fp->uf_prof_initialized = FALSE;
4131#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004132 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004133 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134 }
4135 }
4136 else
4137 {
4138 char numbuf[20];
4139
4140 fp = NULL;
4141 if (fudi.fd_newkey == NULL && !eap->forceit)
4142 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004143 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004144 goto erret;
4145 }
4146 if (fudi.fd_di == NULL)
4147 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004148 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004149 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150 goto erret;
4151 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004152 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004153 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 goto erret;
4155
Bram Moolenaare38eab22019-12-05 21:50:01 +01004156 // Give the function a sequential number. Can only be used with a
4157 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 vim_free(name);
4159 sprintf(numbuf, "%d", ++func_nr);
4160 name = vim_strsave((char_u *)numbuf);
4161 if (name == NULL)
4162 goto erret;
4163 }
4164
4165 if (fp == NULL)
4166 {
4167 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4168 {
4169 int slen, plen;
4170 char_u *scriptname;
4171
Bram Moolenaare38eab22019-12-05 21:50:01 +01004172 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004174 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 {
4176 scriptname = autoload_name(name);
4177 if (scriptname != NULL)
4178 {
4179 p = vim_strchr(scriptname, '/');
4180 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004181 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004183 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184 j = OK;
4185 vim_free(scriptname);
4186 }
4187 }
4188 if (j == FAIL)
4189 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004190 linenr_T save_lnum = SOURCING_LNUM;
4191
4192 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004193 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004194 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 goto erret;
4196 }
4197 }
4198
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004199 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004200 if (fp == NULL)
4201 goto erret;
4202
4203 if (fudi.fd_dict != NULL)
4204 {
4205 if (fudi.fd_di == NULL)
4206 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004207 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4209 if (fudi.fd_di == NULL)
4210 {
4211 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004212 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004213 goto erret;
4214 }
4215 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4216 {
4217 vim_free(fudi.fd_di);
4218 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004219 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220 goto erret;
4221 }
4222 }
4223 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004224 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004225 clear_tv(&fudi.fd_di->di_tv);
4226 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004228
Bram Moolenaare38eab22019-12-05 21:50:01 +01004229 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004230 flags |= FC_DICT;
4231 }
4232
Bram Moolenaare38eab22019-12-05 21:50:01 +01004233 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004234 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004235 if (overwrite)
4236 {
4237 hi = hash_find(&func_hashtab, name);
4238 hi->hi_key = UF2HIKEY(fp);
4239 }
4240 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 {
4242 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004243 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004244 goto erret;
4245 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004246 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247 }
4248 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004249 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004250 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004251 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004252
4253 if (eap->cmdidx == CMD_def)
4254 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004255 int lnum_save = SOURCING_LNUM;
4256 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004257
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004258 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004259
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004260 // error messages are for the first function line
4261 SOURCING_LNUM = sourcing_lnum_top;
4262
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004263 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004264 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004265 int count = cstack->cs_idx + 1;
4266 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004267
4268 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004269 // a block that is visible now but not when the function is called
4270 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004271 fp->uf_block_ids = ALLOC_MULT(int, count);
4272 if (fp->uf_block_ids != NULL)
4273 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004274 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004275 sizeof(int) * count);
4276 fp->uf_block_depth = count;
4277 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004278
4279 // Set flag in each block to indicate a function was defined. This
4280 // is used to keep the variable when leaving the block, see
4281 // hide_script_var().
4282 for (i = 0; i <= cstack->cs_idx; ++i)
4283 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004284 }
4285
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004286 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004287 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004288 SOURCING_LNUM = lnum_save;
4289 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004290 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004291 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004292
4293 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004294 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004295 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004296 SOURCING_LNUM = lnum_save;
4297 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004298 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004299 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004300 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004301 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004302 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004303
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004305 if ((flags & FC_CLOSURE) != 0)
4306 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004307 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004308 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004309 }
4310 else
4311 fp->uf_scoped = NULL;
4312
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 if (prof_def_func())
4315 func_do_profile(fp);
4316#endif
4317 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004318 if (sandbox)
4319 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004320 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004321 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 fp->uf_flags = flags;
4323 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004324 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004325 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004326 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004327 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004328 if (is_export)
4329 {
4330 fp->uf_flags |= FC_EXPORT;
4331 // let ex_export() know the export worked.
4332 is_export = FALSE;
4333 }
4334
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004335 if (eap->cmdidx == CMD_def)
4336 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004337 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4338 // :func does not use Vim9 script syntax, even in a Vim9 script file
4339 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004340
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341 goto ret_free;
4342
4343erret:
4344 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004345 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004346 if (fp != NULL)
4347 {
4348 ga_init(&fp->uf_args);
4349 ga_init(&fp->uf_def_args);
4350 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351errret_2:
4352 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004353 if (fp != NULL)
4354 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004356 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004357 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004359 if (name != name_arg)
4360 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004361 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004362 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004363
4364 return fp;
4365}
4366
4367/*
4368 * ":function"
4369 */
4370 void
4371ex_function(exarg_T *eap)
4372{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004373 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004374}
4375
4376/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004377 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004378 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004379 */
4380 void
4381ex_defcompile(exarg_T *eap UNUSED)
4382{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004383 long todo = (long)func_hashtab.ht_used;
4384 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004385 hashitem_T *hi;
4386 ufunc_T *ufunc;
4387
4388 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4389 {
4390 if (!HASHITEM_EMPTY(hi))
4391 {
4392 --todo;
4393 ufunc = HI2UF(hi);
4394 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004395 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4396 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004397 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004398 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004399
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004400 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004401 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004402 // a function has been added or removed, need to start over
4403 todo = (long)func_hashtab.ht_used;
4404 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004405 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004406 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004407 }
4408 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004409 }
4410 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411}
4412
4413/*
4414 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4415 * Return 2 if "p" starts with "s:".
4416 * Return 0 otherwise.
4417 */
4418 int
4419eval_fname_script(char_u *p)
4420{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004421 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4422 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4424 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4425 return 5;
4426 if (p[0] == 's' && p[1] == ':')
4427 return 2;
4428 return 0;
4429}
4430
4431 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004432translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433{
4434 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004435 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004436 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004437}
4438
4439/*
4440 * Return TRUE when "ufunc" has old-style "..." varargs
4441 * or named varargs "...name: type".
4442 */
4443 int
4444has_varargs(ufunc_T *ufunc)
4445{
4446 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447}
4448
4449/*
4450 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004451 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 */
4453 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004454function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455{
4456 char_u *nm = name;
4457 char_u *p;
4458 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004459 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004460 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004462 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4463 if (no_deref)
4464 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004465 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 nm = skipwhite(nm);
4467
Bram Moolenaare38eab22019-12-05 21:50:01 +01004468 // Only accept "funcname", "funcname ", "funcname (..." and
4469 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004471 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 vim_free(p);
4473 return n;
4474}
4475
Bram Moolenaar113e1072019-01-20 15:30:40 +01004476#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477 char_u *
4478get_expanded_name(char_u *name, int check)
4479{
4480 char_u *nm = name;
4481 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004482 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004484 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004485 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004487 if (p != NULL && *nm == NUL
4488 && (!check || translated_function_exists(p, is_global)))
4489 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004490
4491 vim_free(p);
4492 return NULL;
4493}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004494#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496/*
4497 * Function given to ExpandGeneric() to obtain the list of user defined
4498 * function names.
4499 */
4500 char_u *
4501get_user_func_name(expand_T *xp, int idx)
4502{
4503 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004504 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004505 static hashitem_T *hi;
4506 ufunc_T *fp;
4507
4508 if (idx == 0)
4509 {
4510 done = 0;
4511 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004512 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004513 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004514 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 {
4516 if (done++ > 0)
4517 ++hi;
4518 while (HASHITEM_EMPTY(hi))
4519 ++hi;
4520 fp = HI2UF(hi);
4521
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004522 // don't show dead, dict and lambda functions
4523 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004524 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004525 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004526
4527 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004528 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004529
4530 cat_func_name(IObuff, fp);
4531 if (xp->xp_context != EXPAND_USER_FUNC)
4532 {
4533 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004534 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 STRCAT(IObuff, ")");
4536 }
4537 return IObuff;
4538 }
4539 return NULL;
4540}
4541
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004542/*
4543 * ":delfunction {name}"
4544 */
4545 void
4546ex_delfunction(exarg_T *eap)
4547{
4548 ufunc_T *fp = NULL;
4549 char_u *p;
4550 char_u *name;
4551 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004552 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004553
4554 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004555 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4556 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557 vim_free(fudi.fd_newkey);
4558 if (name == NULL)
4559 {
4560 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004561 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 return;
4563 }
4564 if (!ends_excmd(*skipwhite(p)))
4565 {
4566 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004567 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 return;
4569 }
4570 eap->nextcmd = check_nextcmd(p);
4571 if (eap->nextcmd != NULL)
4572 *p = NUL;
4573
4574 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004575 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 vim_free(name);
4577
4578 if (!eap->skip)
4579 {
4580 if (fp == NULL)
4581 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004582 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004583 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004584 return;
4585 }
4586 if (fp->uf_calls > 0)
4587 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004588 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004589 return;
4590 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004591 if (fp->uf_flags & FC_VIM9)
4592 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004593 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004594 return;
4595 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596
4597 if (fudi.fd_dict != NULL)
4598 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004599 // Delete the dict item that refers to the function, it will
4600 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004601 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4602 }
4603 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004604 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004605 // A normal function (not a numbered function or lambda) has a
4606 // refcount of 1 for the entry in the hashtable. When deleting
4607 // it and the refcount is more than one, it should be kept.
4608 // A numbered function and lambda should be kept if the refcount is
4609 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004610 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004611 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004612 // Function is still referenced somewhere. Don't free it but
4613 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004614 if (func_remove(fp))
4615 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004616 }
4617 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004618 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004619 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004620 }
4621}
4622
4623/*
4624 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004625 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004626 */
4627 void
4628func_unref(char_u *name)
4629{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004630 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004631
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004632 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004634 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004635 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004636 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004638 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004640 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004641 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004642 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004643}
4644
4645/*
4646 * Unreference a Function: decrement the reference count and free it when it
4647 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004648 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004649 */
4650 void
4651func_ptr_unref(ufunc_T *fp)
4652{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004653 if (fp != NULL && (--fp->uf_refcount <= 0
4654 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4655 && fp->uf_partial->pt_refcount <= 1
4656 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004657 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004658 // Only delete it when it's not being used. Otherwise it's done
4659 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004660 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004661 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662 }
4663}
4664
4665/*
4666 * Count a reference to a Function.
4667 */
4668 void
4669func_ref(char_u *name)
4670{
4671 ufunc_T *fp;
4672
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004673 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004675 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004676 if (fp != NULL)
4677 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004678 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004679 // Only give an error for a numbered function.
4680 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004681 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004682}
4683
4684/*
4685 * Count a reference to a Function.
4686 */
4687 void
4688func_ptr_ref(ufunc_T *fp)
4689{
4690 if (fp != NULL)
4691 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692}
4693
4694/*
4695 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4696 * referenced from anywhere that is in use.
4697 */
4698 static int
4699can_free_funccal(funccall_T *fc, int copyID)
4700{
4701 return (fc->l_varlist.lv_copyID != copyID
4702 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004703 && fc->l_avars.dv_copyID != copyID
4704 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004705}
4706
4707/*
4708 * ":return [expr]"
4709 */
4710 void
4711ex_return(exarg_T *eap)
4712{
4713 char_u *arg = eap->arg;
4714 typval_T rettv;
4715 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004716 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717
4718 if (current_funccal == NULL)
4719 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004720 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004721 return;
4722 }
4723
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004724 CLEAR_FIELD(evalarg);
4725 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4726
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727 if (eap->skip)
4728 ++emsg_skip;
4729
4730 eap->nextcmd = NULL;
4731 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004732 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 {
4734 if (!eap->skip)
4735 returning = do_return(eap, FALSE, TRUE, &rettv);
4736 else
4737 clear_tv(&rettv);
4738 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004739 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004740 else if (!eap->skip)
4741 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004742 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004743 update_force_abort();
4744
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745 /*
4746 * Return unless the expression evaluation has been cancelled due to an
4747 * aborting error, an interrupt, or an exception.
4748 */
4749 if (!aborting())
4750 returning = do_return(eap, FALSE, TRUE, NULL);
4751 }
4752
Bram Moolenaare38eab22019-12-05 21:50:01 +01004753 // When skipping or the return gets pending, advance to the next command
4754 // in this line (!returning). Otherwise, ignore the rest of the line.
4755 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 if (returning)
4757 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004758 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004759 eap->nextcmd = check_nextcmd(arg);
4760
4761 if (eap->skip)
4762 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004763 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004764}
4765
4766/*
4767 * ":1,25call func(arg1, arg2)" function call.
4768 */
4769 void
4770ex_call(exarg_T *eap)
4771{
4772 char_u *arg = eap->arg;
4773 char_u *startarg;
4774 char_u *name;
4775 char_u *tofree;
4776 int len;
4777 typval_T rettv;
4778 linenr_T lnum;
4779 int doesrange;
4780 int failed = FALSE;
4781 funcdict_T fudi;
4782 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004783 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004784 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785
Bram Moolenaare6b53242020-07-01 17:28:33 +02004786 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004787 if (eap->skip)
4788 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004789 // trans_function_name() doesn't work well when skipping, use eval0()
4790 // instead to skip to any following command, e.g. for:
4791 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004792 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004793 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004794 clear_tv(&rettv);
4795 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004796 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004797 return;
4798 }
4799
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004800 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4801 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004802 if (fudi.fd_newkey != NULL)
4803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004804 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004805 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 vim_free(fudi.fd_newkey);
4807 }
4808 if (tofree == NULL)
4809 return;
4810
Bram Moolenaare38eab22019-12-05 21:50:01 +01004811 // Increase refcount on dictionary, it could get deleted when evaluating
4812 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 if (fudi.fd_dict != NULL)
4814 ++fudi.fd_dict->dv_refcount;
4815
Bram Moolenaare38eab22019-12-05 21:50:01 +01004816 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4817 // contents. For VAR_PARTIAL get its partial, unless we already have one
4818 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004820 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4821 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004822
Bram Moolenaare38eab22019-12-05 21:50:01 +01004823 // Skip white space to allow ":call func ()". Not good, but required for
4824 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004826 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827
4828 if (*startarg != '(')
4829 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004830 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004831 goto end;
4832 }
4833
4834 /*
4835 * When skipping, evaluate the function once, to find the end of the
4836 * arguments.
4837 * When the function takes a range, this is discovered after the first
4838 * call, and the loop is broken.
4839 */
4840 if (eap->skip)
4841 {
4842 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004843 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844 }
4845 else
4846 lnum = eap->line1;
4847 for ( ; lnum <= eap->line2; ++lnum)
4848 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004849 funcexe_T funcexe;
4850
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004851 if (!eap->skip && eap->addr_count > 0)
4852 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004853 if (lnum > curbuf->b_ml.ml_line_count)
4854 {
4855 // If the function deleted lines or switched to another buffer
4856 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004857 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004858 break;
4859 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 curwin->w_cursor.lnum = lnum;
4861 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004862 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863 }
4864 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004865
Bram Moolenaara80faa82020-04-12 19:37:17 +02004866 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004867 funcexe.firstline = eap->line1;
4868 funcexe.lastline = eap->line2;
4869 funcexe.doesrange = &doesrange;
4870 funcexe.evaluate = !eap->skip;
4871 funcexe.partial = partial;
4872 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004873 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004874 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875 {
4876 failed = TRUE;
4877 break;
4878 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004879 if (has_watchexpr())
4880 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004881
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004882 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004883 if (handle_subscript(&arg, &rettv,
4884 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885 {
4886 failed = TRUE;
4887 break;
4888 }
4889
4890 clear_tv(&rettv);
4891 if (doesrange || eap->skip)
4892 break;
4893
Bram Moolenaare38eab22019-12-05 21:50:01 +01004894 // Stop when immediately aborting on error, or when an interrupt
4895 // occurred or an exception was thrown but not caught.
4896 // get_func_tv() returned OK, so that the check for trailing
4897 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 if (aborting())
4899 break;
4900 }
4901 if (eap->skip)
4902 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004903 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904
Bram Moolenaare51bb172020-02-16 19:42:23 +01004905 // When inside :try we need to check for following "| catch".
4906 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004908 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004909 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004910 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004912 if (!failed)
4913 {
4914 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004915 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004917 }
4918 else
4919 eap->nextcmd = check_nextcmd(arg);
4920 }
4921
4922end:
4923 dict_unref(fudi.fd_dict);
4924 vim_free(tofree);
4925}
4926
4927/*
4928 * Return from a function. Possibly makes the return pending. Also called
4929 * for a pending return at the ":endtry" or after returning from an extra
4930 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4931 * when called due to a ":return" command. "rettv" may point to a typval_T
4932 * with the return rettv. Returns TRUE when the return can be carried out,
4933 * FALSE when the return gets pending.
4934 */
4935 int
4936do_return(
4937 exarg_T *eap,
4938 int reanimate,
4939 int is_cmd,
4940 void *rettv)
4941{
4942 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004943 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004944
4945 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004946 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004947 current_funccal->returned = FALSE;
4948
4949 /*
4950 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4951 * not in its finally clause (which then is to be executed next) is found.
4952 * In this case, make the ":return" pending for execution at the ":endtry".
4953 * Otherwise, return normally.
4954 */
4955 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4956 if (idx >= 0)
4957 {
4958 cstack->cs_pending[idx] = CSTP_RETURN;
4959
4960 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004961 // A pending return again gets pending. "rettv" points to an
4962 // allocated variable with the rettv of the original ":return"'s
4963 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004964 cstack->cs_rettv[idx] = rettv;
4965 else
4966 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004967 // When undoing a return in order to make it pending, get the stored
4968 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969 if (reanimate)
4970 rettv = current_funccal->rettv;
4971
4972 if (rettv != NULL)
4973 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004974 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004975 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4976 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4977 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004978 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979 }
4980 else
4981 cstack->cs_rettv[idx] = NULL;
4982
4983 if (reanimate)
4984 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004985 // The pending return value could be overwritten by a ":return"
4986 // without argument in a finally clause; reset the default
4987 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988 current_funccal->rettv->v_type = VAR_NUMBER;
4989 current_funccal->rettv->vval.v_number = 0;
4990 }
4991 }
4992 report_make_pending(CSTP_RETURN, rettv);
4993 }
4994 else
4995 {
4996 current_funccal->returned = TRUE;
4997
Bram Moolenaare38eab22019-12-05 21:50:01 +01004998 // If the return is carried out now, store the return value. For
4999 // a return immediately after reanimation, the value is already
5000 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005001 if (!reanimate && rettv != NULL)
5002 {
5003 clear_tv(current_funccal->rettv);
5004 *current_funccal->rettv = *(typval_T *)rettv;
5005 if (!is_cmd)
5006 vim_free(rettv);
5007 }
5008 }
5009
5010 return idx < 0;
5011}
5012
5013/*
5014 * Free the variable with a pending return value.
5015 */
5016 void
5017discard_pending_return(void *rettv)
5018{
5019 free_tv((typval_T *)rettv);
5020}
5021
5022/*
5023 * Generate a return command for producing the value of "rettv". The result
5024 * is an allocated string. Used by report_pending() for verbose messages.
5025 */
5026 char_u *
5027get_return_cmd(void *rettv)
5028{
5029 char_u *s = NULL;
5030 char_u *tofree = NULL;
5031 char_u numbuf[NUMBUFLEN];
5032
5033 if (rettv != NULL)
5034 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5035 if (s == NULL)
5036 s = (char_u *)"";
5037
5038 STRCPY(IObuff, ":return ");
5039 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5040 if (STRLEN(s) + 8 >= IOSIZE)
5041 STRCPY(IObuff + IOSIZE - 4, "...");
5042 vim_free(tofree);
5043 return vim_strsave(IObuff);
5044}
5045
5046/*
5047 * Get next function line.
5048 * Called by do_cmdline() to get the next line.
5049 * Returns allocated string, or NULL for end of function.
5050 */
5051 char_u *
5052get_func_line(
5053 int c UNUSED,
5054 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005055 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005056 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005057{
5058 funccall_T *fcp = (funccall_T *)cookie;
5059 ufunc_T *fp = fcp->func;
5060 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005061 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005062
Bram Moolenaare38eab22019-12-05 21:50:01 +01005063 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005064 if (fcp->dbg_tick != debug_tick)
5065 {
5066 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005067 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068 fcp->dbg_tick = debug_tick;
5069 }
5070#ifdef FEAT_PROFILE
5071 if (do_profiling == PROF_YES)
5072 func_line_end(cookie);
5073#endif
5074
5075 gap = &fp->uf_lines;
5076 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5077 || fcp->returned)
5078 retval = NULL;
5079 else
5080 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005081 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005082 while (fcp->linenr < gap->ga_len
5083 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5084 ++fcp->linenr;
5085 if (fcp->linenr >= gap->ga_len)
5086 retval = NULL;
5087 else
5088 {
5089 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005090 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005091#ifdef FEAT_PROFILE
5092 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005093 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005094#endif
5095 }
5096 }
5097
Bram Moolenaare38eab22019-12-05 21:50:01 +01005098 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005099 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005100 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005101 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005102 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005103 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005104 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005105 fcp->dbg_tick = debug_tick;
5106 }
5107
5108 return retval;
5109}
5110
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005111/*
5112 * Return TRUE if the currently active function should be ended, because a
5113 * return was encountered or an error occurred. Used inside a ":while".
5114 */
5115 int
5116func_has_ended(void *cookie)
5117{
5118 funccall_T *fcp = (funccall_T *)cookie;
5119
Bram Moolenaare38eab22019-12-05 21:50:01 +01005120 // Ignore the "abort" flag if the abortion behavior has been changed due to
5121 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5123 || fcp->returned);
5124}
5125
5126/*
5127 * return TRUE if cookie indicates a function which "abort"s on errors.
5128 */
5129 int
5130func_has_abort(
5131 void *cookie)
5132{
5133 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5134}
5135
5136
5137/*
5138 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5139 * Don't do this when "Func" is already a partial that was bound
5140 * explicitly (pt_auto is FALSE).
5141 * Changes "rettv" in-place.
5142 * Returns the updated "selfdict_in".
5143 */
5144 dict_T *
5145make_partial(dict_T *selfdict_in, typval_T *rettv)
5146{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005147 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005148 char_u *tofree = NULL;
5149 ufunc_T *fp;
5150 char_u fname_buf[FLEN_FIXED + 1];
5151 int error;
5152 dict_T *selfdict = selfdict_in;
5153
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005154 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5155 fp = rettv->vval.v_partial->pt_func;
5156 else
5157 {
5158 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5159 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005160 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005161 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005162 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005163 vim_free(tofree);
5164 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165
5166 if (fp != NULL && (fp->uf_flags & FC_DICT))
5167 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005168 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169
5170 if (pt != NULL)
5171 {
5172 pt->pt_refcount = 1;
5173 pt->pt_dict = selfdict;
5174 pt->pt_auto = TRUE;
5175 selfdict = NULL;
5176 if (rettv->v_type == VAR_FUNC)
5177 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005178 // Just a function: Take over the function name and use
5179 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005180 pt->pt_name = rettv->vval.v_string;
5181 }
5182 else
5183 {
5184 partial_T *ret_pt = rettv->vval.v_partial;
5185 int i;
5186
Bram Moolenaare38eab22019-12-05 21:50:01 +01005187 // Partial: copy the function name, use selfdict and copy
5188 // args. Can't take over name or args, the partial might
5189 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005190 if (ret_pt->pt_name != NULL)
5191 {
5192 pt->pt_name = vim_strsave(ret_pt->pt_name);
5193 func_ref(pt->pt_name);
5194 }
5195 else
5196 {
5197 pt->pt_func = ret_pt->pt_func;
5198 func_ptr_ref(pt->pt_func);
5199 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200 if (ret_pt->pt_argc > 0)
5201 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005202 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005204 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005205 pt->pt_argc = 0;
5206 else
5207 {
5208 pt->pt_argc = ret_pt->pt_argc;
5209 for (i = 0; i < pt->pt_argc; i++)
5210 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5211 }
5212 }
5213 partial_unref(ret_pt);
5214 }
5215 rettv->v_type = VAR_PARTIAL;
5216 rettv->vval.v_partial = pt;
5217 }
5218 }
5219 return selfdict;
5220}
5221
5222/*
5223 * Return the name of the executed function.
5224 */
5225 char_u *
5226func_name(void *cookie)
5227{
5228 return ((funccall_T *)cookie)->func->uf_name;
5229}
5230
5231/*
5232 * Return the address holding the next breakpoint line for a funccall cookie.
5233 */
5234 linenr_T *
5235func_breakpoint(void *cookie)
5236{
5237 return &((funccall_T *)cookie)->breakpoint;
5238}
5239
5240/*
5241 * Return the address holding the debug tick for a funccall cookie.
5242 */
5243 int *
5244func_dbg_tick(void *cookie)
5245{
5246 return &((funccall_T *)cookie)->dbg_tick;
5247}
5248
5249/*
5250 * Return the nesting level for a funccall cookie.
5251 */
5252 int
5253func_level(void *cookie)
5254{
5255 return ((funccall_T *)cookie)->level;
5256}
5257
5258/*
5259 * Return TRUE when a function was ended by a ":return" command.
5260 */
5261 int
5262current_func_returned(void)
5263{
5264 return current_funccal->returned;
5265}
5266
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005267 int
5268free_unref_funccal(int copyID, int testing)
5269{
5270 int did_free = FALSE;
5271 int did_free_funccal = FALSE;
5272 funccall_T *fc, **pfc;
5273
5274 for (pfc = &previous_funccal; *pfc != NULL; )
5275 {
5276 if (can_free_funccal(*pfc, copyID))
5277 {
5278 fc = *pfc;
5279 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005280 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005281 did_free = TRUE;
5282 did_free_funccal = TRUE;
5283 }
5284 else
5285 pfc = &(*pfc)->caller;
5286 }
5287 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005288 // When a funccal was freed some more items might be garbage
5289 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005290 (void)garbage_collect(testing);
5291
5292 return did_free;
5293}
5294
5295/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005296 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 */
5298 static funccall_T *
5299get_funccal(void)
5300{
5301 int i;
5302 funccall_T *funccal;
5303 funccall_T *temp_funccal;
5304
5305 funccal = current_funccal;
5306 if (debug_backtrace_level > 0)
5307 {
5308 for (i = 0; i < debug_backtrace_level; i++)
5309 {
5310 temp_funccal = funccal->caller;
5311 if (temp_funccal)
5312 funccal = temp_funccal;
5313 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005314 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005315 debug_backtrace_level = i;
5316 }
5317 }
5318 return funccal;
5319}
5320
5321/*
5322 * Return the hashtable used for local variables in the current funccal.
5323 * Return NULL if there is no current funccal.
5324 */
5325 hashtab_T *
5326get_funccal_local_ht()
5327{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005328 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329 return NULL;
5330 return &get_funccal()->l_vars.dv_hashtab;
5331}
5332
5333/*
5334 * Return the l: scope variable.
5335 * Return NULL if there is no current funccal.
5336 */
5337 dictitem_T *
5338get_funccal_local_var()
5339{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005340 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005341 return NULL;
5342 return &get_funccal()->l_vars_var;
5343}
5344
5345/*
5346 * Return the hashtable used for argument in the current funccal.
5347 * Return NULL if there is no current funccal.
5348 */
5349 hashtab_T *
5350get_funccal_args_ht()
5351{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005352 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005353 return NULL;
5354 return &get_funccal()->l_avars.dv_hashtab;
5355}
5356
5357/*
5358 * Return the a: scope variable.
5359 * Return NULL if there is no current funccal.
5360 */
5361 dictitem_T *
5362get_funccal_args_var()
5363{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005364 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005365 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005366 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005367}
5368
5369/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005370 * List function variables, if there is a function.
5371 */
5372 void
5373list_func_vars(int *first)
5374{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005375 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005377 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005378}
5379
5380/*
5381 * If "ht" is the hashtable for local variables in the current funccal, return
5382 * the dict that contains it.
5383 * Otherwise return NULL.
5384 */
5385 dict_T *
5386get_current_funccal_dict(hashtab_T *ht)
5387{
5388 if (current_funccal != NULL
5389 && ht == &current_funccal->l_vars.dv_hashtab)
5390 return &current_funccal->l_vars;
5391 return NULL;
5392}
5393
5394/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005395 * Search hashitem in parent scope.
5396 */
5397 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005398find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005399{
5400 funccall_T *old_current_funccal = current_funccal;
5401 hashtab_T *ht;
5402 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005403 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005404
5405 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5406 return NULL;
5407
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005408 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005409 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005410 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005411 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005412 ht = find_var_ht(name, &varname);
5413 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005414 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005415 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005416 if (!HASHITEM_EMPTY(hi))
5417 {
5418 *pht = ht;
5419 break;
5420 }
5421 }
5422 if (current_funccal == current_funccal->func->uf_scoped)
5423 break;
5424 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005425 }
5426 current_funccal = old_current_funccal;
5427
5428 return hi;
5429}
5430
5431/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005432 * Search variable in parent scope.
5433 */
5434 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005435find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005436{
5437 dictitem_T *v = NULL;
5438 funccall_T *old_current_funccal = current_funccal;
5439 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005440 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005441
5442 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5443 return NULL;
5444
Bram Moolenaare38eab22019-12-05 21:50:01 +01005445 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005446 current_funccal = current_funccal->func->uf_scoped;
5447 while (current_funccal)
5448 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005449 ht = find_var_ht(name, &varname);
5450 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005451 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005452 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005453 if (v != NULL)
5454 break;
5455 }
5456 if (current_funccal == current_funccal->func->uf_scoped)
5457 break;
5458 current_funccal = current_funccal->func->uf_scoped;
5459 }
5460 current_funccal = old_current_funccal;
5461
5462 return v;
5463}
5464
5465/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005466 * Set "copyID + 1" in previous_funccal and callers.
5467 */
5468 int
5469set_ref_in_previous_funccal(int copyID)
5470{
5471 int abort = FALSE;
5472 funccall_T *fc;
5473
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005474 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005475 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005476 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005477 abort = abort
5478 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5479 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005480 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005481 }
5482 return abort;
5483}
5484
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005485 static int
5486set_ref_in_funccal(funccall_T *fc, int copyID)
5487{
5488 int abort = FALSE;
5489
5490 if (fc->fc_copyID != copyID)
5491 {
5492 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005493 abort = abort
5494 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5495 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005496 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005497 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005498 }
5499 return abort;
5500}
5501
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005502/*
5503 * Set "copyID" in all local vars and arguments in the call stack.
5504 */
5505 int
5506set_ref_in_call_stack(int copyID)
5507{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005508 int abort = FALSE;
5509 funccall_T *fc;
5510 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005511
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005512 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005513 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005514
5515 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005516 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5517 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005518 abort = abort || set_ref_in_funccal(fc, copyID);
5519
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005520 return abort;
5521}
5522
5523/*
5524 * Set "copyID" in all functions available by name.
5525 */
5526 int
5527set_ref_in_functions(int copyID)
5528{
5529 int todo;
5530 hashitem_T *hi = NULL;
5531 int abort = FALSE;
5532 ufunc_T *fp;
5533
5534 todo = (int)func_hashtab.ht_used;
5535 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005536 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005537 if (!HASHITEM_EMPTY(hi))
5538 {
5539 --todo;
5540 fp = HI2UF(hi);
5541 if (!func_name_refcount(fp->uf_name))
5542 abort = abort || set_ref_in_func(NULL, fp, copyID);
5543 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005544 }
5545 return abort;
5546}
5547
5548/*
5549 * Set "copyID" in all function arguments.
5550 */
5551 int
5552set_ref_in_func_args(int copyID)
5553{
5554 int i;
5555 int abort = FALSE;
5556
5557 for (i = 0; i < funcargs.ga_len; ++i)
5558 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5559 copyID, NULL, NULL);
5560 return abort;
5561}
5562
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005563/*
5564 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005565 * Returns TRUE if setting references failed somehow.
5566 */
5567 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005568set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005569{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005570 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005571 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005572 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005573 char_u fname_buf[FLEN_FIXED + 1];
5574 char_u *tofree = NULL;
5575 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005576 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005577
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005578 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005579 return FALSE;
5580
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005581 if (fp_in == NULL)
5582 {
5583 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005584 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005585 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005586 if (fp != NULL)
5587 {
5588 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005589 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005590 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005591
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005592 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005593 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005594}
5595
Bram Moolenaare38eab22019-12-05 21:50:01 +01005596#endif // FEAT_EVAL