blob: 3321f089c0ab26a365bfc1b769ba551835df547f [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 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200269 char_u *np;
270
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100272 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200273 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200276
Bram Moolenaar015cf102021-06-26 21:52:02 +0200277 // Recognize " = expr" but not " == expr". A lambda can have
278 // "(a = expr" but "(a == expr" is not a lambda.
279 np = skipwhite(p);
280 if (*np == '=' && np[1] != '=' && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200281 {
282 typval_T rettv;
283
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100284 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200285 any_default = TRUE;
286 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200287 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200288 p = skipwhite(p);
289 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200290 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200291 {
292 if (ga_grow(default_args, 1) == FAIL)
293 goto err_ret;
294
295 // trim trailing whitespace
296 while (p > expr && VIM_ISWHITE(p[-1]))
297 p--;
298 c = *p;
299 *p = NUL;
300 expr = vim_strsave(expr);
301 if (expr == NULL)
302 {
303 *p = c;
304 goto err_ret;
305 }
306 ((char_u **)(default_args->ga_data))
307 [default_args->ga_len] = expr;
308 default_args->ga_len++;
309 *p = c;
310 }
311 else
312 mustend = TRUE;
313 }
314 else if (any_default)
315 {
316 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200317 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200318 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200319
320 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
321 {
322 // Be tolerant when skipping
323 if (!skip)
324 {
325 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
326 goto err_ret;
327 }
328 p = skipwhite(p);
329 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200330 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200331 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200332 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200333 // Don't give this error when skipping, it makes the "->" not
334 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100335 // Allow missing space after comma in legacy functions.
336 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200337 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
338 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100339 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200340 goto err_ret;
341 }
342 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200343 else
344 mustend = TRUE;
345 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200346 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200348 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200349
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200350 if (*p != endchar)
351 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100352 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200353
354 *argp = p;
355 return OK;
356
357err_ret:
358 if (newargs != NULL)
359 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200360 if (default_args != NULL)
361 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 return FAIL;
363}
364
365/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100366 * Parse the argument types, filling "fp->uf_arg_types".
367 * Return OK or FAIL.
368 */
369 static int
370parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
371{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200372 int len = 0;
373
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100374 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
375 if (argtypes->ga_len > 0)
376 {
377 // When "varargs" is set the last name/type goes into uf_va_name
378 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200379 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100380
381 if (len > 0)
382 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
383 if (fp->uf_arg_types != NULL)
384 {
385 int i;
386 type_T *type;
387
388 for (i = 0; i < len; ++ i)
389 {
390 char_u *p = ((char_u **)argtypes->ga_data)[i];
391
392 if (p == NULL)
393 // will get the type from the default value
394 type = &t_unknown;
395 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100396 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100397 if (type == NULL)
398 return FAIL;
399 fp->uf_arg_types[i] = type;
400 }
401 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100402 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200403
404 if (varargs)
405 {
406 char_u *p;
407
408 // Move the last argument "...name: type" to uf_va_name and
409 // uf_va_type.
410 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
411 [fp->uf_args.ga_len - 1];
412 --fp->uf_args.ga_len;
413 p = ((char_u **)argtypes->ga_data)[len];
414 if (p == NULL)
415 // TODO: get type from default value
416 fp->uf_va_type = &t_list_any;
417 else
418 {
419 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
420 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
421 {
422 semsg(_(e_variable_arguments_type_must_be_list_str),
423 ((char_u **)argtypes->ga_data)[len]);
424 return FAIL;
425 }
426 }
427 if (fp->uf_va_type == NULL)
428 return FAIL;
429 }
430
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100431 return OK;
432}
433
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100434 static int
435parse_return_type(ufunc_T *fp, char_u *ret_type)
436{
437 if (ret_type == NULL)
438 fp->uf_ret_type = &t_void;
439 else
440 {
441 char_u *p = ret_type;
442
443 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
444 if (fp->uf_ret_type == NULL)
445 {
446 fp->uf_ret_type = &t_void;
447 return FAIL;
448 }
449 }
450 return OK;
451}
452
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100453/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200454 * Register function "fp" as using "current_funccal" as its scope.
455 */
456 static int
457register_closure(ufunc_T *fp)
458{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200459 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100460 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200461 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200462 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200463 fp->uf_scoped = current_funccal;
464 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200465
Bram Moolenaar58016442016-07-31 18:30:22 +0200466 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
467 return FAIL;
468 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
469 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200470 return OK;
471}
472
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100473 static void
474set_ufunc_name(ufunc_T *fp, char_u *name)
475{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100476 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
477 // actually extends beyond the struct.
478 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100479
480 if (name[0] == K_SPECIAL)
481 {
482 fp->uf_name_exp = alloc(STRLEN(name) + 3);
483 if (fp->uf_name_exp != NULL)
484 {
485 STRCPY(fp->uf_name_exp, "<SNR>");
486 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
487 }
488 }
489}
490
Bram Moolenaar58016442016-07-31 18:30:22 +0200491/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200492 * Get a name for a lambda. Returned in static memory.
493 */
494 char_u *
495get_lambda_name(void)
496{
497 static char_u name[30];
498 static int lambda_no = 0;
499
500 sprintf((char*)name, "<lambda>%d", ++lambda_no);
501 return name;
502}
503
Bram Moolenaar801ab062020-06-25 19:27:56 +0200504#if defined(FEAT_LUA) || defined(PROTO)
505/*
506 * Registers a native C callback which can be called from Vim script.
507 * Returns the name of the Vim script function.
508 */
509 char_u *
510register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
511{
512 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200513 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200514
515 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
516 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200517 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200519 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200520 fp->uf_refcount = 1;
521 fp->uf_varargs = TRUE;
522 fp->uf_flags = FC_CFUNC;
523 fp->uf_calls = 0;
524 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200525 fp->uf_cb = cb;
526 fp->uf_cb_free = cb_free;
527 fp->uf_cb_state = state;
528
529 set_ufunc_name(fp, name);
530 hash_add(&func_hashtab, UF2HIKEY(fp));
531
532 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200533}
534#endif
535
Bram Moolenaar04b12692020-05-04 23:24:44 +0200536/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100537 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100538 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100539 * If "white_error" is not NULL check for correct use of white space and set
540 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 * Return NULL if no valid arrow found.
542 */
543 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100544skip_arrow(
545 char_u *start,
546 int equal_arrow,
547 char_u **ret_type,
548 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100549{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100550 char_u *s = start;
551 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100552
553 if (equal_arrow)
554 {
555 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100556 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100557 if (white_error != NULL && !VIM_ISWHITE(s[1]))
558 {
559 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100560 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100561 return NULL;
562 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100563 s = skipwhite(s + 1);
564 *ret_type = s;
565 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100566 if (s == *ret_type)
567 {
568 emsg(_(e_missing_return_type));
569 return NULL;
570 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100571 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100572 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100573 s = skipwhite(s);
574 if (*s != '=')
575 return NULL;
576 ++s;
577 }
578 if (*s != '>')
579 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100580 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
581 || !IS_WHITE_OR_NUL(s[1])))
582 {
583 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100584 semsg(_(e_white_space_required_before_and_after_str_at_str),
585 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100586 return NULL;
587 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100588 return skipwhite(s + 1);
589}
590
591/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100592 * Check if "*cmd" points to a function command and if so advance "*cmd" and
593 * return TRUE.
594 * Otherwise return FALSE;
595 * Do not consider "function(" to be a command.
596 */
597 static int
598is_function_cmd(char_u **cmd)
599{
600 char_u *p = *cmd;
601
602 if (checkforcmd(&p, "function", 2))
603 {
604 if (*p == '(')
605 return FALSE;
606 *cmd = p;
607 return TRUE;
608 }
609 return FALSE;
610}
611
612/*
613 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200614 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100615 * "newlines" must already have been initialized.
616 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
617 */
618 static int
619get_function_body(
620 exarg_T *eap,
621 garray_T *newlines,
622 char_u *line_arg_in,
623 char_u **line_to_free)
624{
625 linenr_T sourcing_lnum_top = SOURCING_LNUM;
626 linenr_T sourcing_lnum_off;
627 int saved_wait_return = need_wait_return;
628 char_u *line_arg = line_arg_in;
629 int vim9_function = eap->cmdidx == CMD_def
630 || eap->cmdidx == CMD_block;
631#define MAX_FUNC_NESTING 50
632 char nesting_def[MAX_FUNC_NESTING];
633 int nesting = 0;
634 getline_opt_T getline_options;
635 int indent = 2;
636 char_u *skip_until = NULL;
637 int ret = FAIL;
638 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200639 int heredoc_concat_len = 0;
640 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100641 char_u *heredoc_trimmed = NULL;
642
Bram Moolenaar20677332021-06-06 17:02:53 +0200643 ga_init2(&heredoc_ga, 1, 500);
644
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100645 // Detect having skipped over comment lines to find the return
646 // type. Add NULL lines to keep the line count correct.
647 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
648 if (SOURCING_LNUM < sourcing_lnum_off)
649 {
650 sourcing_lnum_off -= SOURCING_LNUM;
651 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
652 goto theend;
653 while (sourcing_lnum_off-- > 0)
654 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
655 }
656
657 nesting_def[nesting] = vim9_function;
658 getline_options = vim9_function
659 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
660 for (;;)
661 {
662 char_u *theline;
663 char_u *p;
664 char_u *arg;
665
666 if (KeyTyped)
667 {
668 msg_scroll = TRUE;
669 saved_wait_return = FALSE;
670 }
671 need_wait_return = FALSE;
672
673 if (line_arg != NULL)
674 {
675 // Use eap->arg, split up in parts by line breaks.
676 theline = line_arg;
677 p = vim_strchr(theline, '\n');
678 if (p == NULL)
679 line_arg += STRLEN(line_arg);
680 else
681 {
682 *p = NUL;
683 line_arg = p + 1;
684 }
685 }
686 else
687 {
688 vim_free(*line_to_free);
689 if (eap->getline == NULL)
690 theline = getcmdline(':', 0L, indent, getline_options);
691 else
692 theline = eap->getline(':', eap->cookie, indent,
693 getline_options);
694 *line_to_free = theline;
695 }
696 if (KeyTyped)
697 lines_left = Rows - 1;
698 if (theline == NULL)
699 {
700 // Use the start of the function for the line number.
701 SOURCING_LNUM = sourcing_lnum_top;
702 if (skip_until != NULL)
703 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
704 else if (eap->cmdidx == CMD_def)
705 emsg(_(e_missing_enddef));
706 else if (eap->cmdidx == CMD_block)
707 emsg(_(e_missing_end_block));
708 else
709 emsg(_("E126: Missing :endfunction"));
710 goto theend;
711 }
712
713 // Detect line continuation: SOURCING_LNUM increased more than one.
714 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
715 if (SOURCING_LNUM < sourcing_lnum_off)
716 sourcing_lnum_off -= SOURCING_LNUM;
717 else
718 sourcing_lnum_off = 0;
719
720 if (skip_until != NULL)
721 {
722 // Don't check for ":endfunc"/":enddef" between
723 // * ":append" and "."
724 // * ":python <<EOF" and "EOF"
725 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
726 if (heredoc_trimmed == NULL
727 || (is_heredoc && skipwhite(theline) == theline)
728 || STRNCMP(theline, heredoc_trimmed,
729 STRLEN(heredoc_trimmed)) == 0)
730 {
731 if (heredoc_trimmed == NULL)
732 p = theline;
733 else if (is_heredoc)
734 p = skipwhite(theline) == theline
735 ? theline : theline + STRLEN(heredoc_trimmed);
736 else
737 p = theline + STRLEN(heredoc_trimmed);
738 if (STRCMP(p, skip_until) == 0)
739 {
740 VIM_CLEAR(skip_until);
741 VIM_CLEAR(heredoc_trimmed);
742 getline_options = vim9_function
743 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
744 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200745
746 if (heredoc_concat_len > 0)
747 {
748 // Replace the starting line with all the concatenated
749 // lines.
750 ga_concat(&heredoc_ga, theline);
751 vim_free(((char_u **)(newlines->ga_data))[
752 heredoc_concat_len - 1]);
753 ((char_u **)(newlines->ga_data))[
754 heredoc_concat_len - 1] = heredoc_ga.ga_data;
755 ga_init(&heredoc_ga);
756 heredoc_concat_len = 0;
757 theline += STRLEN(theline); // skip the "EOF"
758 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100759 }
760 }
761 }
762 else
763 {
764 int c;
765
766 // skip ':' and blanks
767 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
768 ;
769
770 // Check for "endfunction", "enddef" or "}".
771 // When a ":" follows it must be a dict key; "enddef: value,"
772 if ((nesting == 0 && eap->cmdidx == CMD_block)
773 ? *p == '}'
774 : (checkforcmd(&p, nesting_def[nesting]
775 ? "enddef" : "endfunction", 4)
776 && *p != ':'))
777 {
778 if (nesting-- == 0)
779 {
780 char_u *nextcmd = NULL;
781
782 if (*p == '|' || *p == '}')
783 nextcmd = p + 1;
784 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
785 nextcmd = line_arg;
786 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100787 && (vim9_function || p_verbose > 0))
788 {
789 if (eap->cmdidx == CMD_def)
790 semsg(_(e_text_found_after_enddef_str), p);
791 else
792 give_warning2((char_u *)
793 _("W22: Text found after :endfunction: %s"),
794 p, TRUE);
795 }
796 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100797 {
798 // Another command follows. If the line came from "eap"
799 // we can simply point into it, otherwise we need to
800 // change "eap->cmdlinep".
801 eap->nextcmd = nextcmd;
802 if (*line_to_free != NULL)
803 {
804 vim_free(*eap->cmdlinep);
805 *eap->cmdlinep = *line_to_free;
806 *line_to_free = NULL;
807 }
808 }
809 break;
810 }
811 }
812
813 // Check for mismatched "endfunc" or "enddef".
814 // We don't check for "def" inside "func" thus we also can't check
815 // for "enddef".
816 // We continue to find the end of the function, although we might
817 // not find it.
818 else if (nesting_def[nesting])
819 {
820 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
821 emsg(_(e_mismatched_endfunction));
822 }
823 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
824 emsg(_(e_mismatched_enddef));
825
826 // Increase indent inside "if", "while", "for" and "try", decrease
827 // at "end".
828 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
829 indent -= 2;
830 else if (STRNCMP(p, "if", 2) == 0
831 || STRNCMP(p, "wh", 2) == 0
832 || STRNCMP(p, "for", 3) == 0
833 || STRNCMP(p, "try", 3) == 0)
834 indent += 2;
835
836 // Check for defining a function inside this function.
837 // Only recognize "def" inside "def", not inside "function",
838 // For backwards compatibility, see Test_function_python().
839 c = *p;
840 if (is_function_cmd(&p)
841 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
842 {
843 if (*p == '!')
844 p = skipwhite(p + 1);
845 p += eval_fname_script(p);
846 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
847 NULL, NULL));
848 if (*skipwhite(p) == '(')
849 {
850 if (nesting == MAX_FUNC_NESTING - 1)
851 emsg(_(e_function_nesting_too_deep));
852 else
853 {
854 ++nesting;
855 nesting_def[nesting] = (c == 'd');
856 indent += 2;
857 }
858 }
859 }
860
861 // Check for ":append", ":change", ":insert". Not for :def.
862 p = skip_range(p, FALSE, NULL);
863 if (!vim9_function
864 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
865 || (p[0] == 'c'
866 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
867 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
868 && (STRNCMP(&p[3], "nge", 3) != 0
869 || !ASCII_ISALPHA(p[6])))))))
870 || (p[0] == 'i'
871 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
872 && (!ASCII_ISALPHA(p[2])
873 || (p[2] == 's'
874 && (!ASCII_ISALPHA(p[3])
875 || p[3] == 'e'))))))))
876 skip_until = vim_strsave((char_u *)".");
877
878 // Check for ":python <<EOF", ":tcl <<EOF", etc.
879 arg = skipwhite(skiptowhite(p));
880 if (arg[0] == '<' && arg[1] =='<'
881 && ((p[0] == 'p' && p[1] == 'y'
882 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
883 || ((p[2] == '3' || p[2] == 'x')
884 && !ASCII_ISALPHA(p[3]))))
885 || (p[0] == 'p' && p[1] == 'e'
886 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
887 || (p[0] == 't' && p[1] == 'c'
888 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
889 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
890 && !ASCII_ISALPHA(p[3]))
891 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
892 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
893 || (p[0] == 'm' && p[1] == 'z'
894 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
895 ))
896 {
897 // ":python <<" continues until a dot, like ":append"
898 p = skipwhite(arg + 2);
899 if (STRNCMP(p, "trim", 4) == 0)
900 {
901 // Ignore leading white space.
902 p = skipwhite(p + 4);
903 heredoc_trimmed = vim_strnsave(theline,
904 skipwhite(theline) - theline);
905 }
906 if (*p == NUL)
907 skip_until = vim_strsave((char_u *)".");
908 else
909 skip_until = vim_strnsave(p, skiptowhite(p) - p);
910 getline_options = GETLINE_NONE;
911 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200912 if (eap->cmdidx == CMD_def)
913 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100914 }
915
916 // Check for ":cmd v =<< [trim] EOF"
917 // and ":cmd [a, b] =<< [trim] EOF"
918 // and "lines =<< [trim] EOF" for Vim9
919 // Where "cmd" can be "let", "var", "final" or "const".
920 arg = skipwhite(skiptowhite(p));
921 if (*arg == '[')
922 arg = vim_strchr(arg, ']');
923 if (arg != NULL)
924 {
925 int found = (eap->cmdidx == CMD_def && arg[0] == '='
926 && arg[1] == '<' && arg[2] =='<');
927
928 if (!found)
929 // skip over the argument after "cmd"
930 arg = skipwhite(skiptowhite(arg));
931 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
932 && (checkforcmd(&p, "let", 2)
933 || checkforcmd(&p, "var", 3)
934 || checkforcmd(&p, "final", 5)
935 || checkforcmd(&p, "const", 5))))
936 {
937 p = skipwhite(arg + 3);
938 if (STRNCMP(p, "trim", 4) == 0)
939 {
940 // Ignore leading white space.
941 p = skipwhite(p + 4);
942 heredoc_trimmed = vim_strnsave(theline,
943 skipwhite(theline) - theline);
944 }
945 skip_until = vim_strnsave(p, skiptowhite(p) - p);
946 getline_options = GETLINE_NONE;
947 is_heredoc = TRUE;
948 }
949 }
950 }
951
952 // Add the line to the function.
953 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
954 goto theend;
955
Bram Moolenaar20677332021-06-06 17:02:53 +0200956 if (heredoc_concat_len > 0)
957 {
958 // For a :def function "python << EOF" concatenats all the lines,
959 // to be used for the instruction later.
960 ga_concat(&heredoc_ga, theline);
961 ga_concat(&heredoc_ga, (char_u *)"\n");
962 p = vim_strsave((char_u *)"");
963 }
964 else
965 {
966 // Copy the line to newly allocated memory. get_one_sourceline()
967 // allocates 250 bytes per line, this saves 80% on average. The
968 // cost is an extra alloc/free.
969 p = vim_strsave(theline);
970 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100971 if (p == NULL)
972 goto theend;
973 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
974
975 // Add NULL lines for continuation lines, so that the line count is
976 // equal to the index in the growarray.
977 while (sourcing_lnum_off-- > 0)
978 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
979
980 // Check for end of eap->arg.
981 if (line_arg != NULL && *line_arg == NUL)
982 line_arg = NULL;
983 }
984
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200985 // Return OK when no error was detected.
986 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100987 ret = OK;
988
989theend:
990 vim_free(skip_until);
991 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +0200992 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 need_wait_return |= saved_wait_return;
994 return ret;
995}
996
997/*
998 * Handle the body of a lambda. *arg points to the "{", process statements
999 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001000 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001001 * When successful "rettv" is set to a funcref.
1002 */
1003 static int
1004lambda_function_body(
1005 char_u **arg,
1006 typval_T *rettv,
1007 evalarg_T *evalarg,
1008 garray_T *newargs,
1009 garray_T *argtypes,
1010 int varargs,
1011 garray_T *default_args,
1012 char_u *ret_type)
1013{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001014 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001015 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001016 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001017 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001018 exarg_T eap;
1019 garray_T newlines;
1020 char_u *cmdline = NULL;
1021 int ret = FAIL;
1022 char_u *line_to_free = NULL;
1023 partial_T *pt;
1024 char_u *name;
1025 int lnum_save = -1;
1026 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1027
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001028 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1029 {
1030 semsg(_(e_trailing_arg), *arg + 1);
1031 return FAIL;
1032 }
1033
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001034 CLEAR_FIELD(eap);
1035 eap.cmdidx = CMD_block;
1036 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001037 eap.cmdlinep = &cmdline;
1038 eap.skip = !evaluate;
1039 if (evalarg->eval_cctx != NULL)
1040 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1041 else
1042 {
1043 eap.getline = evalarg->eval_getline;
1044 eap.cookie = evalarg->eval_cookie;
1045 }
1046
1047 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1048 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001049 {
1050 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001051 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001052 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001053
1054 // When inside a lambda must add the function lines to evalarg.eval_ga.
1055 evalarg->eval_break_count += newlines.ga_len;
1056 if (gap->ga_itemsize > 0)
1057 {
1058 int idx;
1059 char_u *last;
1060 size_t plen;
1061 char_u *pnl;
1062
1063 for (idx = 0; idx < newlines.ga_len; ++idx)
1064 {
1065 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1066
Bram Moolenaarecb66452021-05-18 15:09:18 +02001067 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001068 goto erret;
1069
1070 // Going to concatenate the lines after parsing. For an empty or
1071 // comment line use an empty string.
1072 // Insert NL characters at the start of each line, the string will
1073 // be split again later in .get_lambda_tv().
1074 if (*p == NUL || vim9_comment_start(p))
1075 p = (char_u *)"";
1076 plen = STRLEN(p);
1077 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1078 if (pnl != NULL)
1079 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001080 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1081 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001082 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001083 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001084 goto erret;
1085 if (cmdline != NULL)
1086 // more is following after the "}", which was skipped
1087 last = cmdline;
1088 else
1089 // nothing is following the "}"
1090 last = (char_u *)"}";
1091 plen = STRLEN(last);
1092 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1093 if (pnl != NULL)
1094 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001095 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1096 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001097 }
1098
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001099 if (cmdline != NULL)
1100 {
1101 // Something comes after the "}".
1102 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001103
1104 // "arg" points into cmdline, need to keep the line and free it later.
1105 vim_free(evalarg->eval_tofree_cmdline);
1106 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 }
1108 else
1109 *arg = (char_u *)"";
1110
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001111 if (!evaluate)
1112 {
1113 ret = OK;
1114 goto erret;
1115 }
1116
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001117 name = get_lambda_name();
1118 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1119 if (ufunc == NULL)
1120 goto erret;
1121 set_ufunc_name(ufunc, name);
1122 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001123 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001124 ufunc->uf_refcount = 1;
1125 ufunc->uf_args = *newargs;
1126 newargs->ga_data = NULL;
1127 ufunc->uf_def_args = *default_args;
1128 default_args->ga_data = NULL;
1129 ufunc->uf_func_type = &t_func_any;
1130
1131 // error messages are for the first function line
1132 lnum_save = SOURCING_LNUM;
1133 SOURCING_LNUM = sourcing_lnum_top;
1134
1135 // parse argument types
1136 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1137 {
1138 SOURCING_LNUM = lnum_save;
1139 goto erret;
1140 }
1141
1142 // parse the return type, if any
1143 if (parse_return_type(ufunc, ret_type) == FAIL)
1144 goto erret;
1145
1146 pt = ALLOC_CLEAR_ONE(partial_T);
1147 if (pt == NULL)
1148 goto erret;
1149 pt->pt_func = ufunc;
1150 pt->pt_refcount = 1;
1151
1152 ufunc->uf_lines = newlines;
1153 newlines.ga_data = NULL;
1154 if (sandbox)
1155 ufunc->uf_flags |= FC_SANDBOX;
1156 if (!ASCII_ISUPPER(*ufunc->uf_name))
1157 ufunc->uf_flags |= FC_VIM9;
1158 ufunc->uf_script_ctx = current_sctx;
1159 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1160 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1161 set_function_type(ufunc);
1162
1163 rettv->vval.v_partial = pt;
1164 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001165 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001166 ret = OK;
1167
1168erret:
1169 if (lnum_save >= 0)
1170 SOURCING_LNUM = lnum_save;
1171 vim_free(line_to_free);
1172 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001173 if (newargs != NULL)
1174 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001175 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001176 if (ufunc != NULL)
1177 {
1178 func_clear(ufunc, TRUE);
1179 func_free(ufunc, TRUE);
1180 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001181 return ret;
1182}
1183
1184/*
1185 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001186 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001187 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001188 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1189 */
1190 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001191get_lambda_tv(
1192 char_u **arg,
1193 typval_T *rettv,
1194 int types_optional,
1195 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001196{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001197 int evaluate = evalarg != NULL
1198 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001199 garray_T newargs;
1200 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001201 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001202 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001203 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001204 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001205 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001206 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001207 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001208 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001209 char_u *s;
1210 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001211 int *old_eval_lavars = eval_lavars_used;
1212 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001213 char_u *tofree1 = NULL;
1214 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001215 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001216 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001217 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001218
1219 if (equal_arrow && !in_vim9script())
1220 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001221
1222 ga_init(&newargs);
1223 ga_init(&newlines);
1224
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001225 // First, check if this is really a lambda expression. "->" or "=>" must
1226 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001227 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001228 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001229 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001230 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001231 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001232 {
1233 if (types_optional)
1234 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001235 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001236 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001237
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001238 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001239 if (evaluate)
1240 pnewargs = &newargs;
1241 else
1242 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001243 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001244 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001245 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001246 &varargs, &default_args,
1247 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001248 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001249 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001250 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001251 {
1252 if (types_optional)
1253 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001254 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001255 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001256 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001257 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001258
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001259 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1260 if (ret_type != NULL)
1261 {
1262 ret_type = vim_strsave(ret_type);
1263 tofree2 = ret_type;
1264 }
1265
Bram Moolenaare38eab22019-12-05 21:50:01 +01001266 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001267 if (evaluate)
1268 eval_lavars_used = &eval_lavars;
1269
Bram Moolenaar65c44152020-12-24 15:14:01 +01001270 *arg = skipwhite_and_linebreak(*arg, evalarg);
1271
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001272 // Recognize "{" as the start of a function body.
1273 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001274 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001275 if (evalarg == NULL)
1276 // cannot happen?
1277 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001278 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1279 types_optional ? &argtypes : NULL, varargs,
1280 &default_args, ret_type) == FAIL)
1281 goto errret;
1282 goto theend;
1283 }
1284 if (default_args.ga_len > 0)
1285 {
1286 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001287 goto errret;
1288 }
1289
Bram Moolenaare38eab22019-12-05 21:50:01 +01001290 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001291 start = *arg;
1292 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293 if (ret == FAIL)
1294 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001295 if (evalarg != NULL)
1296 {
1297 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001298 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001299 evalarg->eval_tofree = NULL;
1300 }
1301
Bram Moolenaar65c44152020-12-24 15:14:01 +01001302 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001303 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001304 *arg = skipwhite_and_linebreak(*arg, evalarg);
1305 if (**arg != '}')
1306 {
1307 semsg(_("E451: Expected }: %s"), *arg);
1308 goto errret;
1309 }
1310 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001311 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001312
1313 if (evaluate)
1314 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001315 int len;
1316 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001317 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001318 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001319 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001320
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001321 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001322 if (fp == NULL)
1323 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001324 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001325 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001326 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001327 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001328
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001329 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1330 if (ga_grow(&newlines, 1) == FAIL)
1331 goto errret;
1332
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001333 // If there are line breaks, we need to split up the string.
1334 line_end = vim_strchr(start, '\n');
1335 if (line_end == NULL)
1336 line_end = end;
1337
1338 // Add "return " before the expression (or the first line).
1339 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001340 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001341 if (p == NULL)
1342 goto errret;
1343 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1344 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001345 vim_strncpy(p + 7, start, line_end - start);
1346
1347 if (line_end != end)
1348 {
1349 // Add more lines, split by line breaks. Thus is used when a
1350 // lambda with { cmds } is encountered.
1351 while (*line_end == '\n')
1352 {
1353 if (ga_grow(&newlines, 1) == FAIL)
1354 goto errret;
1355 start = line_end + 1;
1356 line_end = vim_strchr(start, '\n');
1357 if (line_end == NULL)
1358 line_end = end;
1359 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1360 vim_strnsave(start, line_end - start);
1361 }
1362 }
1363
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001364 if (strstr((char *)p + 7, "a:") == NULL)
1365 // No a: variables are used for sure.
1366 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367
1368 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001369 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001370 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001371 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001372 if (types_optional)
1373 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001374 if (parse_argument_types(fp, &argtypes,
1375 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001376 goto errret;
1377 if (ret_type != NULL)
1378 {
1379 fp->uf_ret_type = parse_type(&ret_type,
1380 &fp->uf_type_list, TRUE);
1381 if (fp->uf_ret_type == NULL)
1382 goto errret;
1383 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001384 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001385 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001386 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001387
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001388 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001389 if (current_funccal != NULL && eval_lavars)
1390 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001391 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001392 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001393 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001394 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001395
1396#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001397 if (prof_def_func())
1398 func_do_profile(fp);
1399#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001400 if (sandbox)
1401 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001402 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001403 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1404 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001405 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001406 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001407 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001408 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001409
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001410 pt->pt_func = fp;
1411 pt->pt_refcount = 1;
1412 rettv->vval.v_partial = pt;
1413 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001414
1415 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001416 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001417
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001418theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001419 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001420 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001421 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001422 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001423 vim_free(tofree1);
1424 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001425 if (types_optional)
1426 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001427 return OK;
1428
1429errret:
1430 ga_clear_strings(&newargs);
1431 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001432 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001433 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001434 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001435 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001436 if (fp != NULL)
1437 vim_free(fp->uf_arg_types);
1438 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001439 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001440 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001441 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001442 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001443 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001444 vim_free(tofree1);
1445 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001446 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447 return FAIL;
1448}
1449
1450/*
1451 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1452 * name it contains, otherwise return "name".
1453 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1454 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001455 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1456 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001457 */
1458 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001459deref_func_name(
1460 char_u *name,
1461 int *lenp,
1462 partial_T **partialp,
1463 type_T **type,
1464 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465{
1466 dictitem_T *v;
1467 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001468 char_u *s = NULL;
1469 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001470
1471 if (partialp != NULL)
1472 *partialp = NULL;
1473
1474 cc = name[*lenp];
1475 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001476
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001477 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001479 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001481 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001483 if (v->di_tv.vval.v_string == NULL)
1484 {
1485 *lenp = 0;
1486 return (char_u *)""; // just in case
1487 }
1488 s = v->di_tv.vval.v_string;
1489 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001490 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001491
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001492 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001493 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001494 partial_T *pt = v->di_tv.vval.v_partial;
1495
1496 if (pt == NULL)
1497 {
1498 *lenp = 0;
1499 return (char_u *)""; // just in case
1500 }
1501 if (partialp != NULL)
1502 *partialp = pt;
1503 s = partial_name(pt);
1504 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001506
1507 if (s != NULL)
1508 {
1509 if (type != NULL && ht == get_script_local_ht())
1510 {
1511 svar_T *sv = find_typval_in_script(&v->di_tv);
1512
1513 if (sv != NULL)
1514 *type = sv->sv_type;
1515 }
1516 return s;
1517 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001518 }
1519
1520 return name;
1521}
1522
1523/*
1524 * Give an error message with a function name. Handle <SNR> things.
1525 * "ermsg" is to be passed without translation, use N_() instead of _().
1526 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001527 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528emsg_funcname(char *ermsg, char_u *name)
1529{
1530 char_u *p;
1531
1532 if (*name == K_SPECIAL)
1533 p = concat_str((char_u *)"<SNR>", name + 3);
1534 else
1535 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001536 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 if (p != name)
1538 vim_free(p);
1539}
1540
1541/*
1542 * Allocate a variable for the result of a function.
1543 * Return OK or FAIL.
1544 */
1545 int
1546get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001547 char_u *name, // name of the function
1548 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001550 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001551 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001552 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553{
1554 char_u *argp;
1555 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001556 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1557 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001558 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001559
1560 /*
1561 * Get the arguments.
1562 */
1563 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001564 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1565 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001567 // skip the '(' or ',' and possibly line breaks
1568 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1569
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570 if (*argp == ')' || *argp == ',' || *argp == NUL)
1571 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001572 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001573 {
1574 ret = FAIL;
1575 break;
1576 }
1577 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001578 // The comma should come right after the argument, but this wasn't
1579 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001580 if (vim9script)
1581 {
1582 if (*argp != ',' && *skipwhite(argp) == ',')
1583 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001584 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001585 ret = FAIL;
1586 break;
1587 }
1588 }
1589 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001590 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001591 if (*argp != ',')
1592 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001593 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1594 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001595 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001596 ret = FAIL;
1597 break;
1598 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001600 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 if (*argp == ')')
1602 ++argp;
1603 else
1604 ret = FAIL;
1605
1606 if (ret == OK)
1607 {
1608 int i = 0;
1609
1610 if (get_vim_var_nr(VV_TESTING))
1611 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001612 // Prepare for calling test_garbagecollect_now(), need to know
1613 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001614 if (funcargs.ga_itemsize == 0)
1615 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1616 for (i = 0; i < argcount; ++i)
1617 if (ga_grow(&funcargs, 1) == OK)
1618 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1619 &argvars[i];
1620 }
1621
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001622 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623
1624 funcargs.ga_len -= i;
1625 }
1626 else if (!aborting())
1627 {
1628 if (argcount == MAX_FUNC_ARGS)
1629 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1630 else
1631 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1632 }
1633
1634 while (--argcount >= 0)
1635 clear_tv(&argvars[argcount]);
1636
Bram Moolenaar8294d492020-08-10 22:40:56 +02001637 if (in_vim9script())
1638 *arg = argp;
1639 else
1640 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001641 return ret;
1642}
1643
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644/*
1645 * Return TRUE if "p" starts with "<SID>" or "s:".
1646 * Only works if eval_fname_script() returned non-zero for "p"!
1647 */
1648 static int
1649eval_fname_sid(char_u *p)
1650{
1651 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1652}
1653
1654/*
1655 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1656 * Change <SNR>123_name() to K_SNR 123_name().
1657 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1658 * (slow).
1659 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001660 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1662{
1663 int llen;
1664 char_u *fname;
1665 int i;
1666
1667 llen = eval_fname_script(name);
1668 if (llen > 0)
1669 {
1670 fname_buf[0] = K_SPECIAL;
1671 fname_buf[1] = KS_EXTRA;
1672 fname_buf[2] = (int)KE_SNR;
1673 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001674 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001676 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001677 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001678 else
1679 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001680 sprintf((char *)fname_buf + 3, "%ld_",
1681 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001682 i = (int)STRLEN(fname_buf);
1683 }
1684 }
1685 if (i + STRLEN(name + llen) < FLEN_FIXED)
1686 {
1687 STRCPY(fname_buf + i, name + llen);
1688 fname = fname_buf;
1689 }
1690 else
1691 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001692 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001694 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001695 else
1696 {
1697 *tofree = fname;
1698 mch_memmove(fname, fname_buf, (size_t)i);
1699 STRCPY(fname + i, name + llen);
1700 }
1701 }
1702 }
1703 else
1704 fname = name;
1705 return fname;
1706}
1707
1708/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001709 * Find a function "name" in script "sid".
1710 */
1711 static ufunc_T *
1712find_func_with_sid(char_u *name, int sid)
1713{
1714 hashitem_T *hi;
1715 char_u buffer[200];
1716
1717 buffer[0] = K_SPECIAL;
1718 buffer[1] = KS_EXTRA;
1719 buffer[2] = (int)KE_SNR;
1720 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1721 (long)sid, name);
1722 hi = hash_find(&func_hashtab, buffer);
1723 if (!HASHITEM_EMPTY(hi))
1724 return HI2UF(hi);
1725
1726 return NULL;
1727}
1728
1729/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001730 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001731 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 * Return NULL for unknown function.
1733 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001734 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001735find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001736{
1737 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001738 ufunc_T *func;
1739 imported_T *imported;
1740
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001741 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001742 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001743 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001744 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001745 int find_script_local = in_vim9script()
1746 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001747
Bram Moolenaar95006e32020-08-29 17:47:08 +02001748 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001749 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001750 // Find script-local function before global one.
1751 func = find_func_with_sid(name, current_sctx.sc_sid);
1752 if (func != NULL)
1753 return func;
1754 }
1755
Bram Moolenaarefa94442020-08-08 22:16:00 +02001756 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001757 && name[1] == KS_EXTRA
1758 && name[2] == KE_SNR)
1759 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001760 // Caller changes s: to <SNR>99_name.
1761
1762 after_script = name + 3;
1763 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001764 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001765 ++after_script;
1766 else
1767 after_script = NULL;
1768 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001769 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001770 {
1771 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001772 if (after_script != NULL && sid != current_sctx.sc_sid)
1773 imported = find_imported_in_script(after_script, 0, sid);
1774 else
1775 imported = find_imported(after_script == NULL
1776 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001777 if (imported != NULL && imported->imp_funcname != NULL)
1778 {
1779 hi = hash_find(&func_hashtab, imported->imp_funcname);
1780 if (!HASHITEM_EMPTY(hi))
1781 return HI2UF(hi);
1782 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001783 }
1784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785
Bram Moolenaara26b9702020-04-18 19:53:28 +02001786 hi = hash_find(&func_hashtab,
1787 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 if (!HASHITEM_EMPTY(hi))
1789 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001790
1791 return NULL;
1792}
1793
1794/*
1795 * Find a function by name, return pointer to it in ufuncs.
1796 * "cctx" is passed in a :def function to find imported functions.
1797 * Return NULL for unknown or dead function.
1798 */
1799 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001800find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001801{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001802 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001803
1804 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1805 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001806 return NULL;
1807}
1808
1809/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001810 * Return TRUE if "ufunc" is a global function.
1811 */
1812 int
1813func_is_global(ufunc_T *ufunc)
1814{
1815 return ufunc->uf_name[0] != K_SPECIAL;
1816}
1817
1818/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001819 * Copy the function name of "fp" to buffer "buf".
1820 * "buf" must be able to hold the function name plus three bytes.
1821 * Takes care of script-local function names.
1822 */
1823 static void
1824cat_func_name(char_u *buf, ufunc_T *fp)
1825{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001826 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827 {
1828 STRCPY(buf, "<SNR>");
1829 STRCAT(buf, fp->uf_name + 3);
1830 }
1831 else
1832 STRCPY(buf, fp->uf_name);
1833}
1834
1835/*
1836 * Add a number variable "name" to dict "dp" with value "nr".
1837 */
1838 static void
1839add_nr_var(
1840 dict_T *dp,
1841 dictitem_T *v,
1842 char *name,
1843 varnumber_T nr)
1844{
1845 STRCPY(v->di_key, name);
1846 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1847 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1848 v->di_tv.v_type = VAR_NUMBER;
1849 v->di_tv.v_lock = VAR_FIXED;
1850 v->di_tv.vval.v_number = nr;
1851}
1852
1853/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001854 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001856 static void
1857free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001859 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001860
1861 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1862 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001863 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001864
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001865 // When garbage collecting a funccall_T may be freed before the
1866 // function that references it, clear its uf_scoped field.
1867 // The function may have been redefined and point to another
1868 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001869 if (fp != NULL && fp->uf_scoped == fc)
1870 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001871 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001872 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001874 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875 vim_free(fc);
1876}
1877
1878/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001879 * Free "fc" and what it contains.
1880 * Can be called only when "fc" is kept beyond the period of it called,
1881 * i.e. after cleanup_function_call(fc).
1882 */
1883 static void
1884free_funccal_contents(funccall_T *fc)
1885{
1886 listitem_T *li;
1887
1888 // Free all l: variables.
1889 vars_clear(&fc->l_vars.dv_hashtab);
1890
1891 // Free all a: variables.
1892 vars_clear(&fc->l_avars.dv_hashtab);
1893
1894 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001895 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001896 clear_tv(&li->li_tv);
1897
1898 free_funccal(fc);
1899}
1900
1901/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001902 * Handle the last part of returning from a function: free the local hashtable.
1903 * Unless it is still in use by a closure.
1904 */
1905 static void
1906cleanup_function_call(funccall_T *fc)
1907{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001908 int may_free_fc = fc->fc_refcount <= 0;
1909 int free_fc = TRUE;
1910
Bram Moolenaar6914c642017-04-01 21:21:30 +02001911 current_funccal = fc->caller;
1912
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001913 // Free all l: variables if not referred.
1914 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1915 vars_clear(&fc->l_vars.dv_hashtab);
1916 else
1917 free_fc = FALSE;
1918
1919 // If the a:000 list and the l: and a: dicts are not referenced and
1920 // there is no closure using it, we can free the funccall_T and what's
1921 // in it.
1922 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1923 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001924 else
1925 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001926 int todo;
1927 hashitem_T *hi;
1928 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001929
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001930 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001931
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001932 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001933 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1934 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1935 {
1936 if (!HASHITEM_EMPTY(hi))
1937 {
1938 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001939 di = HI2DI(hi);
1940 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001941 }
1942 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001943 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001944
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001945 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1946 fc->l_varlist.lv_first = NULL;
1947 else
1948 {
1949 listitem_T *li;
1950
1951 free_fc = FALSE;
1952
1953 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001954 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001955 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001956 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001957
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001958 if (free_fc)
1959 free_funccal(fc);
1960 else
1961 {
1962 static int made_copy = 0;
1963
1964 // "fc" is still in use. This can happen when returning "a:000",
1965 // assigning "l:" to a global variable or defining a closure.
1966 // Link "fc" in the list for garbage collection later.
1967 fc->caller = previous_funccal;
1968 previous_funccal = fc;
1969
1970 if (want_garbage_collect)
1971 // If garbage collector is ready, clear count.
1972 made_copy = 0;
1973 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001974 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001975 // We have made a lot of copies, worth 4 Mbyte. This can happen
1976 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001977 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001978 // too much memory.
1979 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001980 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001981 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001982 }
1983}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001984
1985/*
1986 * There are two kinds of function names:
1987 * 1. ordinary names, function defined with :function or :def
1988 * 2. numbered functions and lambdas
1989 * For the first we only count the name stored in func_hashtab as a reference,
1990 * using function() does not count as a reference, because the function is
1991 * looked up by name.
1992 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001993 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001994func_name_refcount(char_u *name)
1995{
1996 return isdigit(*name) || *name == '<';
1997}
1998
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001999/*
2000 * Unreference "fc": decrement the reference count and free it when it
2001 * becomes zero. "fp" is detached from "fc".
2002 * When "force" is TRUE we are exiting.
2003 */
2004 static void
2005funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2006{
2007 funccall_T **pfc;
2008 int i;
2009
2010 if (fc == NULL)
2011 return;
2012
2013 if (--fc->fc_refcount <= 0 && (force || (
2014 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2015 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2016 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2017 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2018 {
2019 if (fc == *pfc)
2020 {
2021 *pfc = fc->caller;
2022 free_funccal_contents(fc);
2023 return;
2024 }
2025 }
2026 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2027 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2028 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2029}
2030
2031/*
2032 * Remove the function from the function hashtable. If the function was
2033 * deleted while it still has references this was already done.
2034 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2035 */
2036 static int
2037func_remove(ufunc_T *fp)
2038{
2039 hashitem_T *hi;
2040
2041 // Return if it was already virtually deleted.
2042 if (fp->uf_flags & FC_DEAD)
2043 return FALSE;
2044
2045 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2046 if (!HASHITEM_EMPTY(hi))
2047 {
2048 // When there is a def-function index do not actually remove the
2049 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002050 // Do remove it when it's a copy.
2051 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002052 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002053 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002054 return FALSE;
2055 }
2056 hash_remove(&func_hashtab, hi);
2057 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002058 return TRUE;
2059 }
2060 return FALSE;
2061}
2062
2063 static void
2064func_clear_items(ufunc_T *fp)
2065{
2066 ga_clear_strings(&(fp->uf_args));
2067 ga_clear_strings(&(fp->uf_def_args));
2068 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002069 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002070 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002071 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002072 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002073
2074 // Increment the refcount of this function to avoid it being freed
2075 // recursively when the partial is freed.
2076 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002077 partial_unref(fp->uf_partial);
2078 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002079 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002080
2081#ifdef FEAT_LUA
2082 if (fp->uf_cb_free != NULL)
2083 {
2084 fp->uf_cb_free(fp->uf_cb_state);
2085 fp->uf_cb_free = NULL;
2086 }
2087
2088 fp->uf_cb_state = NULL;
2089 fp->uf_cb = NULL;
2090#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002091#ifdef FEAT_PROFILE
2092 VIM_CLEAR(fp->uf_tml_count);
2093 VIM_CLEAR(fp->uf_tml_total);
2094 VIM_CLEAR(fp->uf_tml_self);
2095#endif
2096}
2097
2098/*
2099 * Free all things that a function contains. Does not free the function
2100 * itself, use func_free() for that.
2101 * When "force" is TRUE we are exiting.
2102 */
2103 static void
2104func_clear(ufunc_T *fp, int force)
2105{
2106 if (fp->uf_cleared)
2107 return;
2108 fp->uf_cleared = TRUE;
2109
2110 // clear this function
2111 func_clear_items(fp);
2112 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002113 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002114}
2115
2116/*
2117 * Free a function and remove it from the list of functions. Does not free
2118 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002119 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002120 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002121 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002122 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002123func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002124{
2125 // Only remove it when not done already, otherwise we would remove a newer
2126 // version of the function with the same name.
2127 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2128 func_remove(fp);
2129
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002130 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002131 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002132 if (fp->uf_dfunc_idx > 0)
2133 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002134 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002135 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002136 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002137 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002138 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002139}
2140
2141/*
2142 * Free all things that a function contains and free the function itself.
2143 * When "force" is TRUE we are exiting.
2144 */
2145 static void
2146func_clear_free(ufunc_T *fp, int force)
2147{
2148 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002149 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2150 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002151 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002152 else
2153 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002154}
2155
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002156/*
2157 * Copy already defined function "lambda" to a new function with name "global".
2158 * This is for when a compiled function defines a global function.
2159 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002160 int
2161copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002162{
2163 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002164 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002165
2166 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002167 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002168 semsg(_(e_lambda_function_not_found_str), lambda);
2169 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002170 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002171
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002172 fp = find_func(global, TRUE, NULL);
2173 if (fp != NULL)
2174 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002175 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002176 semsg(_(e_funcexts), global);
2177 return FAIL;
2178 }
2179
2180 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2181 if (fp == NULL)
2182 return FAIL;
2183
2184 fp->uf_varargs = ufunc->uf_varargs;
2185 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2186 fp->uf_def_status = ufunc->uf_def_status;
2187 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2188 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2189 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2190 == FAIL
2191 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2192 goto failed;
2193
2194 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2195 : vim_strsave(ufunc->uf_name_exp);
2196 if (ufunc->uf_arg_types != NULL)
2197 {
2198 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2199 if (fp->uf_arg_types == NULL)
2200 goto failed;
2201 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2202 sizeof(type_T *) * fp->uf_args.ga_len);
2203 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002204 if (ufunc->uf_va_name != NULL)
2205 {
2206 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2207 if (fp->uf_va_name == NULL)
2208 goto failed;
2209 }
2210 fp->uf_ret_type = ufunc->uf_ret_type;
2211
2212 fp->uf_refcount = 1;
2213 STRCPY(fp->uf_name, global);
2214 hash_add(&func_hashtab, UF2HIKEY(fp));
2215
2216 // the referenced dfunc_T is now used one more time
2217 link_def_function(fp);
2218
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002219 // Create a partial to store the context of the function where it was
2220 // instantiated. Only needs to be done once. Do this on the original
2221 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002222 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2223 {
2224 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2225
2226 if (pt == NULL)
2227 goto failed;
2228 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002229 {
2230 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002231 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002232 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002233 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002234 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002235 }
2236
2237 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002238
2239failed:
2240 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002241 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002242}
2243
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002244static int funcdepth = 0;
2245
2246/*
2247 * Increment the function call depth count.
2248 * Return FAIL when going over 'maxfuncdepth'.
2249 * Otherwise return OK, must call funcdepth_decrement() later!
2250 */
2251 int
2252funcdepth_increment(void)
2253{
2254 if (funcdepth >= p_mfd)
2255 {
2256 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2257 return FAIL;
2258 }
2259 ++funcdepth;
2260 return OK;
2261}
2262
2263 void
2264funcdepth_decrement(void)
2265{
2266 --funcdepth;
2267}
2268
2269/*
2270 * Get the current function call depth.
2271 */
2272 int
2273funcdepth_get(void)
2274{
2275 return funcdepth;
2276}
2277
2278/*
2279 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002280 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002281 * times as funcdepth_increment().
2282 */
2283 void
2284funcdepth_restore(int depth)
2285{
2286 funcdepth = depth;
2287}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002288
2289/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002290 * Call a user function.
2291 */
2292 static void
2293call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002294 ufunc_T *fp, // pointer to function
2295 int argcount, // nr of args
2296 typval_T *argvars, // arguments
2297 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002298 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002299 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002300{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002301 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002302 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002303 funccall_T *fc;
2304 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002305 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002306 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002307 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002308 int i;
2309 int ai;
2310 int islambda = FALSE;
2311 char_u numbuf[NUMBUFLEN];
2312 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002313 typval_T *tv_to_free[MAX_FUNC_ARGS];
2314 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002315#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002316 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002317#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002318 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002319
Bram Moolenaarb2049902021-01-24 12:53:53 +01002320#ifdef FEAT_PROFILE
2321 CLEAR_FIELD(profile_info);
2322#endif
2323
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002324 // If depth of calling is getting too high, don't execute the function.
2325 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002326 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 rettv->v_type = VAR_NUMBER;
2328 rettv->vval.v_number = -1;
2329 return;
2330 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002331
Bram Moolenaare38eab22019-12-05 21:50:01 +01002332 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002334 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002335 if (fc == NULL)
2336 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002337 fc->caller = current_funccal;
2338 current_funccal = fc;
2339 fc->func = fp;
2340 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002342 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2344 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002345 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002346 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002347 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002349 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002350 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002351#ifdef FEAT_PROFILE
2352 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2353#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002354 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002355#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002356 if (do_profiling == PROF_YES)
2357 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002358#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002359 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002360 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002361#ifdef FEAT_PROFILE
2362 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002363 || (caller != NULL && caller->uf_profiling)))
2364 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002365#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002366 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002367 free_funccal(fc);
2368 return;
2369 }
2370
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2372 islambda = TRUE;
2373
2374 /*
2375 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2376 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2377 * each argument variable and saves a lot of time.
2378 */
2379 /*
2380 * Init l: variables.
2381 */
2382 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2383 if (selfdict != NULL)
2384 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002385 // Set l:self to "selfdict". Use "name" to avoid a warning from
2386 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002387 v = &fc->fixvar[fixvar_idx++].var;
2388 name = v->di_key;
2389 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002390 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002391 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2392 v->di_tv.v_type = VAR_DICT;
2393 v->di_tv.v_lock = 0;
2394 v->di_tv.vval.v_dict = selfdict;
2395 ++selfdict->dv_refcount;
2396 }
2397
2398 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002399 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002400 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401 * Set a:000 to a list with room for the "..." arguments.
2402 */
2403 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002404 if ((fp->uf_flags & FC_NOARGS) == 0)
2405 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002406 (varnumber_T)(argcount >= fp->uf_args.ga_len
2407 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002408 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002409 if ((fp->uf_flags & FC_NOARGS) == 0)
2410 {
2411 // Use "name" to avoid a warning from some compiler that checks the
2412 // destination size.
2413 v = &fc->fixvar[fixvar_idx++].var;
2414 name = v->di_key;
2415 STRCPY(name, "000");
2416 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2417 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2418 v->di_tv.v_type = VAR_LIST;
2419 v->di_tv.v_lock = VAR_FIXED;
2420 v->di_tv.vval.v_list = &fc->l_varlist;
2421 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002422 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2424 fc->l_varlist.lv_lock = VAR_FIXED;
2425
2426 /*
2427 * Set a:firstline to "firstline" and a:lastline to "lastline".
2428 * Set a:name to named arguments.
2429 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002430 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002431 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002432 if ((fp->uf_flags & FC_NOARGS) == 0)
2433 {
2434 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002435 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002436 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002437 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002438 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002439 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 {
2441 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002442 typval_T def_rettv;
2443 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444
2445 ai = i - fp->uf_args.ga_len;
2446 if (ai < 0)
2447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002448 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 name = FUNCARG(fp, i);
2450 if (islambda)
2451 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002452
2453 // evaluate named argument default expression
2454 isdefault = ai + fp->uf_def_args.ga_len >= 0
2455 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2456 && argvars[i].vval.v_number == VVAL_NONE));
2457 if (isdefault)
2458 {
2459 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002460
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002461 def_rettv.v_type = VAR_NUMBER;
2462 def_rettv.vval.v_number = -1;
2463
2464 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2465 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002466 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002467 {
2468 default_arg_err = 1;
2469 break;
2470 }
2471 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472 }
2473 else
2474 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002475 if ((fp->uf_flags & FC_NOARGS) != 0)
2476 // Bail out if no a: arguments used (in lambda).
2477 break;
2478
Bram Moolenaare38eab22019-12-05 21:50:01 +01002479 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 sprintf((char *)numbuf, "%d", ai + 1);
2481 name = numbuf;
2482 }
2483 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2484 {
2485 v = &fc->fixvar[fixvar_idx++].var;
2486 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002487 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002488 }
2489 else
2490 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002491 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002492 if (v == NULL)
2493 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002494 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002497 // Note: the values are copied directly to avoid alloc/free.
2498 // "argvars" must have VAR_FIXED for v_lock.
2499 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 v->di_tv.v_lock = VAR_FIXED;
2501
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002502 if (isdefault)
2503 // Need to free this later, no matter where it's stored.
2504 tv_to_free[tv_to_free_len++] = &v->di_tv;
2505
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 if (addlocal)
2507 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002508 // Named arguments should be accessed without the "a:" prefix in
2509 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002510 copy_tv(&v->di_tv, &v->di_tv);
2511 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002513 else
2514 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515
2516 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2517 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002518 listitem_T *li = &fc->l_listitems[ai];
2519
2520 li->li_tv = argvars[i];
2521 li->li_tv.v_lock = VAR_FIXED;
2522 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 }
2524 }
2525
Bram Moolenaare38eab22019-12-05 21:50:01 +01002526 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002527 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002528
2529 if (fp->uf_flags & FC_SANDBOX)
2530 {
2531 using_sandbox = TRUE;
2532 ++sandbox;
2533 }
2534
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002535 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002536 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002537 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002539 ++no_wait_return;
2540 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002542 smsg(_("calling %s"), SOURCING_NAME);
2543 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002545 char_u buf[MSG_BUF_LEN];
2546 char_u numbuf2[NUMBUFLEN];
2547 char_u *tofree;
2548 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002550 msg_puts("(");
2551 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002553 if (i > 0)
2554 msg_puts(", ");
2555 if (argvars[i].v_type == VAR_NUMBER)
2556 msg_outnum((long)argvars[i].vval.v_number);
2557 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002559 // Do not want errors such as E724 here.
2560 ++emsg_off;
2561 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2562 --emsg_off;
2563 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002565 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002567 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2568 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002570 msg_puts((char *)s);
2571 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002572 }
2573 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002575 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002577 msg_puts("\n"); // don't overwrite this either
2578
2579 verbose_leave_scroll();
2580 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002581 }
2582#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002583 if (do_profiling == PROF_YES)
2584 profile_may_start_func(&profile_info, fp,
2585 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586#endif
2587
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002588 save_current_sctx = current_sctx;
2589 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590 save_did_emsg = did_emsg;
2591 did_emsg = FALSE;
2592
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002593 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2594 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002595 else if (islambda)
2596 {
2597 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2598
2599 // A Lambda always has the command "return {expr}". It is much faster
2600 // to evaluate {expr} directly.
2601 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002602 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002603 --ex_nesting_level;
2604 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002605 else
2606 // call do_cmdline() to execute the lines
2607 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2609
2610 --RedrawingDisabled;
2611
Bram Moolenaare38eab22019-12-05 21:50:01 +01002612 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2614 {
2615 clear_tv(rettv);
2616 rettv->v_type = VAR_NUMBER;
2617 rettv->vval.v_number = -1;
2618 }
2619
2620#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002621 if (do_profiling == PROF_YES)
2622 {
2623 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2624
2625 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2626 profile_may_end_func(&profile_info, fp, caller);
2627 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628#endif
2629
Bram Moolenaare38eab22019-12-05 21:50:01 +01002630 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631 if (p_verbose >= 12)
2632 {
2633 ++no_wait_return;
2634 verbose_enter_scroll();
2635
2636 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002637 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002639 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 (long)fc->rettv->vval.v_number);
2641 else
2642 {
2643 char_u buf[MSG_BUF_LEN];
2644 char_u numbuf2[NUMBUFLEN];
2645 char_u *tofree;
2646 char_u *s;
2647
Bram Moolenaare38eab22019-12-05 21:50:01 +01002648 // The value may be very long. Skip the middle part, so that we
2649 // have some idea how it starts and ends. smsg() would always
2650 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 ++emsg_off;
2652 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2653 --emsg_off;
2654 if (s != NULL)
2655 {
2656 if (vim_strsize(s) > MSG_BUF_CLEN)
2657 {
2658 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2659 s = buf;
2660 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002661 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 vim_free(tofree);
2663 }
2664 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002665 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666
2667 verbose_leave_scroll();
2668 --no_wait_return;
2669 }
2670
Bram Moolenaare31ee862020-01-07 20:59:34 +01002671 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002672 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002673 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674#ifdef FEAT_PROFILE
2675 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002676 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002678 if (using_sandbox)
2679 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002681 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 {
2683 ++no_wait_return;
2684 verbose_enter_scroll();
2685
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002686 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002687 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688
2689 verbose_leave_scroll();
2690 --no_wait_return;
2691 }
2692
2693 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002694 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002695 for (i = 0; i < tv_to_free_len; ++i)
2696 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002697 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698}
2699
2700/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002701 * Check the argument count for user function "fp".
2702 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2703 */
2704 int
2705check_user_func_argcount(ufunc_T *fp, int argcount)
2706{
2707 int regular_args = fp->uf_args.ga_len;
2708
2709 if (argcount < regular_args - fp->uf_def_args.ga_len)
2710 return FCERR_TOOFEW;
2711 else if (!has_varargs(fp) && argcount > regular_args)
2712 return FCERR_TOOMANY;
2713 return FCERR_UNKNOWN;
2714}
2715
2716/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002717 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002718 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002719 int
2720call_user_func_check(
2721 ufunc_T *fp,
2722 int argcount,
2723 typval_T *argvars,
2724 typval_T *rettv,
2725 funcexe_T *funcexe,
2726 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002727{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002728 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002729
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002730 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2731 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002732 error = check_user_func_argcount(fp, argcount);
2733 if (error != FCERR_UNKNOWN)
2734 return error;
2735 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002736 error = FCERR_DICT;
2737 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002738 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002739 int did_save_redo = FALSE;
2740 save_redo_T save_redo;
2741
2742 /*
2743 * Call the user function.
2744 * Save and restore search patterns, script variables and
2745 * redo buffer.
2746 */
2747 save_search_patterns();
2748 if (!ins_compl_active())
2749 {
2750 saveRedobuff(&save_redo);
2751 did_save_redo = TRUE;
2752 }
2753 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002754 call_user_func(fp, argcount, argvars, rettv, funcexe,
2755 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002756 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2757 // Function was unreferenced while being used, free it now.
2758 func_clear_free(fp, FALSE);
2759 if (did_save_redo)
2760 restoreRedobuff(&save_redo);
2761 restore_search_patterns();
2762 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002763 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002764 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002765}
2766
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002767static funccal_entry_T *funccal_stack = NULL;
2768
2769/*
2770 * Save the current function call pointer, and set it to NULL.
2771 * Used when executing autocommands and for ":source".
2772 */
2773 void
2774save_funccal(funccal_entry_T *entry)
2775{
2776 entry->top_funccal = current_funccal;
2777 entry->next = funccal_stack;
2778 funccal_stack = entry;
2779 current_funccal = NULL;
2780}
2781
2782 void
2783restore_funccal(void)
2784{
2785 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002786 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002787 else
2788 {
2789 current_funccal = funccal_stack->top_funccal;
2790 funccal_stack = funccal_stack->next;
2791 }
2792}
2793
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002794 funccall_T *
2795get_current_funccal(void)
2796{
2797 return current_funccal;
2798}
2799
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002800/*
2801 * Mark all functions of script "sid" as deleted.
2802 */
2803 void
2804delete_script_functions(int sid)
2805{
2806 hashitem_T *hi;
2807 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002808 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002809 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002810 size_t len;
2811
2812 buf[0] = K_SPECIAL;
2813 buf[1] = KS_EXTRA;
2814 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002815 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002816 len = STRLEN(buf);
2817
Bram Moolenaarce658352020-07-31 23:47:12 +02002818 while (todo > 0)
2819 {
2820 todo = func_hashtab.ht_used;
2821 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2822 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002823 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002824 fp = HI2UF(hi);
2825 if (STRNCMP(fp->uf_name, buf, len) == 0)
2826 {
2827 int changed = func_hashtab.ht_changed;
2828
2829 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002830
2831 if (fp->uf_calls > 0)
2832 {
2833 // Function is executing, don't free it but do remove
2834 // it from the hashtable.
2835 if (func_remove(fp))
2836 fp->uf_refcount--;
2837 }
2838 else
2839 {
2840 func_clear(fp, TRUE);
2841 // When clearing a function another function can be
2842 // cleared as a side effect. When that happens start
2843 // over.
2844 if (changed != func_hashtab.ht_changed)
2845 break;
2846 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002847 }
2848 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002849 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002850 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002851}
2852
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002853#if defined(EXITFREE) || defined(PROTO)
2854 void
2855free_all_functions(void)
2856{
2857 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002858 ufunc_T *fp;
2859 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002860 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002861 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862
Bram Moolenaare38eab22019-12-05 21:50:01 +01002863 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002864 while (current_funccal != NULL)
2865 {
2866 clear_tv(current_funccal->rettv);
2867 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002868 if (current_funccal == NULL && funccal_stack != NULL)
2869 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002870 }
2871
Bram Moolenaare38eab22019-12-05 21:50:01 +01002872 // First clear what the functions contain. Since this may lower the
2873 // reference count of a function, it may also free a function and change
2874 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002875 while (todo > 0)
2876 {
2877 todo = func_hashtab.ht_used;
2878 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2879 if (!HASHITEM_EMPTY(hi))
2880 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 // clear the def function index now
2882 fp = HI2UF(hi);
2883 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002884 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002885
Bram Moolenaare38eab22019-12-05 21:50:01 +01002886 // Only free functions that are not refcounted, those are
2887 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002888 if (func_name_refcount(fp->uf_name))
2889 ++skipped;
2890 else
2891 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002892 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002893 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002894 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002895 {
2896 skipped = 0;
2897 break;
2898 }
2899 }
2900 --todo;
2901 }
2902 }
2903
Bram Moolenaare38eab22019-12-05 21:50:01 +01002904 // Now actually free the functions. Need to start all over every time,
2905 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002906 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002907 while (func_hashtab.ht_used > skipped)
2908 {
2909 todo = func_hashtab.ht_used;
2910 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 if (!HASHITEM_EMPTY(hi))
2912 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002913 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002914 // Only free functions that are not refcounted, those are
2915 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002916 fp = HI2UF(hi);
2917 if (func_name_refcount(fp->uf_name))
2918 ++skipped;
2919 else
2920 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002921 if (func_free(fp, FALSE) == OK)
2922 {
2923 skipped = 0;
2924 break;
2925 }
2926 // did not actually free it
2927 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002928 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002929 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002930 }
2931 if (skipped == 0)
2932 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002933
2934 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002935}
2936#endif
2937
2938/*
2939 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002940 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941 * "len" is the length of "name", or -1 for NUL terminated.
2942 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002943 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002944builtin_function(char_u *name, int len)
2945{
2946 char_u *p;
2947
Bram Moolenaara26b9702020-04-18 19:53:28 +02002948 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949 return FALSE;
2950 p = vim_strchr(name, AUTOLOAD_CHAR);
2951 return p == NULL || (len > 0 && p > name + len);
2952}
2953
2954 int
2955func_call(
2956 char_u *name,
2957 typval_T *args,
2958 partial_T *partial,
2959 dict_T *selfdict,
2960 typval_T *rettv)
2961{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002962 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002963 listitem_T *item;
2964 typval_T argv[MAX_FUNC_ARGS + 1];
2965 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966 int r = 0;
2967
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002968 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002969 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970 {
2971 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2972 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002973 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002974 break;
2975 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002976 // Make a copy of each argument. This is needed to be able to set
2977 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 copy_tv(&item->li_tv, &argv[argc++]);
2979 }
2980
2981 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002982 {
2983 funcexe_T funcexe;
2984
Bram Moolenaara80faa82020-04-12 19:37:17 +02002985 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002986 funcexe.firstline = curwin->w_cursor.lnum;
2987 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002988 funcexe.evaluate = TRUE;
2989 funcexe.partial = partial;
2990 funcexe.selfdict = selfdict;
2991 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2992 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993
Bram Moolenaare38eab22019-12-05 21:50:01 +01002994 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 while (argc > 0)
2996 clear_tv(&argv[--argc]);
2997
2998 return r;
2999}
3000
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003001static int callback_depth = 0;
3002
3003 int
3004get_callback_depth(void)
3005{
3006 return callback_depth;
3007}
3008
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003010 * Invoke call_func() with a callback.
3011 */
3012 int
3013call_callback(
3014 callback_T *callback,
3015 int len, // length of "name" or -1 to use strlen()
3016 typval_T *rettv, // return value goes here
3017 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003018 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003019 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003020{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003021 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003022 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003023
Bram Moolenaara80faa82020-04-12 19:37:17 +02003024 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003025 funcexe.evaluate = TRUE;
3026 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003027 ++callback_depth;
3028 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3029 --callback_depth;
3030 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003031}
3032
3033/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003034 * Give an error message for the result of a function.
3035 * Nothing if "error" is FCERR_NONE.
3036 */
3037 void
3038user_func_error(int error, char_u *name)
3039{
3040 switch (error)
3041 {
3042 case FCERR_UNKNOWN:
3043 emsg_funcname(e_unknownfunc, name);
3044 break;
3045 case FCERR_NOTMETHOD:
3046 emsg_funcname(
3047 N_("E276: Cannot use function as a method: %s"), name);
3048 break;
3049 case FCERR_DELETED:
3050 emsg_funcname(N_(e_func_deleted), name);
3051 break;
3052 case FCERR_TOOMANY:
3053 emsg_funcname((char *)e_toomanyarg, name);
3054 break;
3055 case FCERR_TOOFEW:
3056 emsg_funcname((char *)e_toofewarg, name);
3057 break;
3058 case FCERR_SCRIPT:
3059 emsg_funcname(
3060 N_("E120: Using <SID> not in a script context: %s"), name);
3061 break;
3062 case FCERR_DICT:
3063 emsg_funcname(
3064 N_("E725: Calling dict function without Dictionary: %s"),
3065 name);
3066 break;
3067 }
3068}
3069
3070/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003071 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003072 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073 * Return FAIL when the function can't be called, OK otherwise.
3074 * Also returns OK when an error was encountered while executing the function.
3075 */
3076 int
3077call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003078 char_u *funcname, // name of the function
3079 int len, // length of "name" or -1 to use strlen()
3080 typval_T *rettv, // return value goes here
3081 int argcount_in, // number of "argvars"
3082 typval_T *argvars_in, // vars for arguments, must have "argcount"
3083 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003084 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085{
3086 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003087 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003088 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003089 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003090 char_u fname_buf[FLEN_FIXED + 1];
3091 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003092 char_u *fname = NULL;
3093 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003094 int argcount = argcount_in;
3095 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003096 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003097 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3098 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003100 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003101 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003102
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003103 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3104 // even when call_func() returns FAIL.
3105 rettv->v_type = VAR_UNKNOWN;
3106
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003107 if (partial != NULL)
3108 fp = partial->pt_func;
3109 if (fp == NULL)
3110 {
3111 // Make a copy of the name, if it comes from a funcref variable it
3112 // could be changed or deleted in the called function.
3113 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3114 if (name == NULL)
3115 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003117 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3118 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003120 if (funcexe->doesrange != NULL)
3121 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122
3123 if (partial != NULL)
3124 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003125 // When the function has a partial with a dict and there is a dict
3126 // argument, use the dict argument. That is backwards compatible.
3127 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003128 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003130 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 {
3132 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003133 {
3134 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3135 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003136 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003137 goto theend;
3138 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003140 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141 for (i = 0; i < argcount_in; ++i)
3142 argv[i + argv_clear] = argvars_in[i];
3143 argvars = argv;
3144 argcount = partial->pt_argc + argcount_in;
3145 }
3146 }
3147
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003148 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3149 {
3150 // Check that the argument types are OK for the types of the funcref.
3151 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003152 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003153 error = FCERR_OTHER;
3154 }
3155
Bram Moolenaaref140542019-12-31 21:27:13 +01003156 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157 {
3158 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003159 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160
Bram Moolenaar333894b2020-08-01 18:53:07 +02003161 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003162 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003163 {
3164 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003166 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167
Bram Moolenaare38eab22019-12-05 21:50:01 +01003168 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003169 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003170 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003171
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003172 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003173 {
3174 /*
3175 * User defined function.
3176 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003177 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003178 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179
Bram Moolenaare38eab22019-12-05 21:50:01 +01003180 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003181 if (fp == NULL
3182 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003183 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 && !aborting())
3185 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003186 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003187 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003188 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003189 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003190 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3191 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003192 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003193 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003195 if (fp == NULL)
3196 {
3197 char_u *p = untrans_function_name(rfname);
3198
3199 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003200 // Don't do this if the name starts with "s:".
3201 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003202 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003203 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003204
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003205 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003206 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003207#ifdef FEAT_LUA
3208 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3209 {
3210 cfunc_T cb = fp->uf_cb;
3211
3212 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3213 }
3214#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003215 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003217 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003218 // postponed filling in the arguments, do it now
3219 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003220 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003221
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003222 if (funcexe->basetv != NULL)
3223 {
3224 // Method call: base->Method()
3225 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3226 argv[0] = *funcexe->basetv;
3227 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003228 argvars = argv;
3229 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003230 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003231
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003232 error = call_user_func_check(fp, argcount, argvars, rettv,
3233 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 }
3235 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003236 else if (funcexe->basetv != NULL)
3237 {
3238 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003239 * expr->method(): Find the method name in the table, call its
3240 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003241 */
3242 error = call_internal_method(fname, argcount, argvars, rettv,
3243 funcexe->basetv);
3244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 else
3246 {
3247 /*
3248 * Find the function name in the table, call its implementation.
3249 */
3250 error = call_internal_func(fname, argcount, argvars, rettv);
3251 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003252
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253 /*
3254 * The function call (or "FuncUndefined" autocommand sequence) might
3255 * have been aborted by an error, an interrupt, or an explicitly thrown
3256 * exception that has not been caught so far. This situation can be
3257 * tested for by calling aborting(). For an error in an internal
3258 * function or for the "E132" error in call_user_func(), however, the
3259 * throw point at which the "force_abort" flag (temporarily reset by
3260 * emsg()) is normally updated has not been reached yet. We need to
3261 * update that flag first to make aborting() reliable.
3262 */
3263 update_force_abort();
3264 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003265 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003266 ret = OK;
3267
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003268theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 /*
3270 * Report an error unless the argument evaluation or function call has been
3271 * cancelled due to an aborting error, an interrupt, or an exception.
3272 */
3273 if (!aborting())
3274 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003275 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003276 }
3277
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003278 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003279 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003280 clear_tv(&argv[--argv_clear + argv_base]);
3281
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282 vim_free(tofree);
3283 vim_free(name);
3284
3285 return ret;
3286}
3287
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003288 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003289printable_func_name(ufunc_T *fp)
3290{
3291 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3292}
3293
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003295 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 */
3297 static void
3298list_func_head(ufunc_T *fp, int indent)
3299{
3300 int j;
3301
3302 msg_start();
3303 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003304 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003305 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003306 msg_puts("def ");
3307 else
3308 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003309 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310 msg_putchar('(');
3311 for (j = 0; j < fp->uf_args.ga_len; ++j)
3312 {
3313 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003314 msg_puts(", ");
3315 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003316 if (fp->uf_arg_types != NULL)
3317 {
3318 char *tofree;
3319
3320 msg_puts(": ");
3321 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3322 vim_free(tofree);
3323 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003324 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3325 {
3326 msg_puts(" = ");
3327 msg_puts(((char **)(fp->uf_def_args.ga_data))
3328 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3329 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 }
3331 if (fp->uf_varargs)
3332 {
3333 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003334 msg_puts(", ");
3335 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003337 if (fp->uf_va_name != NULL)
3338 {
3339 if (j)
3340 msg_puts(", ");
3341 msg_puts("...");
3342 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003343 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003344 {
3345 char *tofree;
3346
3347 msg_puts(": ");
3348 msg_puts(type_name(fp->uf_va_type, &tofree));
3349 vim_free(tofree);
3350 }
3351 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003353
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003354 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003355 {
3356 if (fp->uf_ret_type != &t_void)
3357 {
3358 char *tofree;
3359
3360 msg_puts(": ");
3361 msg_puts(type_name(fp->uf_ret_type, &tofree));
3362 vim_free(tofree);
3363 }
3364 }
3365 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003366 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003367 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003368 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003370 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003371 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003372 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 msg_clr_eos();
3374 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003375 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376}
3377
3378/*
3379 * Get a function name, translating "<SID>" and "<SNR>".
3380 * Also handles a Funcref in a List or Dictionary.
3381 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003382 * Set "*is_global" to TRUE when the function must be global, unless
3383 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 * flags:
3385 * TFN_INT: internal function name OK
3386 * TFN_QUIET: be quiet
3387 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003388 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 * Advances "pp" to just after the function name (if no error).
3390 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003391 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392trans_function_name(
3393 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003394 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003395 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003397 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003398 partial_T **partial, // return: partial of a FuncRef
3399 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400{
3401 char_u *name = NULL;
3402 char_u *start;
3403 char_u *end;
3404 int lead;
3405 char_u sid_buf[20];
3406 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003407 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003409 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003410 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411
3412 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003413 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 start = *pp;
3415
Bram Moolenaare38eab22019-12-05 21:50:01 +01003416 // Check for hard coded <SNR>: already translated function ID (from a user
3417 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3419 && (*pp)[2] == (int)KE_SNR)
3420 {
3421 *pp += 3;
3422 len = get_id_len(pp) + 3;
3423 return vim_strnsave(start, len);
3424 }
3425
Bram Moolenaare38eab22019-12-05 21:50:01 +01003426 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3427 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 lead = eval_fname_script(start);
3429 if (lead > 2)
3430 start += lead;
3431
Bram Moolenaare38eab22019-12-05 21:50:01 +01003432 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003433 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 lead > 2 ? 0 : FNE_CHECK_START);
3435 if (end == start)
3436 {
3437 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003438 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 goto theend;
3440 }
3441 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3442 {
3443 /*
3444 * Report an invalid expression in braces, unless the expression
3445 * evaluation has been cancelled due to an aborting error, an
3446 * interrupt, or an exception.
3447 */
3448 if (!aborting())
3449 {
3450 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003451 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 }
3453 else
3454 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3455 goto theend;
3456 }
3457
3458 if (lv.ll_tv != NULL)
3459 {
3460 if (fdp != NULL)
3461 {
3462 fdp->fd_dict = lv.ll_dict;
3463 fdp->fd_newkey = lv.ll_newkey;
3464 lv.ll_newkey = NULL;
3465 fdp->fd_di = lv.ll_di;
3466 }
3467 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3468 {
3469 name = vim_strsave(lv.ll_tv->vval.v_string);
3470 *pp = end;
3471 }
3472 else if (lv.ll_tv->v_type == VAR_PARTIAL
3473 && lv.ll_tv->vval.v_partial != NULL)
3474 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003475 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476 *pp = end;
3477 if (partial != NULL)
3478 *partial = lv.ll_tv->vval.v_partial;
3479 }
3480 else
3481 {
3482 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3483 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003484 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 else
3486 *pp = end;
3487 name = NULL;
3488 }
3489 goto theend;
3490 }
3491
3492 if (lv.ll_name == NULL)
3493 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003494 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003495 *pp = end;
3496 goto theend;
3497 }
3498
Bram Moolenaare38eab22019-12-05 21:50:01 +01003499 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003500 if (lv.ll_exp_name != NULL)
3501 {
3502 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003503 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 flags & TFN_NO_AUTOLOAD);
3505 if (name == lv.ll_exp_name)
3506 name = NULL;
3507 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003508 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 {
3510 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003511 name = deref_func_name(*pp, &len, partial, type,
3512 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513 if (name == *pp)
3514 name = NULL;
3515 }
3516 if (name != NULL)
3517 {
3518 name = vim_strsave(name);
3519 *pp = end;
3520 if (STRNCMP(name, "<SNR>", 5) == 0)
3521 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003522 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 name[0] = K_SPECIAL;
3524 name[1] = KS_EXTRA;
3525 name[2] = (int)KE_SNR;
3526 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3527 }
3528 goto theend;
3529 }
3530
3531 if (lv.ll_exp_name != NULL)
3532 {
3533 len = (int)STRLEN(lv.ll_exp_name);
3534 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3535 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3536 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003537 // When there was "s:" already or the name expanded to get a
3538 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 lv.ll_name += 2;
3540 len -= 2;
3541 lead = 2;
3542 }
3543 }
3544 else
3545 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003546 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003548 {
3549 if (is_global != NULL && lv.ll_name[0] == 'g')
3550 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 len = (int)(end - lv.ll_name);
3554 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003555 if (len <= 0)
3556 {
3557 if (!skip)
3558 emsg(_(e_function_name));
3559 goto theend;
3560 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003562 // In Vim9 script a user function is script-local by default, unless it
3563 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003564 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003565 if (vim9script)
3566 {
3567 char_u *p;
3568
3569 // SomeScript#func() is a global function.
3570 for (p = start; *p != NUL && *p != '('; ++p)
3571 if (*p == AUTOLOAD_CHAR)
3572 vim9script = FALSE;
3573 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003574
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 /*
3576 * Copy the function name to allocated memory.
3577 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3578 * Accept <SNR>123_name() outside a script.
3579 */
3580 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003581 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003582 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003584 if (!vim9script)
3585 lead = 3;
3586 if (vim9script || (lv.ll_exp_name != NULL
3587 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003588 || eval_fname_sid(*pp))
3589 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003590 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003591 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003593 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594 goto theend;
3595 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003596 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003597 if (vim9script)
3598 extra = 3 + (int)STRLEN(sid_buf);
3599 else
3600 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601 }
3602 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003603 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3604 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003606 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 start);
3608 goto theend;
3609 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003610 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 {
3612 char_u *cp = vim_strchr(lv.ll_name, ':');
3613
3614 if (cp != NULL && cp < end)
3615 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003616 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 goto theend;
3618 }
3619 }
3620
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003621 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 if (name != NULL)
3623 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003624 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 {
3626 name[0] = K_SPECIAL;
3627 name[1] = KS_EXTRA;
3628 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003629 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 STRCPY(name + 3, sid_buf);
3631 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003632 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3633 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 }
3635 *pp = end;
3636
3637theend:
3638 clear_lval(&lv);
3639 return name;
3640}
3641
3642/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003643 * Assuming "name" is the result of trans_function_name() and it was prefixed
3644 * to use the script-local name, return the unmodified name (points into
3645 * "name"). Otherwise return NULL.
3646 * This can be used to first search for a script-local function and fall back
3647 * to the global function if not found.
3648 */
3649 char_u *
3650untrans_function_name(char_u *name)
3651{
3652 char_u *p;
3653
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003654 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003655 {
3656 p = vim_strchr(name, '_');
3657 if (p != NULL)
3658 return p + 1;
3659 }
3660 return NULL;
3661}
3662
3663/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003664 * List functions. When "regmatch" is NULL all of then.
3665 * Otherwise functions matching "regmatch".
3666 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003667 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003668list_functions(regmatch_T *regmatch)
3669{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003670 int changed = func_hashtab.ht_changed;
3671 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003672 hashitem_T *hi;
3673
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003674 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003675 {
3676 if (!HASHITEM_EMPTY(hi))
3677 {
3678 ufunc_T *fp = HI2UF(hi);
3679
3680 --todo;
3681 if ((fp->uf_flags & FC_DEAD) == 0
3682 && (regmatch == NULL
3683 ? !message_filtered(fp->uf_name)
3684 && !func_name_refcount(fp->uf_name)
3685 : !isdigit(*fp->uf_name)
3686 && vim_regexec(regmatch, fp->uf_name, 0)))
3687 {
3688 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003689 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003690 {
3691 emsg(_("E454: function list was modified"));
3692 return;
3693 }
3694 }
3695 }
3696 }
3697}
3698
3699/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003700 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003701 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3702 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003703 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003705 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003706define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003708 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 int j;
3710 int c;
3711 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003712 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003713 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003714 char_u *p;
3715 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003716 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 char_u *line_arg = NULL;
3718 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003719 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003720 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 garray_T newlines;
3722 int varargs = FALSE;
3723 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003724 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003725 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003726 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 dictitem_T *v;
3728 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003729 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003730 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003731 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003732 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003733 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003734 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735
3736 /*
3737 * ":function" without argument: list functions.
3738 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003739 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003740 {
3741 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003742 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003744 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003745 }
3746
3747 /*
3748 * ":function /pat": list functions matching pattern.
3749 */
3750 if (*eap->arg == '/')
3751 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003752 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 if (!eap->skip)
3754 {
3755 regmatch_T regmatch;
3756
3757 c = *p;
3758 *p = NUL;
3759 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3760 *p = c;
3761 if (regmatch.regprog != NULL)
3762 {
3763 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003764 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 vim_regfree(regmatch.regprog);
3766 }
3767 }
3768 if (*p == '/')
3769 ++p;
3770 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003771 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 }
3773
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003774 ga_init(&newargs);
3775 ga_init(&argtypes);
3776 ga_init(&default_args);
3777
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778 /*
3779 * Get the function name. There are these situations:
3780 * func normal function name
3781 * "name" == func, "fudi.fd_dict" == NULL
3782 * dict.func new dictionary entry
3783 * "name" == NULL, "fudi.fd_dict" set,
3784 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3785 * dict.func existing dict entry with a Funcref
3786 * "name" == func, "fudi.fd_dict" set,
3787 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3788 * dict.func existing dict entry that's not a Funcref
3789 * "name" == NULL, "fudi.fd_dict" set,
3790 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3791 * s:func script-local function name
3792 * g:func global function name, same as "func"
3793 */
3794 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003795 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003797 // nested function, argument is (args).
3798 paren = TRUE;
3799 CLEAR_FIELD(fudi);
3800 }
3801 else
3802 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003803 if (STRNCMP(p, "<lambda>", 8) == 0)
3804 {
3805 p += 8;
3806 (void)getdigits(&p);
3807 name = vim_strnsave(eap->arg, p - eap->arg);
3808 CLEAR_FIELD(fudi);
3809 }
3810 else
3811 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003812 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003813 paren = (vim_strchr(p, '(') != NULL);
3814 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003816 /*
3817 * Return on an invalid expression in braces, unless the expression
3818 * evaluation has been cancelled due to an aborting error, an
3819 * interrupt, or an exception.
3820 */
3821 if (!aborting())
3822 {
3823 if (!eap->skip && fudi.fd_newkey != NULL)
3824 semsg(_(e_dictkey), fudi.fd_newkey);
3825 vim_free(fudi.fd_newkey);
3826 return NULL;
3827 }
3828 else
3829 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 }
3832
Bram Moolenaare38eab22019-12-05 21:50:01 +01003833 // An error in a function call during evaluation of an expression in magic
3834 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 saved_did_emsg = did_emsg;
3836 did_emsg = FALSE;
3837
3838 /*
3839 * ":function func" with only function name: list function.
3840 */
3841 if (!paren)
3842 {
3843 if (!ends_excmd(*skipwhite(p)))
3844 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003845 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 goto ret_free;
3847 }
3848 eap->nextcmd = check_nextcmd(p);
3849 if (eap->nextcmd != NULL)
3850 *p = NUL;
3851 if (!eap->skip && !got_int)
3852 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003853 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003854 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3855 {
3856 char_u *up = untrans_function_name(name);
3857
3858 // With Vim9 script the name was made script-local, if not
3859 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003860 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003861 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003862 }
3863
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864 if (fp != NULL)
3865 {
3866 list_func_head(fp, TRUE);
3867 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3868 {
3869 if (FUNCLINE(fp, j) == NULL)
3870 continue;
3871 msg_putchar('\n');
3872 msg_outnum((long)(j + 1));
3873 if (j < 9)
3874 msg_putchar(' ');
3875 if (j < 99)
3876 msg_putchar(' ');
3877 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003878 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879 ui_breakcheck();
3880 }
3881 if (!got_int)
3882 {
3883 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003884 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003885 msg_puts(" enddef");
3886 else
3887 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888 }
3889 }
3890 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003891 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 }
3893 goto ret_free;
3894 }
3895
3896 /*
3897 * ":function name(arg1, arg2)" Define function.
3898 */
3899 p = skipwhite(p);
3900 if (*p != '(')
3901 {
3902 if (!eap->skip)
3903 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003904 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905 goto ret_free;
3906 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003907 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003908 if (vim_strchr(p, '(') != NULL)
3909 p = vim_strchr(p, '(');
3910 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003912 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3913 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003914 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003915 goto ret_free;
3916 }
3917
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003918 // In Vim9 script only global functions can be redefined.
3919 if (vim9script && eap->forceit && !is_global)
3920 {
3921 emsg(_(e_nobang));
3922 goto ret_free;
3923 }
3924
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003925 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926
Bram Moolenaar04b12692020-05-04 23:24:44 +02003927 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003928 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003929 // Check the name of the function. Unless it's a dictionary function
3930 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 if (name != NULL)
3932 arg = name;
3933 else
3934 arg = fudi.fd_newkey;
3935 if (arg != NULL && (fudi.fd_di == NULL
3936 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3937 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3938 {
3939 if (*arg == K_SPECIAL)
3940 j = 3;
3941 else
3942 j = 0;
3943 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3944 : eval_isnamec(arg[j])))
3945 ++j;
3946 if (arg[j] != NUL)
3947 emsg_funcname((char *)e_invarg2, arg);
3948 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003949 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003951 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 }
3953
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003954 // This may get more lines and make the pointers into the first line
3955 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003956 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003957 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003958 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003959 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003960 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003961 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003962 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003963
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003964 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003966 // find the return type: :def Func(): type
3967 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003969 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003970 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003971 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003972 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003973 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003974 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003975 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003976 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003977 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003978 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003979 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003980 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003981 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003983 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003985 else
3986 // find extra arguments "range", "dict", "abort" and "closure"
3987 for (;;)
3988 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003989 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003990 p = skipwhite(p);
3991 if (STRNCMP(p, "range", 5) == 0)
3992 {
3993 flags |= FC_RANGE;
3994 p += 5;
3995 }
3996 else if (STRNCMP(p, "dict", 4) == 0)
3997 {
3998 flags |= FC_DICT;
3999 p += 4;
4000 }
4001 else if (STRNCMP(p, "abort", 5) == 0)
4002 {
4003 flags |= FC_ABORT;
4004 p += 5;
4005 }
4006 else if (STRNCMP(p, "closure", 7) == 0)
4007 {
4008 flags |= FC_CLOSURE;
4009 p += 7;
4010 if (current_funccal == NULL)
4011 {
4012 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4013 name == NULL ? (char_u *)"" : name);
4014 goto erret;
4015 }
4016 }
4017 else
4018 break;
4019 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020
Bram Moolenaare38eab22019-12-05 21:50:01 +01004021 // When there is a line break use what follows for the function body.
4022 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 if (*p == '\n')
4024 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004025 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004026 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4027 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004028 && !(VIM_ISWHITE(*whitep) && *p == '#'
4029 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004030 && !eap->skip
4031 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004032 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033
4034 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004035 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4036 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 */
4038 if (KeyTyped)
4039 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004040 // Check if the function already exists, don't let the user type the
4041 // whole function before telling him it doesn't work! For a script we
4042 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 if (!eap->skip && !eap->forceit)
4044 {
4045 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004046 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004047 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048 emsg_funcname(e_funcexts, name);
4049 }
4050
4051 if (!eap->skip && did_emsg)
4052 goto erret;
4053
Bram Moolenaare38eab22019-12-05 21:50:01 +01004054 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 cmdline_row = msg_row;
4056 }
4057
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004058 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004059 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004060
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004061 // Do not define the function when getting the body fails and when
4062 // skipping.
4063 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4064 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 goto erret;
4066
4067 /*
4068 * If there are no errors, add the function
4069 */
4070 if (fudi.fd_dict == NULL)
4071 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004072 hashtab_T *ht;
4073
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004074 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4076 {
4077 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4078 name);
4079 goto erret;
4080 }
4081
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004082 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004083 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004085 char_u *uname = untrans_function_name(name);
4086
4087 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4088 }
4089
4090 if (fp != NULL || import != NULL)
4091 {
4092 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004093
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004094 // Function can be replaced with "function!" and when sourcing the
4095 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004096 // A name that is used by an import can not be overruled.
4097 if (import != NULL
4098 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004099 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004100 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004102 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004103 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004104 else
4105 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106 goto erret;
4107 }
4108 if (fp->uf_calls > 0)
4109 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004110 emsg_funcname(
4111 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 name);
4113 goto erret;
4114 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004115 if (fp->uf_refcount > 1)
4116 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004117 // This function is referenced somewhere, don't redefine it but
4118 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004119 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004120 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004121 fp = NULL;
4122 overwrite = TRUE;
4123 }
4124 else
4125 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004126 char_u *exp_name = fp->uf_name_exp;
4127
4128 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004129 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004130 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004131 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004132 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004133 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004134#ifdef FEAT_PROFILE
4135 fp->uf_profiling = FALSE;
4136 fp->uf_prof_initialized = FALSE;
4137#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004138 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004139 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140 }
4141 }
4142 else
4143 {
4144 char numbuf[20];
4145
4146 fp = NULL;
4147 if (fudi.fd_newkey == NULL && !eap->forceit)
4148 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004149 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150 goto erret;
4151 }
4152 if (fudi.fd_di == NULL)
4153 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004154 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004155 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 goto erret;
4157 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004158 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004159 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160 goto erret;
4161
Bram Moolenaare38eab22019-12-05 21:50:01 +01004162 // Give the function a sequential number. Can only be used with a
4163 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004164 vim_free(name);
4165 sprintf(numbuf, "%d", ++func_nr);
4166 name = vim_strsave((char_u *)numbuf);
4167 if (name == NULL)
4168 goto erret;
4169 }
4170
4171 if (fp == NULL)
4172 {
4173 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4174 {
4175 int slen, plen;
4176 char_u *scriptname;
4177
Bram Moolenaare38eab22019-12-05 21:50:01 +01004178 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004180 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 {
4182 scriptname = autoload_name(name);
4183 if (scriptname != NULL)
4184 {
4185 p = vim_strchr(scriptname, '/');
4186 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004187 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004189 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 j = OK;
4191 vim_free(scriptname);
4192 }
4193 }
4194 if (j == FAIL)
4195 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004196 linenr_T save_lnum = SOURCING_LNUM;
4197
4198 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004199 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004200 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 goto erret;
4202 }
4203 }
4204
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004205 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004206 if (fp == NULL)
4207 goto erret;
4208
4209 if (fudi.fd_dict != NULL)
4210 {
4211 if (fudi.fd_di == NULL)
4212 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004213 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4215 if (fudi.fd_di == NULL)
4216 {
4217 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004218 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004219 goto erret;
4220 }
4221 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4222 {
4223 vim_free(fudi.fd_di);
4224 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004225 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004226 goto erret;
4227 }
4228 }
4229 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004230 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231 clear_tv(&fudi.fd_di->di_tv);
4232 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004233 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234
Bram Moolenaare38eab22019-12-05 21:50:01 +01004235 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004236 flags |= FC_DICT;
4237 }
4238
Bram Moolenaare38eab22019-12-05 21:50:01 +01004239 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004240 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004241 if (overwrite)
4242 {
4243 hi = hash_find(&func_hashtab, name);
4244 hi->hi_key = UF2HIKEY(fp);
4245 }
4246 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247 {
4248 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004249 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 goto erret;
4251 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004252 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004253 }
4254 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004255 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004256 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004257 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004258
4259 if (eap->cmdidx == CMD_def)
4260 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004261 int lnum_save = SOURCING_LNUM;
4262 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004263
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004264 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004265
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004266 // error messages are for the first function line
4267 SOURCING_LNUM = sourcing_lnum_top;
4268
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004269 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004270 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004271 int count = cstack->cs_idx + 1;
4272 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004273
4274 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004275 // a block that is visible now but not when the function is called
4276 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004277 fp->uf_block_ids = ALLOC_MULT(int, count);
4278 if (fp->uf_block_ids != NULL)
4279 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004280 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004281 sizeof(int) * count);
4282 fp->uf_block_depth = count;
4283 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004284
4285 // Set flag in each block to indicate a function was defined. This
4286 // is used to keep the variable when leaving the block, see
4287 // hide_script_var().
4288 for (i = 0; i <= cstack->cs_idx; ++i)
4289 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004290 }
4291
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004292 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004293 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004294 SOURCING_LNUM = lnum_save;
4295 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004296 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004297 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004298
4299 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004300 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004301 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004302 SOURCING_LNUM = lnum_save;
4303 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004304 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004305 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004306 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004307 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004308 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004309
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004311 if ((flags & FC_CLOSURE) != 0)
4312 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004313 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004314 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004315 }
4316 else
4317 fp->uf_scoped = NULL;
4318
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320 if (prof_def_func())
4321 func_do_profile(fp);
4322#endif
4323 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004324 if (sandbox)
4325 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004326 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004327 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328 fp->uf_flags = flags;
4329 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004330 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004331 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004332 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004333 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004334 if (is_export)
4335 {
4336 fp->uf_flags |= FC_EXPORT;
4337 // let ex_export() know the export worked.
4338 is_export = FALSE;
4339 }
4340
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004341 if (eap->cmdidx == CMD_def)
4342 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004343 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4344 // :func does not use Vim9 script syntax, even in a Vim9 script file
4345 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004346
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347 goto ret_free;
4348
4349erret:
4350 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004351 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004352 if (fp != NULL)
4353 {
4354 ga_init(&fp->uf_args);
4355 ga_init(&fp->uf_def_args);
4356 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357errret_2:
4358 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004359 if (fp != NULL)
4360 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004362 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004363 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004364 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004365 if (name != name_arg)
4366 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004367 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004369
4370 return fp;
4371}
4372
4373/*
4374 * ":function"
4375 */
4376 void
4377ex_function(exarg_T *eap)
4378{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004379 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004380}
4381
4382/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004383 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004384 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004385 */
4386 void
4387ex_defcompile(exarg_T *eap UNUSED)
4388{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004389 long todo = (long)func_hashtab.ht_used;
4390 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004391 hashitem_T *hi;
4392 ufunc_T *ufunc;
4393
4394 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4395 {
4396 if (!HASHITEM_EMPTY(hi))
4397 {
4398 --todo;
4399 ufunc = HI2UF(hi);
4400 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004401 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4402 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004403 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004404 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004405
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004406 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004407 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004408 // a function has been added or removed, need to start over
4409 todo = (long)func_hashtab.ht_used;
4410 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004411 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004412 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004413 }
4414 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004415 }
4416 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004417}
4418
4419/*
4420 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4421 * Return 2 if "p" starts with "s:".
4422 * Return 0 otherwise.
4423 */
4424 int
4425eval_fname_script(char_u *p)
4426{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004427 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4428 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4430 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4431 return 5;
4432 if (p[0] == 's' && p[1] == ':')
4433 return 2;
4434 return 0;
4435}
4436
4437 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004438translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439{
4440 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004441 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004442 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004443}
4444
4445/*
4446 * Return TRUE when "ufunc" has old-style "..." varargs
4447 * or named varargs "...name: type".
4448 */
4449 int
4450has_varargs(ufunc_T *ufunc)
4451{
4452 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453}
4454
4455/*
4456 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004457 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458 */
4459 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004460function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461{
4462 char_u *nm = name;
4463 char_u *p;
4464 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004465 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004466 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004468 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4469 if (no_deref)
4470 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004471 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 nm = skipwhite(nm);
4473
Bram Moolenaare38eab22019-12-05 21:50:01 +01004474 // Only accept "funcname", "funcname ", "funcname (..." and
4475 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004477 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 vim_free(p);
4479 return n;
4480}
4481
Bram Moolenaar113e1072019-01-20 15:30:40 +01004482#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483 char_u *
4484get_expanded_name(char_u *name, int check)
4485{
4486 char_u *nm = name;
4487 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004488 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004490 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004491 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004492
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004493 if (p != NULL && *nm == NUL
4494 && (!check || translated_function_exists(p, is_global)))
4495 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496
4497 vim_free(p);
4498 return NULL;
4499}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004500#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502/*
4503 * Function given to ExpandGeneric() to obtain the list of user defined
4504 * function names.
4505 */
4506 char_u *
4507get_user_func_name(expand_T *xp, int idx)
4508{
4509 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004510 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 static hashitem_T *hi;
4512 ufunc_T *fp;
4513
4514 if (idx == 0)
4515 {
4516 done = 0;
4517 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004518 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004520 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004521 {
4522 if (done++ > 0)
4523 ++hi;
4524 while (HASHITEM_EMPTY(hi))
4525 ++hi;
4526 fp = HI2UF(hi);
4527
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004528 // don't show dead, dict and lambda functions
4529 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004530 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004531 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532
4533 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004534 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535
4536 cat_func_name(IObuff, fp);
4537 if (xp->xp_context != EXPAND_USER_FUNC)
4538 {
4539 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004540 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 STRCAT(IObuff, ")");
4542 }
4543 return IObuff;
4544 }
4545 return NULL;
4546}
4547
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548/*
4549 * ":delfunction {name}"
4550 */
4551 void
4552ex_delfunction(exarg_T *eap)
4553{
4554 ufunc_T *fp = NULL;
4555 char_u *p;
4556 char_u *name;
4557 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004558 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559
4560 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004561 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4562 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563 vim_free(fudi.fd_newkey);
4564 if (name == NULL)
4565 {
4566 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004567 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 return;
4569 }
4570 if (!ends_excmd(*skipwhite(p)))
4571 {
4572 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004573 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004574 return;
4575 }
4576 eap->nextcmd = check_nextcmd(p);
4577 if (eap->nextcmd != NULL)
4578 *p = NUL;
4579
4580 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004581 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582 vim_free(name);
4583
4584 if (!eap->skip)
4585 {
4586 if (fp == NULL)
4587 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004588 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004589 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 return;
4591 }
4592 if (fp->uf_calls > 0)
4593 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004594 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595 return;
4596 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004597 if (fp->uf_flags & FC_VIM9)
4598 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004599 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004600 return;
4601 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004602
4603 if (fudi.fd_dict != NULL)
4604 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004605 // Delete the dict item that refers to the function, it will
4606 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4608 }
4609 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004610 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004611 // A normal function (not a numbered function or lambda) has a
4612 // refcount of 1 for the entry in the hashtable. When deleting
4613 // it and the refcount is more than one, it should be kept.
4614 // A numbered function and lambda should be kept if the refcount is
4615 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004616 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004617 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004618 // Function is still referenced somewhere. Don't free it but
4619 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004620 if (func_remove(fp))
4621 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004622 }
4623 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004624 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004625 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004626 }
4627}
4628
4629/*
4630 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004631 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632 */
4633 void
4634func_unref(char_u *name)
4635{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004636 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004638 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004640 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004641 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004643#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004644 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004646 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004647 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004648 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004649}
4650
4651/*
4652 * Unreference a Function: decrement the reference count and free it when it
4653 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004654 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004655 */
4656 void
4657func_ptr_unref(ufunc_T *fp)
4658{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004659 if (fp != NULL && (--fp->uf_refcount <= 0
4660 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4661 && fp->uf_partial->pt_refcount <= 1
4662 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004663 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004664 // Only delete it when it's not being used. Otherwise it's done
4665 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004666 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004667 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668 }
4669}
4670
4671/*
4672 * Count a reference to a Function.
4673 */
4674 void
4675func_ref(char_u *name)
4676{
4677 ufunc_T *fp;
4678
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004679 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004681 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004682 if (fp != NULL)
4683 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004685 // Only give an error for a numbered function.
4686 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004687 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004688}
4689
4690/*
4691 * Count a reference to a Function.
4692 */
4693 void
4694func_ptr_ref(ufunc_T *fp)
4695{
4696 if (fp != NULL)
4697 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698}
4699
4700/*
4701 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4702 * referenced from anywhere that is in use.
4703 */
4704 static int
4705can_free_funccal(funccall_T *fc, int copyID)
4706{
4707 return (fc->l_varlist.lv_copyID != copyID
4708 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004709 && fc->l_avars.dv_copyID != copyID
4710 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711}
4712
4713/*
4714 * ":return [expr]"
4715 */
4716 void
4717ex_return(exarg_T *eap)
4718{
4719 char_u *arg = eap->arg;
4720 typval_T rettv;
4721 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004722 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723
4724 if (current_funccal == NULL)
4725 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004726 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727 return;
4728 }
4729
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004730 CLEAR_FIELD(evalarg);
4731 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4732
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 if (eap->skip)
4734 ++emsg_skip;
4735
4736 eap->nextcmd = NULL;
4737 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004738 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004739 {
4740 if (!eap->skip)
4741 returning = do_return(eap, FALSE, TRUE, &rettv);
4742 else
4743 clear_tv(&rettv);
4744 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004745 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 else if (!eap->skip)
4747 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004748 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004749 update_force_abort();
4750
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 /*
4752 * Return unless the expression evaluation has been cancelled due to an
4753 * aborting error, an interrupt, or an exception.
4754 */
4755 if (!aborting())
4756 returning = do_return(eap, FALSE, TRUE, NULL);
4757 }
4758
Bram Moolenaare38eab22019-12-05 21:50:01 +01004759 // When skipping or the return gets pending, advance to the next command
4760 // in this line (!returning). Otherwise, ignore the rest of the line.
4761 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 if (returning)
4763 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004764 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004765 eap->nextcmd = check_nextcmd(arg);
4766
4767 if (eap->skip)
4768 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004769 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770}
4771
4772/*
4773 * ":1,25call func(arg1, arg2)" function call.
4774 */
4775 void
4776ex_call(exarg_T *eap)
4777{
4778 char_u *arg = eap->arg;
4779 char_u *startarg;
4780 char_u *name;
4781 char_u *tofree;
4782 int len;
4783 typval_T rettv;
4784 linenr_T lnum;
4785 int doesrange;
4786 int failed = FALSE;
4787 funcdict_T fudi;
4788 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004789 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004790 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004791
Bram Moolenaare6b53242020-07-01 17:28:33 +02004792 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 if (eap->skip)
4794 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004795 // trans_function_name() doesn't work well when skipping, use eval0()
4796 // instead to skip to any following command, e.g. for:
4797 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004798 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004799 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 clear_tv(&rettv);
4801 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004802 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004803 return;
4804 }
4805
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004806 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4807 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004808 if (fudi.fd_newkey != NULL)
4809 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004810 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004811 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 vim_free(fudi.fd_newkey);
4813 }
4814 if (tofree == NULL)
4815 return;
4816
Bram Moolenaare38eab22019-12-05 21:50:01 +01004817 // Increase refcount on dictionary, it could get deleted when evaluating
4818 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 if (fudi.fd_dict != NULL)
4820 ++fudi.fd_dict->dv_refcount;
4821
Bram Moolenaare38eab22019-12-05 21:50:01 +01004822 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4823 // contents. For VAR_PARTIAL get its partial, unless we already have one
4824 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004826 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4827 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004828
Bram Moolenaare38eab22019-12-05 21:50:01 +01004829 // Skip white space to allow ":call func ()". Not good, but required for
4830 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004831 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004832 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833
4834 if (*startarg != '(')
4835 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004836 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004837 goto end;
4838 }
4839
4840 /*
4841 * When skipping, evaluate the function once, to find the end of the
4842 * arguments.
4843 * When the function takes a range, this is discovered after the first
4844 * call, and the loop is broken.
4845 */
4846 if (eap->skip)
4847 {
4848 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004849 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004850 }
4851 else
4852 lnum = eap->line1;
4853 for ( ; lnum <= eap->line2; ++lnum)
4854 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004855 funcexe_T funcexe;
4856
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 if (!eap->skip && eap->addr_count > 0)
4858 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004859 if (lnum > curbuf->b_ml.ml_line_count)
4860 {
4861 // If the function deleted lines or switched to another buffer
4862 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004863 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004864 break;
4865 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866 curwin->w_cursor.lnum = lnum;
4867 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004868 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004869 }
4870 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004871
Bram Moolenaara80faa82020-04-12 19:37:17 +02004872 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004873 funcexe.firstline = eap->line1;
4874 funcexe.lastline = eap->line2;
4875 funcexe.doesrange = &doesrange;
4876 funcexe.evaluate = !eap->skip;
4877 funcexe.partial = partial;
4878 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004879 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004880 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004881 {
4882 failed = TRUE;
4883 break;
4884 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004885 if (has_watchexpr())
4886 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004887
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004888 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004889 if (handle_subscript(&arg, &rettv,
4890 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004891 {
4892 failed = TRUE;
4893 break;
4894 }
4895
4896 clear_tv(&rettv);
4897 if (doesrange || eap->skip)
4898 break;
4899
Bram Moolenaare38eab22019-12-05 21:50:01 +01004900 // Stop when immediately aborting on error, or when an interrupt
4901 // occurred or an exception was thrown but not caught.
4902 // get_func_tv() returned OK, so that the check for trailing
4903 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904 if (aborting())
4905 break;
4906 }
4907 if (eap->skip)
4908 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004909 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910
Bram Moolenaare51bb172020-02-16 19:42:23 +01004911 // When inside :try we need to check for following "| catch".
4912 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004914 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004915 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004916 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004917 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004918 if (!failed)
4919 {
4920 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004921 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004922 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923 }
4924 else
4925 eap->nextcmd = check_nextcmd(arg);
4926 }
4927
4928end:
4929 dict_unref(fudi.fd_dict);
4930 vim_free(tofree);
4931}
4932
4933/*
4934 * Return from a function. Possibly makes the return pending. Also called
4935 * for a pending return at the ":endtry" or after returning from an extra
4936 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4937 * when called due to a ":return" command. "rettv" may point to a typval_T
4938 * with the return rettv. Returns TRUE when the return can be carried out,
4939 * FALSE when the return gets pending.
4940 */
4941 int
4942do_return(
4943 exarg_T *eap,
4944 int reanimate,
4945 int is_cmd,
4946 void *rettv)
4947{
4948 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004949 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950
4951 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004952 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 current_funccal->returned = FALSE;
4954
4955 /*
4956 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4957 * not in its finally clause (which then is to be executed next) is found.
4958 * In this case, make the ":return" pending for execution at the ":endtry".
4959 * Otherwise, return normally.
4960 */
4961 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4962 if (idx >= 0)
4963 {
4964 cstack->cs_pending[idx] = CSTP_RETURN;
4965
4966 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004967 // A pending return again gets pending. "rettv" points to an
4968 // allocated variable with the rettv of the original ":return"'s
4969 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004970 cstack->cs_rettv[idx] = rettv;
4971 else
4972 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004973 // When undoing a return in order to make it pending, get the stored
4974 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004975 if (reanimate)
4976 rettv = current_funccal->rettv;
4977
4978 if (rettv != NULL)
4979 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004980 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004981 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4982 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4983 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004984 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 }
4986 else
4987 cstack->cs_rettv[idx] = NULL;
4988
4989 if (reanimate)
4990 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004991 // The pending return value could be overwritten by a ":return"
4992 // without argument in a finally clause; reset the default
4993 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004994 current_funccal->rettv->v_type = VAR_NUMBER;
4995 current_funccal->rettv->vval.v_number = 0;
4996 }
4997 }
4998 report_make_pending(CSTP_RETURN, rettv);
4999 }
5000 else
5001 {
5002 current_funccal->returned = TRUE;
5003
Bram Moolenaare38eab22019-12-05 21:50:01 +01005004 // If the return is carried out now, store the return value. For
5005 // a return immediately after reanimation, the value is already
5006 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005007 if (!reanimate && rettv != NULL)
5008 {
5009 clear_tv(current_funccal->rettv);
5010 *current_funccal->rettv = *(typval_T *)rettv;
5011 if (!is_cmd)
5012 vim_free(rettv);
5013 }
5014 }
5015
5016 return idx < 0;
5017}
5018
5019/*
5020 * Free the variable with a pending return value.
5021 */
5022 void
5023discard_pending_return(void *rettv)
5024{
5025 free_tv((typval_T *)rettv);
5026}
5027
5028/*
5029 * Generate a return command for producing the value of "rettv". The result
5030 * is an allocated string. Used by report_pending() for verbose messages.
5031 */
5032 char_u *
5033get_return_cmd(void *rettv)
5034{
5035 char_u *s = NULL;
5036 char_u *tofree = NULL;
5037 char_u numbuf[NUMBUFLEN];
5038
5039 if (rettv != NULL)
5040 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5041 if (s == NULL)
5042 s = (char_u *)"";
5043
5044 STRCPY(IObuff, ":return ");
5045 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5046 if (STRLEN(s) + 8 >= IOSIZE)
5047 STRCPY(IObuff + IOSIZE - 4, "...");
5048 vim_free(tofree);
5049 return vim_strsave(IObuff);
5050}
5051
5052/*
5053 * Get next function line.
5054 * Called by do_cmdline() to get the next line.
5055 * Returns allocated string, or NULL for end of function.
5056 */
5057 char_u *
5058get_func_line(
5059 int c UNUSED,
5060 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005061 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005062 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063{
5064 funccall_T *fcp = (funccall_T *)cookie;
5065 ufunc_T *fp = fcp->func;
5066 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005067 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068
Bram Moolenaare38eab22019-12-05 21:50:01 +01005069 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005070 if (fcp->dbg_tick != debug_tick)
5071 {
5072 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005073 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074 fcp->dbg_tick = debug_tick;
5075 }
5076#ifdef FEAT_PROFILE
5077 if (do_profiling == PROF_YES)
5078 func_line_end(cookie);
5079#endif
5080
5081 gap = &fp->uf_lines;
5082 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5083 || fcp->returned)
5084 retval = NULL;
5085 else
5086 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005087 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005088 while (fcp->linenr < gap->ga_len
5089 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5090 ++fcp->linenr;
5091 if (fcp->linenr >= gap->ga_len)
5092 retval = NULL;
5093 else
5094 {
5095 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005096 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005097#ifdef FEAT_PROFILE
5098 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005099 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005100#endif
5101 }
5102 }
5103
Bram Moolenaare38eab22019-12-05 21:50:01 +01005104 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005105 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005107 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005108 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005110 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005111 fcp->dbg_tick = debug_tick;
5112 }
5113
5114 return retval;
5115}
5116
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005117/*
5118 * Return TRUE if the currently active function should be ended, because a
5119 * return was encountered or an error occurred. Used inside a ":while".
5120 */
5121 int
5122func_has_ended(void *cookie)
5123{
5124 funccall_T *fcp = (funccall_T *)cookie;
5125
Bram Moolenaare38eab22019-12-05 21:50:01 +01005126 // Ignore the "abort" flag if the abortion behavior has been changed due to
5127 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5129 || fcp->returned);
5130}
5131
5132/*
5133 * return TRUE if cookie indicates a function which "abort"s on errors.
5134 */
5135 int
5136func_has_abort(
5137 void *cookie)
5138{
5139 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5140}
5141
5142
5143/*
5144 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5145 * Don't do this when "Func" is already a partial that was bound
5146 * explicitly (pt_auto is FALSE).
5147 * Changes "rettv" in-place.
5148 * Returns the updated "selfdict_in".
5149 */
5150 dict_T *
5151make_partial(dict_T *selfdict_in, typval_T *rettv)
5152{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005153 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005154 char_u *tofree = NULL;
5155 ufunc_T *fp;
5156 char_u fname_buf[FLEN_FIXED + 1];
5157 int error;
5158 dict_T *selfdict = selfdict_in;
5159
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005160 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5161 fp = rettv->vval.v_partial->pt_func;
5162 else
5163 {
5164 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5165 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005166 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005167 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005168 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005169 vim_free(tofree);
5170 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171
5172 if (fp != NULL && (fp->uf_flags & FC_DICT))
5173 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005174 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175
5176 if (pt != NULL)
5177 {
5178 pt->pt_refcount = 1;
5179 pt->pt_dict = selfdict;
5180 pt->pt_auto = TRUE;
5181 selfdict = NULL;
5182 if (rettv->v_type == VAR_FUNC)
5183 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005184 // Just a function: Take over the function name and use
5185 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005186 pt->pt_name = rettv->vval.v_string;
5187 }
5188 else
5189 {
5190 partial_T *ret_pt = rettv->vval.v_partial;
5191 int i;
5192
Bram Moolenaare38eab22019-12-05 21:50:01 +01005193 // Partial: copy the function name, use selfdict and copy
5194 // args. Can't take over name or args, the partial might
5195 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005196 if (ret_pt->pt_name != NULL)
5197 {
5198 pt->pt_name = vim_strsave(ret_pt->pt_name);
5199 func_ref(pt->pt_name);
5200 }
5201 else
5202 {
5203 pt->pt_func = ret_pt->pt_func;
5204 func_ptr_ref(pt->pt_func);
5205 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005206 if (ret_pt->pt_argc > 0)
5207 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005208 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005210 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005211 pt->pt_argc = 0;
5212 else
5213 {
5214 pt->pt_argc = ret_pt->pt_argc;
5215 for (i = 0; i < pt->pt_argc; i++)
5216 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5217 }
5218 }
5219 partial_unref(ret_pt);
5220 }
5221 rettv->v_type = VAR_PARTIAL;
5222 rettv->vval.v_partial = pt;
5223 }
5224 }
5225 return selfdict;
5226}
5227
5228/*
5229 * Return the name of the executed function.
5230 */
5231 char_u *
5232func_name(void *cookie)
5233{
5234 return ((funccall_T *)cookie)->func->uf_name;
5235}
5236
5237/*
5238 * Return the address holding the next breakpoint line for a funccall cookie.
5239 */
5240 linenr_T *
5241func_breakpoint(void *cookie)
5242{
5243 return &((funccall_T *)cookie)->breakpoint;
5244}
5245
5246/*
5247 * Return the address holding the debug tick for a funccall cookie.
5248 */
5249 int *
5250func_dbg_tick(void *cookie)
5251{
5252 return &((funccall_T *)cookie)->dbg_tick;
5253}
5254
5255/*
5256 * Return the nesting level for a funccall cookie.
5257 */
5258 int
5259func_level(void *cookie)
5260{
5261 return ((funccall_T *)cookie)->level;
5262}
5263
5264/*
5265 * Return TRUE when a function was ended by a ":return" command.
5266 */
5267 int
5268current_func_returned(void)
5269{
5270 return current_funccal->returned;
5271}
5272
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005273 int
5274free_unref_funccal(int copyID, int testing)
5275{
5276 int did_free = FALSE;
5277 int did_free_funccal = FALSE;
5278 funccall_T *fc, **pfc;
5279
5280 for (pfc = &previous_funccal; *pfc != NULL; )
5281 {
5282 if (can_free_funccal(*pfc, copyID))
5283 {
5284 fc = *pfc;
5285 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005286 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005287 did_free = TRUE;
5288 did_free_funccal = TRUE;
5289 }
5290 else
5291 pfc = &(*pfc)->caller;
5292 }
5293 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005294 // When a funccal was freed some more items might be garbage
5295 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005296 (void)garbage_collect(testing);
5297
5298 return did_free;
5299}
5300
5301/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005302 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005303 */
5304 static funccall_T *
5305get_funccal(void)
5306{
5307 int i;
5308 funccall_T *funccal;
5309 funccall_T *temp_funccal;
5310
5311 funccal = current_funccal;
5312 if (debug_backtrace_level > 0)
5313 {
5314 for (i = 0; i < debug_backtrace_level; i++)
5315 {
5316 temp_funccal = funccal->caller;
5317 if (temp_funccal)
5318 funccal = temp_funccal;
5319 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005320 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005321 debug_backtrace_level = i;
5322 }
5323 }
5324 return funccal;
5325}
5326
5327/*
5328 * Return the hashtable used for local variables in the current funccal.
5329 * Return NULL if there is no current funccal.
5330 */
5331 hashtab_T *
5332get_funccal_local_ht()
5333{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005334 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005335 return NULL;
5336 return &get_funccal()->l_vars.dv_hashtab;
5337}
5338
5339/*
5340 * Return the l: scope variable.
5341 * Return NULL if there is no current funccal.
5342 */
5343 dictitem_T *
5344get_funccal_local_var()
5345{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005346 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005347 return NULL;
5348 return &get_funccal()->l_vars_var;
5349}
5350
5351/*
5352 * Return the hashtable used for argument in the current funccal.
5353 * Return NULL if there is no current funccal.
5354 */
5355 hashtab_T *
5356get_funccal_args_ht()
5357{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005358 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359 return NULL;
5360 return &get_funccal()->l_avars.dv_hashtab;
5361}
5362
5363/*
5364 * Return the a: scope variable.
5365 * Return NULL if there is no current funccal.
5366 */
5367 dictitem_T *
5368get_funccal_args_var()
5369{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005370 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005371 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005372 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005373}
5374
5375/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 * List function variables, if there is a function.
5377 */
5378 void
5379list_func_vars(int *first)
5380{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005381 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005383 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005384}
5385
5386/*
5387 * If "ht" is the hashtable for local variables in the current funccal, return
5388 * the dict that contains it.
5389 * Otherwise return NULL.
5390 */
5391 dict_T *
5392get_current_funccal_dict(hashtab_T *ht)
5393{
5394 if (current_funccal != NULL
5395 && ht == &current_funccal->l_vars.dv_hashtab)
5396 return &current_funccal->l_vars;
5397 return NULL;
5398}
5399
5400/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005401 * Search hashitem in parent scope.
5402 */
5403 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005404find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005405{
5406 funccall_T *old_current_funccal = current_funccal;
5407 hashtab_T *ht;
5408 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005409 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005410
5411 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5412 return NULL;
5413
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005414 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005415 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005416 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005417 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005418 ht = find_var_ht(name, &varname);
5419 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005420 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005421 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005422 if (!HASHITEM_EMPTY(hi))
5423 {
5424 *pht = ht;
5425 break;
5426 }
5427 }
5428 if (current_funccal == current_funccal->func->uf_scoped)
5429 break;
5430 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005431 }
5432 current_funccal = old_current_funccal;
5433
5434 return hi;
5435}
5436
5437/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005438 * Search variable in parent scope.
5439 */
5440 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005441find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005442{
5443 dictitem_T *v = NULL;
5444 funccall_T *old_current_funccal = current_funccal;
5445 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005446 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005447
5448 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5449 return NULL;
5450
Bram Moolenaare38eab22019-12-05 21:50:01 +01005451 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005452 current_funccal = current_funccal->func->uf_scoped;
5453 while (current_funccal)
5454 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005455 ht = find_var_ht(name, &varname);
5456 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005457 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005458 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005459 if (v != NULL)
5460 break;
5461 }
5462 if (current_funccal == current_funccal->func->uf_scoped)
5463 break;
5464 current_funccal = current_funccal->func->uf_scoped;
5465 }
5466 current_funccal = old_current_funccal;
5467
5468 return v;
5469}
5470
5471/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005472 * Set "copyID + 1" in previous_funccal and callers.
5473 */
5474 int
5475set_ref_in_previous_funccal(int copyID)
5476{
5477 int abort = FALSE;
5478 funccall_T *fc;
5479
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005480 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005481 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005482 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005483 abort = abort
5484 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5485 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005486 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005487 }
5488 return abort;
5489}
5490
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005491 static int
5492set_ref_in_funccal(funccall_T *fc, int copyID)
5493{
5494 int abort = FALSE;
5495
5496 if (fc->fc_copyID != copyID)
5497 {
5498 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005499 abort = abort
5500 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5501 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005502 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005503 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005504 }
5505 return abort;
5506}
5507
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005508/*
5509 * Set "copyID" in all local vars and arguments in the call stack.
5510 */
5511 int
5512set_ref_in_call_stack(int copyID)
5513{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005514 int abort = FALSE;
5515 funccall_T *fc;
5516 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005517
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005518 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005519 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005520
5521 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005522 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5523 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005524 abort = abort || set_ref_in_funccal(fc, copyID);
5525
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005526 return abort;
5527}
5528
5529/*
5530 * Set "copyID" in all functions available by name.
5531 */
5532 int
5533set_ref_in_functions(int copyID)
5534{
5535 int todo;
5536 hashitem_T *hi = NULL;
5537 int abort = FALSE;
5538 ufunc_T *fp;
5539
5540 todo = (int)func_hashtab.ht_used;
5541 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005542 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005543 if (!HASHITEM_EMPTY(hi))
5544 {
5545 --todo;
5546 fp = HI2UF(hi);
5547 if (!func_name_refcount(fp->uf_name))
5548 abort = abort || set_ref_in_func(NULL, fp, copyID);
5549 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005550 }
5551 return abort;
5552}
5553
5554/*
5555 * Set "copyID" in all function arguments.
5556 */
5557 int
5558set_ref_in_func_args(int copyID)
5559{
5560 int i;
5561 int abort = FALSE;
5562
5563 for (i = 0; i < funcargs.ga_len; ++i)
5564 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5565 copyID, NULL, NULL);
5566 return abort;
5567}
5568
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005569/*
5570 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005571 * Returns TRUE if setting references failed somehow.
5572 */
5573 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005574set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005575{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005576 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005577 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005578 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005579 char_u fname_buf[FLEN_FIXED + 1];
5580 char_u *tofree = NULL;
5581 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005582 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005583
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005584 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005585 return FALSE;
5586
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005587 if (fp_in == NULL)
5588 {
5589 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005590 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005591 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005592 if (fp != NULL)
5593 {
5594 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005595 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005596 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005597
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005598 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005599 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005600}
5601
Bram Moolenaare38eab22019-12-05 21:50:01 +01005602#endif // FEAT_EVAL