blob: dd6939c9a37779ecf62c8a87b0c24c67896aa265 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200201 if (default_args != NULL)
202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
269 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100270 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200271 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200273 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200274
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200275 if (*skipwhite(p) == '=' && default_args != NULL)
276 {
277 typval_T rettv;
278
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100279 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200280 any_default = TRUE;
281 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200282 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200283 p = skipwhite(p);
284 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200285 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 {
287 if (ga_grow(default_args, 1) == FAIL)
288 goto err_ret;
289
290 // trim trailing whitespace
291 while (p > expr && VIM_ISWHITE(p[-1]))
292 p--;
293 c = *p;
294 *p = NUL;
295 expr = vim_strsave(expr);
296 if (expr == NULL)
297 {
298 *p = c;
299 goto err_ret;
300 }
301 ((char_u **)(default_args->ga_data))
302 [default_args->ga_len] = expr;
303 default_args->ga_len++;
304 *p = c;
305 }
306 else
307 mustend = TRUE;
308 }
309 else if (any_default)
310 {
311 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200312 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200313 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200314
315 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
316 {
317 // Be tolerant when skipping
318 if (!skip)
319 {
320 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
321 goto err_ret;
322 }
323 p = skipwhite(p);
324 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200325 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200326 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200327 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200328 // Don't give this error when skipping, it makes the "->" not
329 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100330 // Allow missing space after comma in legacy functions.
331 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200332 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
333 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100334 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 goto err_ret;
336 }
337 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200338 else
339 mustend = TRUE;
340 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200341 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200342 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200343 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200344
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200345 if (*p != endchar)
346 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100347 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200348
349 *argp = p;
350 return OK;
351
352err_ret:
353 if (newargs != NULL)
354 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200355 if (default_args != NULL)
356 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357 return FAIL;
358}
359
360/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100361 * Parse the argument types, filling "fp->uf_arg_types".
362 * Return OK or FAIL.
363 */
364 static int
365parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
366{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200367 int len = 0;
368
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100369 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
370 if (argtypes->ga_len > 0)
371 {
372 // When "varargs" is set the last name/type goes into uf_va_name
373 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200374 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100375
376 if (len > 0)
377 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
378 if (fp->uf_arg_types != NULL)
379 {
380 int i;
381 type_T *type;
382
383 for (i = 0; i < len; ++ i)
384 {
385 char_u *p = ((char_u **)argtypes->ga_data)[i];
386
387 if (p == NULL)
388 // will get the type from the default value
389 type = &t_unknown;
390 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100391 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100392 if (type == NULL)
393 return FAIL;
394 fp->uf_arg_types[i] = type;
395 }
396 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100397 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200398
399 if (varargs)
400 {
401 char_u *p;
402
403 // Move the last argument "...name: type" to uf_va_name and
404 // uf_va_type.
405 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
406 [fp->uf_args.ga_len - 1];
407 --fp->uf_args.ga_len;
408 p = ((char_u **)argtypes->ga_data)[len];
409 if (p == NULL)
410 // TODO: get type from default value
411 fp->uf_va_type = &t_list_any;
412 else
413 {
414 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
415 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
416 {
417 semsg(_(e_variable_arguments_type_must_be_list_str),
418 ((char_u **)argtypes->ga_data)[len]);
419 return FAIL;
420 }
421 }
422 if (fp->uf_va_type == NULL)
423 return FAIL;
424 }
425
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100426 return OK;
427}
428
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100429 static int
430parse_return_type(ufunc_T *fp, char_u *ret_type)
431{
432 if (ret_type == NULL)
433 fp->uf_ret_type = &t_void;
434 else
435 {
436 char_u *p = ret_type;
437
438 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
439 if (fp->uf_ret_type == NULL)
440 {
441 fp->uf_ret_type = &t_void;
442 return FAIL;
443 }
444 }
445 return OK;
446}
447
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100448/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200449 * Register function "fp" as using "current_funccal" as its scope.
450 */
451 static int
452register_closure(ufunc_T *fp)
453{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200454 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100455 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200456 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200457 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 fp->uf_scoped = current_funccal;
459 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200460
Bram Moolenaar58016442016-07-31 18:30:22 +0200461 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
462 return FAIL;
463 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
464 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200465 return OK;
466}
467
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100468 static void
469set_ufunc_name(ufunc_T *fp, char_u *name)
470{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100471 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
472 // actually extends beyond the struct.
473 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100474
475 if (name[0] == K_SPECIAL)
476 {
477 fp->uf_name_exp = alloc(STRLEN(name) + 3);
478 if (fp->uf_name_exp != NULL)
479 {
480 STRCPY(fp->uf_name_exp, "<SNR>");
481 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
482 }
483 }
484}
485
Bram Moolenaar58016442016-07-31 18:30:22 +0200486/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200487 * Get a name for a lambda. Returned in static memory.
488 */
489 char_u *
490get_lambda_name(void)
491{
492 static char_u name[30];
493 static int lambda_no = 0;
494
495 sprintf((char*)name, "<lambda>%d", ++lambda_no);
496 return name;
497}
498
Bram Moolenaar801ab062020-06-25 19:27:56 +0200499#if defined(FEAT_LUA) || defined(PROTO)
500/*
501 * Registers a native C callback which can be called from Vim script.
502 * Returns the name of the Vim script function.
503 */
504 char_u *
505register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
506{
507 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200508 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200509
510 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
511 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200512 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200513
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200514 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200515 fp->uf_refcount = 1;
516 fp->uf_varargs = TRUE;
517 fp->uf_flags = FC_CFUNC;
518 fp->uf_calls = 0;
519 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200520 fp->uf_cb = cb;
521 fp->uf_cb_free = cb_free;
522 fp->uf_cb_state = state;
523
524 set_ufunc_name(fp, name);
525 hash_add(&func_hashtab, UF2HIKEY(fp));
526
527 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200528}
529#endif
530
Bram Moolenaar04b12692020-05-04 23:24:44 +0200531/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100532 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100533 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100534 * If "white_error" is not NULL check for correct use of white space and set
535 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100536 * Return NULL if no valid arrow found.
537 */
538 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100539skip_arrow(
540 char_u *start,
541 int equal_arrow,
542 char_u **ret_type,
543 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100544{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100545 char_u *s = start;
546 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100547
548 if (equal_arrow)
549 {
550 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100551 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100552 if (white_error != NULL && !VIM_ISWHITE(s[1]))
553 {
554 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100555 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100556 return NULL;
557 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100558 s = skipwhite(s + 1);
559 *ret_type = s;
560 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100561 if (s == *ret_type)
562 {
563 emsg(_(e_missing_return_type));
564 return NULL;
565 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100566 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100567 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100568 s = skipwhite(s);
569 if (*s != '=')
570 return NULL;
571 ++s;
572 }
573 if (*s != '>')
574 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100575 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
576 || !IS_WHITE_OR_NUL(s[1])))
577 {
578 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100579 semsg(_(e_white_space_required_before_and_after_str_at_str),
580 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100581 return NULL;
582 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100583 return skipwhite(s + 1);
584}
585
586/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100587 * Check if "*cmd" points to a function command and if so advance "*cmd" and
588 * return TRUE.
589 * Otherwise return FALSE;
590 * Do not consider "function(" to be a command.
591 */
592 static int
593is_function_cmd(char_u **cmd)
594{
595 char_u *p = *cmd;
596
597 if (checkforcmd(&p, "function", 2))
598 {
599 if (*p == '(')
600 return FALSE;
601 *cmd = p;
602 return TRUE;
603 }
604 return FALSE;
605}
606
607/*
608 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200609 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100610 * "newlines" must already have been initialized.
611 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
612 */
613 static int
614get_function_body(
615 exarg_T *eap,
616 garray_T *newlines,
617 char_u *line_arg_in,
618 char_u **line_to_free)
619{
620 linenr_T sourcing_lnum_top = SOURCING_LNUM;
621 linenr_T sourcing_lnum_off;
622 int saved_wait_return = need_wait_return;
623 char_u *line_arg = line_arg_in;
624 int vim9_function = eap->cmdidx == CMD_def
625 || eap->cmdidx == CMD_block;
626#define MAX_FUNC_NESTING 50
627 char nesting_def[MAX_FUNC_NESTING];
628 int nesting = 0;
629 getline_opt_T getline_options;
630 int indent = 2;
631 char_u *skip_until = NULL;
632 int ret = FAIL;
633 int is_heredoc = FALSE;
634 char_u *heredoc_trimmed = NULL;
635
636 // Detect having skipped over comment lines to find the return
637 // type. Add NULL lines to keep the line count correct.
638 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
639 if (SOURCING_LNUM < sourcing_lnum_off)
640 {
641 sourcing_lnum_off -= SOURCING_LNUM;
642 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
643 goto theend;
644 while (sourcing_lnum_off-- > 0)
645 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
646 }
647
648 nesting_def[nesting] = vim9_function;
649 getline_options = vim9_function
650 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
651 for (;;)
652 {
653 char_u *theline;
654 char_u *p;
655 char_u *arg;
656
657 if (KeyTyped)
658 {
659 msg_scroll = TRUE;
660 saved_wait_return = FALSE;
661 }
662 need_wait_return = FALSE;
663
664 if (line_arg != NULL)
665 {
666 // Use eap->arg, split up in parts by line breaks.
667 theline = line_arg;
668 p = vim_strchr(theline, '\n');
669 if (p == NULL)
670 line_arg += STRLEN(line_arg);
671 else
672 {
673 *p = NUL;
674 line_arg = p + 1;
675 }
676 }
677 else
678 {
679 vim_free(*line_to_free);
680 if (eap->getline == NULL)
681 theline = getcmdline(':', 0L, indent, getline_options);
682 else
683 theline = eap->getline(':', eap->cookie, indent,
684 getline_options);
685 *line_to_free = theline;
686 }
687 if (KeyTyped)
688 lines_left = Rows - 1;
689 if (theline == NULL)
690 {
691 // Use the start of the function for the line number.
692 SOURCING_LNUM = sourcing_lnum_top;
693 if (skip_until != NULL)
694 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
695 else if (eap->cmdidx == CMD_def)
696 emsg(_(e_missing_enddef));
697 else if (eap->cmdidx == CMD_block)
698 emsg(_(e_missing_end_block));
699 else
700 emsg(_("E126: Missing :endfunction"));
701 goto theend;
702 }
703
704 // Detect line continuation: SOURCING_LNUM increased more than one.
705 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
706 if (SOURCING_LNUM < sourcing_lnum_off)
707 sourcing_lnum_off -= SOURCING_LNUM;
708 else
709 sourcing_lnum_off = 0;
710
711 if (skip_until != NULL)
712 {
713 // Don't check for ":endfunc"/":enddef" between
714 // * ":append" and "."
715 // * ":python <<EOF" and "EOF"
716 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
717 if (heredoc_trimmed == NULL
718 || (is_heredoc && skipwhite(theline) == theline)
719 || STRNCMP(theline, heredoc_trimmed,
720 STRLEN(heredoc_trimmed)) == 0)
721 {
722 if (heredoc_trimmed == NULL)
723 p = theline;
724 else if (is_heredoc)
725 p = skipwhite(theline) == theline
726 ? theline : theline + STRLEN(heredoc_trimmed);
727 else
728 p = theline + STRLEN(heredoc_trimmed);
729 if (STRCMP(p, skip_until) == 0)
730 {
731 VIM_CLEAR(skip_until);
732 VIM_CLEAR(heredoc_trimmed);
733 getline_options = vim9_function
734 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
735 is_heredoc = FALSE;
736 }
737 }
738 }
739 else
740 {
741 int c;
742
743 // skip ':' and blanks
744 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
745 ;
746
747 // Check for "endfunction", "enddef" or "}".
748 // When a ":" follows it must be a dict key; "enddef: value,"
749 if ((nesting == 0 && eap->cmdidx == CMD_block)
750 ? *p == '}'
751 : (checkforcmd(&p, nesting_def[nesting]
752 ? "enddef" : "endfunction", 4)
753 && *p != ':'))
754 {
755 if (nesting-- == 0)
756 {
757 char_u *nextcmd = NULL;
758
759 if (*p == '|' || *p == '}')
760 nextcmd = p + 1;
761 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
762 nextcmd = line_arg;
763 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100764 && (vim9_function || p_verbose > 0))
765 {
766 if (eap->cmdidx == CMD_def)
767 semsg(_(e_text_found_after_enddef_str), p);
768 else
769 give_warning2((char_u *)
770 _("W22: Text found after :endfunction: %s"),
771 p, TRUE);
772 }
773 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100774 {
775 // Another command follows. If the line came from "eap"
776 // we can simply point into it, otherwise we need to
777 // change "eap->cmdlinep".
778 eap->nextcmd = nextcmd;
779 if (*line_to_free != NULL)
780 {
781 vim_free(*eap->cmdlinep);
782 *eap->cmdlinep = *line_to_free;
783 *line_to_free = NULL;
784 }
785 }
786 break;
787 }
788 }
789
790 // Check for mismatched "endfunc" or "enddef".
791 // We don't check for "def" inside "func" thus we also can't check
792 // for "enddef".
793 // We continue to find the end of the function, although we might
794 // not find it.
795 else if (nesting_def[nesting])
796 {
797 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
798 emsg(_(e_mismatched_endfunction));
799 }
800 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
801 emsg(_(e_mismatched_enddef));
802
803 // Increase indent inside "if", "while", "for" and "try", decrease
804 // at "end".
805 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
806 indent -= 2;
807 else if (STRNCMP(p, "if", 2) == 0
808 || STRNCMP(p, "wh", 2) == 0
809 || STRNCMP(p, "for", 3) == 0
810 || STRNCMP(p, "try", 3) == 0)
811 indent += 2;
812
813 // Check for defining a function inside this function.
814 // Only recognize "def" inside "def", not inside "function",
815 // For backwards compatibility, see Test_function_python().
816 c = *p;
817 if (is_function_cmd(&p)
818 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
819 {
820 if (*p == '!')
821 p = skipwhite(p + 1);
822 p += eval_fname_script(p);
823 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
824 NULL, NULL));
825 if (*skipwhite(p) == '(')
826 {
827 if (nesting == MAX_FUNC_NESTING - 1)
828 emsg(_(e_function_nesting_too_deep));
829 else
830 {
831 ++nesting;
832 nesting_def[nesting] = (c == 'd');
833 indent += 2;
834 }
835 }
836 }
837
838 // Check for ":append", ":change", ":insert". Not for :def.
839 p = skip_range(p, FALSE, NULL);
840 if (!vim9_function
841 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
842 || (p[0] == 'c'
843 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
844 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
845 && (STRNCMP(&p[3], "nge", 3) != 0
846 || !ASCII_ISALPHA(p[6])))))))
847 || (p[0] == 'i'
848 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
849 && (!ASCII_ISALPHA(p[2])
850 || (p[2] == 's'
851 && (!ASCII_ISALPHA(p[3])
852 || p[3] == 'e'))))))))
853 skip_until = vim_strsave((char_u *)".");
854
855 // Check for ":python <<EOF", ":tcl <<EOF", etc.
856 arg = skipwhite(skiptowhite(p));
857 if (arg[0] == '<' && arg[1] =='<'
858 && ((p[0] == 'p' && p[1] == 'y'
859 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
860 || ((p[2] == '3' || p[2] == 'x')
861 && !ASCII_ISALPHA(p[3]))))
862 || (p[0] == 'p' && p[1] == 'e'
863 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
864 || (p[0] == 't' && p[1] == 'c'
865 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
866 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
867 && !ASCII_ISALPHA(p[3]))
868 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
869 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
870 || (p[0] == 'm' && p[1] == 'z'
871 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
872 ))
873 {
874 // ":python <<" continues until a dot, like ":append"
875 p = skipwhite(arg + 2);
876 if (STRNCMP(p, "trim", 4) == 0)
877 {
878 // Ignore leading white space.
879 p = skipwhite(p + 4);
880 heredoc_trimmed = vim_strnsave(theline,
881 skipwhite(theline) - theline);
882 }
883 if (*p == NUL)
884 skip_until = vim_strsave((char_u *)".");
885 else
886 skip_until = vim_strnsave(p, skiptowhite(p) - p);
887 getline_options = GETLINE_NONE;
888 is_heredoc = TRUE;
889 }
890
891 // Check for ":cmd v =<< [trim] EOF"
892 // and ":cmd [a, b] =<< [trim] EOF"
893 // and "lines =<< [trim] EOF" for Vim9
894 // Where "cmd" can be "let", "var", "final" or "const".
895 arg = skipwhite(skiptowhite(p));
896 if (*arg == '[')
897 arg = vim_strchr(arg, ']');
898 if (arg != NULL)
899 {
900 int found = (eap->cmdidx == CMD_def && arg[0] == '='
901 && arg[1] == '<' && arg[2] =='<');
902
903 if (!found)
904 // skip over the argument after "cmd"
905 arg = skipwhite(skiptowhite(arg));
906 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
907 && (checkforcmd(&p, "let", 2)
908 || checkforcmd(&p, "var", 3)
909 || checkforcmd(&p, "final", 5)
910 || checkforcmd(&p, "const", 5))))
911 {
912 p = skipwhite(arg + 3);
913 if (STRNCMP(p, "trim", 4) == 0)
914 {
915 // Ignore leading white space.
916 p = skipwhite(p + 4);
917 heredoc_trimmed = vim_strnsave(theline,
918 skipwhite(theline) - theline);
919 }
920 skip_until = vim_strnsave(p, skiptowhite(p) - p);
921 getline_options = GETLINE_NONE;
922 is_heredoc = TRUE;
923 }
924 }
925 }
926
927 // Add the line to the function.
928 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
929 goto theend;
930
931 // Copy the line to newly allocated memory. get_one_sourceline()
932 // allocates 250 bytes per line, this saves 80% on average. The cost
933 // is an extra alloc/free.
934 p = vim_strsave(theline);
935 if (p == NULL)
936 goto theend;
937 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
938
939 // Add NULL lines for continuation lines, so that the line count is
940 // equal to the index in the growarray.
941 while (sourcing_lnum_off-- > 0)
942 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
943
944 // Check for end of eap->arg.
945 if (line_arg != NULL && *line_arg == NUL)
946 line_arg = NULL;
947 }
948
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200949 // Return OK when no error was detected.
950 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100951 ret = OK;
952
953theend:
954 vim_free(skip_until);
955 vim_free(heredoc_trimmed);
956 need_wait_return |= saved_wait_return;
957 return ret;
958}
959
960/*
961 * Handle the body of a lambda. *arg points to the "{", process statements
962 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200963 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100964 * When successful "rettv" is set to a funcref.
965 */
966 static int
967lambda_function_body(
968 char_u **arg,
969 typval_T *rettv,
970 evalarg_T *evalarg,
971 garray_T *newargs,
972 garray_T *argtypes,
973 int varargs,
974 garray_T *default_args,
975 char_u *ret_type)
976{
Bram Moolenaarfed9e832021-04-10 21:38:38 +0200977 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200978 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +0200979 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +0100980 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100981 exarg_T eap;
982 garray_T newlines;
983 char_u *cmdline = NULL;
984 int ret = FAIL;
985 char_u *line_to_free = NULL;
986 partial_T *pt;
987 char_u *name;
988 int lnum_save = -1;
989 linenr_T sourcing_lnum_top = SOURCING_LNUM;
990
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100991 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
992 {
993 semsg(_(e_trailing_arg), *arg + 1);
994 return FAIL;
995 }
996
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 CLEAR_FIELD(eap);
998 eap.cmdidx = CMD_block;
999 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001000 eap.cmdlinep = &cmdline;
1001 eap.skip = !evaluate;
1002 if (evalarg->eval_cctx != NULL)
1003 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1004 else
1005 {
1006 eap.getline = evalarg->eval_getline;
1007 eap.cookie = evalarg->eval_cookie;
1008 }
1009
1010 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1011 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001012 {
1013 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001014 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001015 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001016
1017 // When inside a lambda must add the function lines to evalarg.eval_ga.
1018 evalarg->eval_break_count += newlines.ga_len;
1019 if (gap->ga_itemsize > 0)
1020 {
1021 int idx;
1022 char_u *last;
1023 size_t plen;
1024 char_u *pnl;
1025
1026 for (idx = 0; idx < newlines.ga_len; ++idx)
1027 {
1028 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1029
Bram Moolenaarecb66452021-05-18 15:09:18 +02001030 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001031 goto erret;
1032
1033 // Going to concatenate the lines after parsing. For an empty or
1034 // comment line use an empty string.
1035 // Insert NL characters at the start of each line, the string will
1036 // be split again later in .get_lambda_tv().
1037 if (*p == NUL || vim9_comment_start(p))
1038 p = (char_u *)"";
1039 plen = STRLEN(p);
1040 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1041 if (pnl != NULL)
1042 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001043 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1044 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001045 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001046 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001047 goto erret;
1048 if (cmdline != NULL)
1049 // more is following after the "}", which was skipped
1050 last = cmdline;
1051 else
1052 // nothing is following the "}"
1053 last = (char_u *)"}";
1054 plen = STRLEN(last);
1055 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1056 if (pnl != NULL)
1057 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001058 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1059 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001060 }
1061
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001062 if (cmdline != NULL)
1063 {
1064 // Something comes after the "}".
1065 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001066
1067 // "arg" points into cmdline, need to keep the line and free it later.
1068 vim_free(evalarg->eval_tofree_cmdline);
1069 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001070 }
1071 else
1072 *arg = (char_u *)"";
1073
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001074 if (!evaluate)
1075 {
1076 ret = OK;
1077 goto erret;
1078 }
1079
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 name = get_lambda_name();
1081 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1082 if (ufunc == NULL)
1083 goto erret;
1084 set_ufunc_name(ufunc, name);
1085 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001086 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001087 ufunc->uf_refcount = 1;
1088 ufunc->uf_args = *newargs;
1089 newargs->ga_data = NULL;
1090 ufunc->uf_def_args = *default_args;
1091 default_args->ga_data = NULL;
1092 ufunc->uf_func_type = &t_func_any;
1093
1094 // error messages are for the first function line
1095 lnum_save = SOURCING_LNUM;
1096 SOURCING_LNUM = sourcing_lnum_top;
1097
1098 // parse argument types
1099 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1100 {
1101 SOURCING_LNUM = lnum_save;
1102 goto erret;
1103 }
1104
1105 // parse the return type, if any
1106 if (parse_return_type(ufunc, ret_type) == FAIL)
1107 goto erret;
1108
1109 pt = ALLOC_CLEAR_ONE(partial_T);
1110 if (pt == NULL)
1111 goto erret;
1112 pt->pt_func = ufunc;
1113 pt->pt_refcount = 1;
1114
1115 ufunc->uf_lines = newlines;
1116 newlines.ga_data = NULL;
1117 if (sandbox)
1118 ufunc->uf_flags |= FC_SANDBOX;
1119 if (!ASCII_ISUPPER(*ufunc->uf_name))
1120 ufunc->uf_flags |= FC_VIM9;
1121 ufunc->uf_script_ctx = current_sctx;
1122 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1123 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1124 set_function_type(ufunc);
1125
1126 rettv->vval.v_partial = pt;
1127 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001128 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001129 ret = OK;
1130
1131erret:
1132 if (lnum_save >= 0)
1133 SOURCING_LNUM = lnum_save;
1134 vim_free(line_to_free);
1135 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001136 if (newargs != NULL)
1137 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001138 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001139 if (ufunc != NULL)
1140 {
1141 func_clear(ufunc, TRUE);
1142 func_free(ufunc, TRUE);
1143 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001144 return ret;
1145}
1146
1147/*
1148 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001149 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001150 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001151 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1152 */
1153 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001154get_lambda_tv(
1155 char_u **arg,
1156 typval_T *rettv,
1157 int types_optional,
1158 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001159{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001160 int evaluate = evalarg != NULL
1161 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001162 garray_T newargs;
1163 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001164 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001165 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001166 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001167 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001168 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001169 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001170 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001171 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001172 char_u *s;
1173 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001174 int *old_eval_lavars = eval_lavars_used;
1175 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001176 char_u *tofree1 = NULL;
1177 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001178 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001179 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001180 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001181
1182 if (equal_arrow && !in_vim9script())
1183 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001184
1185 ga_init(&newargs);
1186 ga_init(&newlines);
1187
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001188 // First, check if this is really a lambda expression. "->" or "=>" must
1189 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001190 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001191 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001192 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001193 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001194 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001195 {
1196 if (types_optional)
1197 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001198 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001199 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001200
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001201 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001202 if (evaluate)
1203 pnewargs = &newargs;
1204 else
1205 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001206 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001207 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001208 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001209 &varargs, &default_args,
1210 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001211 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001212 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001213 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001214 {
1215 if (types_optional)
1216 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001217 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001218 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001219 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001220 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001221
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001222 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1223 if (ret_type != NULL)
1224 {
1225 ret_type = vim_strsave(ret_type);
1226 tofree2 = ret_type;
1227 }
1228
Bram Moolenaare38eab22019-12-05 21:50:01 +01001229 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001230 if (evaluate)
1231 eval_lavars_used = &eval_lavars;
1232
Bram Moolenaar65c44152020-12-24 15:14:01 +01001233 *arg = skipwhite_and_linebreak(*arg, evalarg);
1234
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001235 // Recognize "{" as the start of a function body.
1236 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001237 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001238 if (evalarg == NULL)
1239 // cannot happen?
1240 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001241 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1242 types_optional ? &argtypes : NULL, varargs,
1243 &default_args, ret_type) == FAIL)
1244 goto errret;
1245 goto theend;
1246 }
1247 if (default_args.ga_len > 0)
1248 {
1249 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001250 goto errret;
1251 }
1252
Bram Moolenaare38eab22019-12-05 21:50:01 +01001253 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001254 start = *arg;
1255 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001256 if (ret == FAIL)
1257 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001258 if (evalarg != NULL)
1259 {
1260 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001261 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001262 evalarg->eval_tofree = NULL;
1263 }
1264
Bram Moolenaar65c44152020-12-24 15:14:01 +01001265 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001266 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001267 *arg = skipwhite_and_linebreak(*arg, evalarg);
1268 if (**arg != '}')
1269 {
1270 semsg(_("E451: Expected }: %s"), *arg);
1271 goto errret;
1272 }
1273 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001274 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001275
1276 if (evaluate)
1277 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001278 int len;
1279 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001280 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001281 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001282 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001283
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001284 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 if (fp == NULL)
1286 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001287 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001288 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001289 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001290 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001292 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1293 if (ga_grow(&newlines, 1) == FAIL)
1294 goto errret;
1295
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001296 // If there are line breaks, we need to split up the string.
1297 line_end = vim_strchr(start, '\n');
1298 if (line_end == NULL)
1299 line_end = end;
1300
1301 // Add "return " before the expression (or the first line).
1302 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001303 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001304 if (p == NULL)
1305 goto errret;
1306 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1307 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001308 vim_strncpy(p + 7, start, line_end - start);
1309
1310 if (line_end != end)
1311 {
1312 // Add more lines, split by line breaks. Thus is used when a
1313 // lambda with { cmds } is encountered.
1314 while (*line_end == '\n')
1315 {
1316 if (ga_grow(&newlines, 1) == FAIL)
1317 goto errret;
1318 start = line_end + 1;
1319 line_end = vim_strchr(start, '\n');
1320 if (line_end == NULL)
1321 line_end = end;
1322 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1323 vim_strnsave(start, line_end - start);
1324 }
1325 }
1326
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001327 if (strstr((char *)p + 7, "a:") == NULL)
1328 // No a: variables are used for sure.
1329 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001330
1331 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001332 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001333 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001334 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 if (types_optional)
1336 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001337 if (parse_argument_types(fp, &argtypes,
1338 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001339 goto errret;
1340 if (ret_type != NULL)
1341 {
1342 fp->uf_ret_type = parse_type(&ret_type,
1343 &fp->uf_type_list, TRUE);
1344 if (fp->uf_ret_type == NULL)
1345 goto errret;
1346 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001347 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001348 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001349 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001350
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001351 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001352 if (current_funccal != NULL && eval_lavars)
1353 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001354 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001355 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001356 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001357 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001358
1359#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 if (prof_def_func())
1361 func_do_profile(fp);
1362#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001363 if (sandbox)
1364 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001365 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001366 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1367 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001368 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001370 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001371 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001373 pt->pt_func = fp;
1374 pt->pt_refcount = 1;
1375 rettv->vval.v_partial = pt;
1376 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001377
1378 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001381theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001382 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001383 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001384 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001385 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001386 vim_free(tofree1);
1387 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001388 if (types_optional)
1389 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001390 return OK;
1391
1392errret:
1393 ga_clear_strings(&newargs);
1394 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001395 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001396 if (types_optional)
1397 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001398 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001399 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001400 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001401 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001402 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001403 vim_free(tofree1);
1404 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001405 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001406 return FAIL;
1407}
1408
1409/*
1410 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1411 * name it contains, otherwise return "name".
1412 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1413 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001414 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1415 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001416 */
1417 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001418deref_func_name(
1419 char_u *name,
1420 int *lenp,
1421 partial_T **partialp,
1422 type_T **type,
1423 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001424{
1425 dictitem_T *v;
1426 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001427 char_u *s = NULL;
1428 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001429
1430 if (partialp != NULL)
1431 *partialp = NULL;
1432
1433 cc = name[*lenp];
1434 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001435 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001436 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001437 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001439 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001441 if (v->di_tv.vval.v_string == NULL)
1442 {
1443 *lenp = 0;
1444 return (char_u *)""; // just in case
1445 }
1446 s = v->di_tv.vval.v_string;
1447 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001450 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001452 partial_T *pt = v->di_tv.vval.v_partial;
1453
1454 if (pt == NULL)
1455 {
1456 *lenp = 0;
1457 return (char_u *)""; // just in case
1458 }
1459 if (partialp != NULL)
1460 *partialp = pt;
1461 s = partial_name(pt);
1462 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001463 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001464
1465 if (s != NULL)
1466 {
1467 if (type != NULL && ht == get_script_local_ht())
1468 {
1469 svar_T *sv = find_typval_in_script(&v->di_tv);
1470
1471 if (sv != NULL)
1472 *type = sv->sv_type;
1473 }
1474 return s;
1475 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476 }
1477
1478 return name;
1479}
1480
1481/*
1482 * Give an error message with a function name. Handle <SNR> things.
1483 * "ermsg" is to be passed without translation, use N_() instead of _().
1484 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001485 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486emsg_funcname(char *ermsg, char_u *name)
1487{
1488 char_u *p;
1489
1490 if (*name == K_SPECIAL)
1491 p = concat_str((char_u *)"<SNR>", name + 3);
1492 else
1493 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001494 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001495 if (p != name)
1496 vim_free(p);
1497}
1498
1499/*
1500 * Allocate a variable for the result of a function.
1501 * Return OK or FAIL.
1502 */
1503 int
1504get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001505 char_u *name, // name of the function
1506 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001508 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001509 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001510 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511{
1512 char_u *argp;
1513 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001514 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1515 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001516 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517
1518 /*
1519 * Get the arguments.
1520 */
1521 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001522 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1523 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001524 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001525 // skip the '(' or ',' and possibly line breaks
1526 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1527
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 if (*argp == ')' || *argp == ',' || *argp == NUL)
1529 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001530 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531 {
1532 ret = FAIL;
1533 break;
1534 }
1535 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001536 // The comma should come right after the argument, but this wasn't
1537 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001538 if (vim9script)
1539 {
1540 if (*argp != ',' && *skipwhite(argp) == ',')
1541 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001542 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001543 ret = FAIL;
1544 break;
1545 }
1546 }
1547 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001548 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549 if (*argp != ',')
1550 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001551 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1552 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001553 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001554 ret = FAIL;
1555 break;
1556 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001557 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001558 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001559 if (*argp == ')')
1560 ++argp;
1561 else
1562 ret = FAIL;
1563
1564 if (ret == OK)
1565 {
1566 int i = 0;
1567
1568 if (get_vim_var_nr(VV_TESTING))
1569 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001570 // Prepare for calling test_garbagecollect_now(), need to know
1571 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 if (funcargs.ga_itemsize == 0)
1573 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1574 for (i = 0; i < argcount; ++i)
1575 if (ga_grow(&funcargs, 1) == OK)
1576 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1577 &argvars[i];
1578 }
1579
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001580 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001581
1582 funcargs.ga_len -= i;
1583 }
1584 else if (!aborting())
1585 {
1586 if (argcount == MAX_FUNC_ARGS)
1587 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1588 else
1589 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1590 }
1591
1592 while (--argcount >= 0)
1593 clear_tv(&argvars[argcount]);
1594
Bram Moolenaar8294d492020-08-10 22:40:56 +02001595 if (in_vim9script())
1596 *arg = argp;
1597 else
1598 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 return ret;
1600}
1601
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001602/*
1603 * Return TRUE if "p" starts with "<SID>" or "s:".
1604 * Only works if eval_fname_script() returned non-zero for "p"!
1605 */
1606 static int
1607eval_fname_sid(char_u *p)
1608{
1609 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1610}
1611
1612/*
1613 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1614 * Change <SNR>123_name() to K_SNR 123_name().
1615 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1616 * (slow).
1617 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001618 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1620{
1621 int llen;
1622 char_u *fname;
1623 int i;
1624
1625 llen = eval_fname_script(name);
1626 if (llen > 0)
1627 {
1628 fname_buf[0] = K_SPECIAL;
1629 fname_buf[1] = KS_EXTRA;
1630 fname_buf[2] = (int)KE_SNR;
1631 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001632 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001633 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001634 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001635 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 else
1637 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001638 sprintf((char *)fname_buf + 3, "%ld_",
1639 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 i = (int)STRLEN(fname_buf);
1641 }
1642 }
1643 if (i + STRLEN(name + llen) < FLEN_FIXED)
1644 {
1645 STRCPY(fname_buf + i, name + llen);
1646 fname = fname_buf;
1647 }
1648 else
1649 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001650 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001651 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001652 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653 else
1654 {
1655 *tofree = fname;
1656 mch_memmove(fname, fname_buf, (size_t)i);
1657 STRCPY(fname + i, name + llen);
1658 }
1659 }
1660 }
1661 else
1662 fname = name;
1663 return fname;
1664}
1665
1666/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001667 * Find a function "name" in script "sid".
1668 */
1669 static ufunc_T *
1670find_func_with_sid(char_u *name, int sid)
1671{
1672 hashitem_T *hi;
1673 char_u buffer[200];
1674
1675 buffer[0] = K_SPECIAL;
1676 buffer[1] = KS_EXTRA;
1677 buffer[2] = (int)KE_SNR;
1678 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1679 (long)sid, name);
1680 hi = hash_find(&func_hashtab, buffer);
1681 if (!HASHITEM_EMPTY(hi))
1682 return HI2UF(hi);
1683
1684 return NULL;
1685}
1686
1687/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001689 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001690 * Return NULL for unknown function.
1691 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001692 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001693find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694{
1695 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001696 ufunc_T *func;
1697 imported_T *imported;
1698
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001699 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001700 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001701 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001702 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001703 int find_script_local = in_vim9script()
1704 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001705
Bram Moolenaar95006e32020-08-29 17:47:08 +02001706 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001707 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001708 // Find script-local function before global one.
1709 func = find_func_with_sid(name, current_sctx.sc_sid);
1710 if (func != NULL)
1711 return func;
1712 }
1713
Bram Moolenaarefa94442020-08-08 22:16:00 +02001714 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001715 && name[1] == KS_EXTRA
1716 && name[2] == KE_SNR)
1717 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001718 // Caller changes s: to <SNR>99_name.
1719
1720 after_script = name + 3;
1721 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001722 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001723 ++after_script;
1724 else
1725 after_script = NULL;
1726 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001727 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001728 {
1729 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001730 if (after_script != NULL && sid != current_sctx.sc_sid)
1731 imported = find_imported_in_script(after_script, 0, sid);
1732 else
1733 imported = find_imported(after_script == NULL
1734 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001735 if (imported != NULL && imported->imp_funcname != NULL)
1736 {
1737 hi = hash_find(&func_hashtab, imported->imp_funcname);
1738 if (!HASHITEM_EMPTY(hi))
1739 return HI2UF(hi);
1740 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001741 }
1742 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743
Bram Moolenaara26b9702020-04-18 19:53:28 +02001744 hi = hash_find(&func_hashtab,
1745 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001746 if (!HASHITEM_EMPTY(hi))
1747 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001748
1749 return NULL;
1750}
1751
1752/*
1753 * Find a function by name, return pointer to it in ufuncs.
1754 * "cctx" is passed in a :def function to find imported functions.
1755 * Return NULL for unknown or dead function.
1756 */
1757 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001758find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001759{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001760 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001761
1762 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1763 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001764 return NULL;
1765}
1766
1767/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001768 * Return TRUE if "ufunc" is a global function.
1769 */
1770 int
1771func_is_global(ufunc_T *ufunc)
1772{
1773 return ufunc->uf_name[0] != K_SPECIAL;
1774}
1775
1776/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 * Copy the function name of "fp" to buffer "buf".
1778 * "buf" must be able to hold the function name plus three bytes.
1779 * Takes care of script-local function names.
1780 */
1781 static void
1782cat_func_name(char_u *buf, ufunc_T *fp)
1783{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001784 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 {
1786 STRCPY(buf, "<SNR>");
1787 STRCAT(buf, fp->uf_name + 3);
1788 }
1789 else
1790 STRCPY(buf, fp->uf_name);
1791}
1792
1793/*
1794 * Add a number variable "name" to dict "dp" with value "nr".
1795 */
1796 static void
1797add_nr_var(
1798 dict_T *dp,
1799 dictitem_T *v,
1800 char *name,
1801 varnumber_T nr)
1802{
1803 STRCPY(v->di_key, name);
1804 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1805 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1806 v->di_tv.v_type = VAR_NUMBER;
1807 v->di_tv.v_lock = VAR_FIXED;
1808 v->di_tv.vval.v_number = nr;
1809}
1810
1811/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001812 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001814 static void
1815free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001817 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001818
1819 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1820 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001821 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001822
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001823 // When garbage collecting a funccall_T may be freed before the
1824 // function that references it, clear its uf_scoped field.
1825 // The function may have been redefined and point to another
1826 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001827 if (fp != NULL && fp->uf_scoped == fc)
1828 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001829 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001830 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001832 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 vim_free(fc);
1834}
1835
1836/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001837 * Free "fc" and what it contains.
1838 * Can be called only when "fc" is kept beyond the period of it called,
1839 * i.e. after cleanup_function_call(fc).
1840 */
1841 static void
1842free_funccal_contents(funccall_T *fc)
1843{
1844 listitem_T *li;
1845
1846 // Free all l: variables.
1847 vars_clear(&fc->l_vars.dv_hashtab);
1848
1849 // Free all a: variables.
1850 vars_clear(&fc->l_avars.dv_hashtab);
1851
1852 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001853 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001854 clear_tv(&li->li_tv);
1855
1856 free_funccal(fc);
1857}
1858
1859/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001860 * Handle the last part of returning from a function: free the local hashtable.
1861 * Unless it is still in use by a closure.
1862 */
1863 static void
1864cleanup_function_call(funccall_T *fc)
1865{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001866 int may_free_fc = fc->fc_refcount <= 0;
1867 int free_fc = TRUE;
1868
Bram Moolenaar6914c642017-04-01 21:21:30 +02001869 current_funccal = fc->caller;
1870
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001871 // Free all l: variables if not referred.
1872 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1873 vars_clear(&fc->l_vars.dv_hashtab);
1874 else
1875 free_fc = FALSE;
1876
1877 // If the a:000 list and the l: and a: dicts are not referenced and
1878 // there is no closure using it, we can free the funccall_T and what's
1879 // in it.
1880 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1881 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001882 else
1883 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001884 int todo;
1885 hashitem_T *hi;
1886 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001887
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001888 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001889
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001890 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001891 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1892 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1893 {
1894 if (!HASHITEM_EMPTY(hi))
1895 {
1896 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001897 di = HI2DI(hi);
1898 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001899 }
1900 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001901 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001902
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001903 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1904 fc->l_varlist.lv_first = NULL;
1905 else
1906 {
1907 listitem_T *li;
1908
1909 free_fc = FALSE;
1910
1911 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001912 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001913 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001914 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001915
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001916 if (free_fc)
1917 free_funccal(fc);
1918 else
1919 {
1920 static int made_copy = 0;
1921
1922 // "fc" is still in use. This can happen when returning "a:000",
1923 // assigning "l:" to a global variable or defining a closure.
1924 // Link "fc" in the list for garbage collection later.
1925 fc->caller = previous_funccal;
1926 previous_funccal = fc;
1927
1928 if (want_garbage_collect)
1929 // If garbage collector is ready, clear count.
1930 made_copy = 0;
1931 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001932 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001933 // We have made a lot of copies, worth 4 Mbyte. This can happen
1934 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001935 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001936 // too much memory.
1937 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001938 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001939 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001940 }
1941}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001942
1943/*
1944 * There are two kinds of function names:
1945 * 1. ordinary names, function defined with :function or :def
1946 * 2. numbered functions and lambdas
1947 * For the first we only count the name stored in func_hashtab as a reference,
1948 * using function() does not count as a reference, because the function is
1949 * looked up by name.
1950 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001951 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001952func_name_refcount(char_u *name)
1953{
1954 return isdigit(*name) || *name == '<';
1955}
1956
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957/*
1958 * Unreference "fc": decrement the reference count and free it when it
1959 * becomes zero. "fp" is detached from "fc".
1960 * When "force" is TRUE we are exiting.
1961 */
1962 static void
1963funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1964{
1965 funccall_T **pfc;
1966 int i;
1967
1968 if (fc == NULL)
1969 return;
1970
1971 if (--fc->fc_refcount <= 0 && (force || (
1972 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1973 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1974 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1975 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1976 {
1977 if (fc == *pfc)
1978 {
1979 *pfc = fc->caller;
1980 free_funccal_contents(fc);
1981 return;
1982 }
1983 }
1984 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1985 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1986 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1987}
1988
1989/*
1990 * Remove the function from the function hashtable. If the function was
1991 * deleted while it still has references this was already done.
1992 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1993 */
1994 static int
1995func_remove(ufunc_T *fp)
1996{
1997 hashitem_T *hi;
1998
1999 // Return if it was already virtually deleted.
2000 if (fp->uf_flags & FC_DEAD)
2001 return FALSE;
2002
2003 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2004 if (!HASHITEM_EMPTY(hi))
2005 {
2006 // When there is a def-function index do not actually remove the
2007 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002008 // Do remove it when it's a copy.
2009 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002010 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002011 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002012 return FALSE;
2013 }
2014 hash_remove(&func_hashtab, hi);
2015 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002016 return TRUE;
2017 }
2018 return FALSE;
2019}
2020
2021 static void
2022func_clear_items(ufunc_T *fp)
2023{
2024 ga_clear_strings(&(fp->uf_args));
2025 ga_clear_strings(&(fp->uf_def_args));
2026 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002028 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002029 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002030 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002031
2032 // Increment the refcount of this function to avoid it being freed
2033 // recursively when the partial is freed.
2034 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002035 partial_unref(fp->uf_partial);
2036 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002037 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002038
2039#ifdef FEAT_LUA
2040 if (fp->uf_cb_free != NULL)
2041 {
2042 fp->uf_cb_free(fp->uf_cb_state);
2043 fp->uf_cb_free = NULL;
2044 }
2045
2046 fp->uf_cb_state = NULL;
2047 fp->uf_cb = NULL;
2048#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002049#ifdef FEAT_PROFILE
2050 VIM_CLEAR(fp->uf_tml_count);
2051 VIM_CLEAR(fp->uf_tml_total);
2052 VIM_CLEAR(fp->uf_tml_self);
2053#endif
2054}
2055
2056/*
2057 * Free all things that a function contains. Does not free the function
2058 * itself, use func_free() for that.
2059 * When "force" is TRUE we are exiting.
2060 */
2061 static void
2062func_clear(ufunc_T *fp, int force)
2063{
2064 if (fp->uf_cleared)
2065 return;
2066 fp->uf_cleared = TRUE;
2067
2068 // clear this function
2069 func_clear_items(fp);
2070 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002071 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002072}
2073
2074/*
2075 * Free a function and remove it from the list of functions. Does not free
2076 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002077 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002078 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002079 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002080 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002081func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002082{
2083 // Only remove it when not done already, otherwise we would remove a newer
2084 // version of the function with the same name.
2085 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2086 func_remove(fp);
2087
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002088 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002089 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002090 if (fp->uf_dfunc_idx > 0)
2091 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002092 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002093 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002094 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002095 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002096 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002097}
2098
2099/*
2100 * Free all things that a function contains and free the function itself.
2101 * When "force" is TRUE we are exiting.
2102 */
2103 static void
2104func_clear_free(ufunc_T *fp, int force)
2105{
2106 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002107 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2108 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002109 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002110 else
2111 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002112}
2113
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002114/*
2115 * Copy already defined function "lambda" to a new function with name "global".
2116 * This is for when a compiled function defines a global function.
2117 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002118 int
2119copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002120{
2121 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002122 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002123
2124 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002125 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002126 semsg(_(e_lambda_function_not_found_str), lambda);
2127 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002128 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002129
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002130 fp = find_func(global, TRUE, NULL);
2131 if (fp != NULL)
2132 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002133 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002134 semsg(_(e_funcexts), global);
2135 return FAIL;
2136 }
2137
2138 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2139 if (fp == NULL)
2140 return FAIL;
2141
2142 fp->uf_varargs = ufunc->uf_varargs;
2143 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2144 fp->uf_def_status = ufunc->uf_def_status;
2145 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2146 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2147 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2148 == FAIL
2149 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2150 goto failed;
2151
2152 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2153 : vim_strsave(ufunc->uf_name_exp);
2154 if (ufunc->uf_arg_types != NULL)
2155 {
2156 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2157 if (fp->uf_arg_types == NULL)
2158 goto failed;
2159 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2160 sizeof(type_T *) * fp->uf_args.ga_len);
2161 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002162 if (ufunc->uf_va_name != NULL)
2163 {
2164 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2165 if (fp->uf_va_name == NULL)
2166 goto failed;
2167 }
2168 fp->uf_ret_type = ufunc->uf_ret_type;
2169
2170 fp->uf_refcount = 1;
2171 STRCPY(fp->uf_name, global);
2172 hash_add(&func_hashtab, UF2HIKEY(fp));
2173
2174 // the referenced dfunc_T is now used one more time
2175 link_def_function(fp);
2176
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002177 // Create a partial to store the context of the function where it was
2178 // instantiated. Only needs to be done once. Do this on the original
2179 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002180 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2181 {
2182 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2183
2184 if (pt == NULL)
2185 goto failed;
2186 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002187 {
2188 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002189 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002190 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002191 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002192 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002193 }
2194
2195 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002196
2197failed:
2198 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002199 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002200}
2201
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002202static int funcdepth = 0;
2203
2204/*
2205 * Increment the function call depth count.
2206 * Return FAIL when going over 'maxfuncdepth'.
2207 * Otherwise return OK, must call funcdepth_decrement() later!
2208 */
2209 int
2210funcdepth_increment(void)
2211{
2212 if (funcdepth >= p_mfd)
2213 {
2214 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2215 return FAIL;
2216 }
2217 ++funcdepth;
2218 return OK;
2219}
2220
2221 void
2222funcdepth_decrement(void)
2223{
2224 --funcdepth;
2225}
2226
2227/*
2228 * Get the current function call depth.
2229 */
2230 int
2231funcdepth_get(void)
2232{
2233 return funcdepth;
2234}
2235
2236/*
2237 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002238 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002239 * times as funcdepth_increment().
2240 */
2241 void
2242funcdepth_restore(int depth)
2243{
2244 funcdepth = depth;
2245}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002246
2247/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002248 * Call a user function.
2249 */
2250 static void
2251call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002252 ufunc_T *fp, // pointer to function
2253 int argcount, // nr of args
2254 typval_T *argvars, // arguments
2255 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002256 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002257 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002258{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002259 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002260 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002261 funccall_T *fc;
2262 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002263 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002264 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002265 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002266 int i;
2267 int ai;
2268 int islambda = FALSE;
2269 char_u numbuf[NUMBUFLEN];
2270 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002271 typval_T *tv_to_free[MAX_FUNC_ARGS];
2272 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002273#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002274 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002275#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002276 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277
Bram Moolenaarb2049902021-01-24 12:53:53 +01002278#ifdef FEAT_PROFILE
2279 CLEAR_FIELD(profile_info);
2280#endif
2281
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002282 // If depth of calling is getting too high, don't execute the function.
2283 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002284 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285 rettv->v_type = VAR_NUMBER;
2286 rettv->vval.v_number = -1;
2287 return;
2288 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002289
Bram Moolenaare38eab22019-12-05 21:50:01 +01002290 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002291
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002292 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002293 if (fc == NULL)
2294 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295 fc->caller = current_funccal;
2296 current_funccal = fc;
2297 fc->func = fp;
2298 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002299 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002300 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2302 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002303 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002304 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002305 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002306
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002307 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002308 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002309#ifdef FEAT_PROFILE
2310 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2311#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002312 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002313#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002314 if (do_profiling == PROF_YES)
2315 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002316#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002317 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002318 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002319#ifdef FEAT_PROFILE
2320 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002321 || (caller != NULL && caller->uf_profiling)))
2322 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002323#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002324 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002325 free_funccal(fc);
2326 return;
2327 }
2328
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002329 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2330 islambda = TRUE;
2331
2332 /*
2333 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2334 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2335 * each argument variable and saves a lot of time.
2336 */
2337 /*
2338 * Init l: variables.
2339 */
2340 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2341 if (selfdict != NULL)
2342 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002343 // Set l:self to "selfdict". Use "name" to avoid a warning from
2344 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002345 v = &fc->fixvar[fixvar_idx++].var;
2346 name = v->di_key;
2347 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002348 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2350 v->di_tv.v_type = VAR_DICT;
2351 v->di_tv.v_lock = 0;
2352 v->di_tv.vval.v_dict = selfdict;
2353 ++selfdict->dv_refcount;
2354 }
2355
2356 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002357 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002358 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359 * Set a:000 to a list with room for the "..." arguments.
2360 */
2361 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002362 if ((fp->uf_flags & FC_NOARGS) == 0)
2363 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002364 (varnumber_T)(argcount >= fp->uf_args.ga_len
2365 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002366 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002367 if ((fp->uf_flags & FC_NOARGS) == 0)
2368 {
2369 // Use "name" to avoid a warning from some compiler that checks the
2370 // destination size.
2371 v = &fc->fixvar[fixvar_idx++].var;
2372 name = v->di_key;
2373 STRCPY(name, "000");
2374 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2375 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2376 v->di_tv.v_type = VAR_LIST;
2377 v->di_tv.v_lock = VAR_FIXED;
2378 v->di_tv.vval.v_list = &fc->l_varlist;
2379 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002380 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2382 fc->l_varlist.lv_lock = VAR_FIXED;
2383
2384 /*
2385 * Set a:firstline to "firstline" and a:lastline to "lastline".
2386 * Set a:name to named arguments.
2387 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002388 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002389 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002390 if ((fp->uf_flags & FC_NOARGS) == 0)
2391 {
2392 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002393 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002394 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002395 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002396 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002397 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 {
2399 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002400 typval_T def_rettv;
2401 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002402
2403 ai = i - fp->uf_args.ga_len;
2404 if (ai < 0)
2405 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002406 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 name = FUNCARG(fp, i);
2408 if (islambda)
2409 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002410
2411 // evaluate named argument default expression
2412 isdefault = ai + fp->uf_def_args.ga_len >= 0
2413 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2414 && argvars[i].vval.v_number == VVAL_NONE));
2415 if (isdefault)
2416 {
2417 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002418
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002419 def_rettv.v_type = VAR_NUMBER;
2420 def_rettv.vval.v_number = -1;
2421
2422 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2423 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002424 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002425 {
2426 default_arg_err = 1;
2427 break;
2428 }
2429 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 }
2431 else
2432 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002433 if ((fp->uf_flags & FC_NOARGS) != 0)
2434 // Bail out if no a: arguments used (in lambda).
2435 break;
2436
Bram Moolenaare38eab22019-12-05 21:50:01 +01002437 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438 sprintf((char *)numbuf, "%d", ai + 1);
2439 name = numbuf;
2440 }
2441 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2442 {
2443 v = &fc->fixvar[fixvar_idx++].var;
2444 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002445 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 }
2447 else
2448 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002449 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450 if (v == NULL)
2451 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002452 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002455 // Note: the values are copied directly to avoid alloc/free.
2456 // "argvars" must have VAR_FIXED for v_lock.
2457 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458 v->di_tv.v_lock = VAR_FIXED;
2459
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002460 if (isdefault)
2461 // Need to free this later, no matter where it's stored.
2462 tv_to_free[tv_to_free_len++] = &v->di_tv;
2463
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464 if (addlocal)
2465 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002466 // Named arguments should be accessed without the "a:" prefix in
2467 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002468 copy_tv(&v->di_tv, &v->di_tv);
2469 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002471 else
2472 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473
2474 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2475 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002476 listitem_T *li = &fc->l_listitems[ai];
2477
2478 li->li_tv = argvars[i];
2479 li->li_tv.v_lock = VAR_FIXED;
2480 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 }
2482 }
2483
Bram Moolenaare38eab22019-12-05 21:50:01 +01002484 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002486
2487 if (fp->uf_flags & FC_SANDBOX)
2488 {
2489 using_sandbox = TRUE;
2490 ++sandbox;
2491 }
2492
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002493 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002494 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002495 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002497 ++no_wait_return;
2498 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002499
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002500 smsg(_("calling %s"), SOURCING_NAME);
2501 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002503 char_u buf[MSG_BUF_LEN];
2504 char_u numbuf2[NUMBUFLEN];
2505 char_u *tofree;
2506 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002508 msg_puts("(");
2509 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002511 if (i > 0)
2512 msg_puts(", ");
2513 if (argvars[i].v_type == VAR_NUMBER)
2514 msg_outnum((long)argvars[i].vval.v_number);
2515 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002517 // Do not want errors such as E724 here.
2518 ++emsg_off;
2519 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2520 --emsg_off;
2521 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002523 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002525 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2526 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002527 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002528 msg_puts((char *)s);
2529 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 }
2531 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002533 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002535 msg_puts("\n"); // don't overwrite this either
2536
2537 verbose_leave_scroll();
2538 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 }
2540#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002541 if (do_profiling == PROF_YES)
2542 profile_may_start_func(&profile_info, fp,
2543 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544#endif
2545
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002546 save_current_sctx = current_sctx;
2547 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548 save_did_emsg = did_emsg;
2549 did_emsg = FALSE;
2550
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002551 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2552 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002553 else if (islambda)
2554 {
2555 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2556
2557 // A Lambda always has the command "return {expr}". It is much faster
2558 // to evaluate {expr} directly.
2559 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002560 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002561 --ex_nesting_level;
2562 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002563 else
2564 // call do_cmdline() to execute the lines
2565 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2567
2568 --RedrawingDisabled;
2569
Bram Moolenaare38eab22019-12-05 21:50:01 +01002570 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2572 {
2573 clear_tv(rettv);
2574 rettv->v_type = VAR_NUMBER;
2575 rettv->vval.v_number = -1;
2576 }
2577
2578#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002579 if (do_profiling == PROF_YES)
2580 {
2581 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2582
2583 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2584 profile_may_end_func(&profile_info, fp, caller);
2585 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586#endif
2587
Bram Moolenaare38eab22019-12-05 21:50:01 +01002588 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002589 if (p_verbose >= 12)
2590 {
2591 ++no_wait_return;
2592 verbose_enter_scroll();
2593
2594 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002595 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002596 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002597 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002598 (long)fc->rettv->vval.v_number);
2599 else
2600 {
2601 char_u buf[MSG_BUF_LEN];
2602 char_u numbuf2[NUMBUFLEN];
2603 char_u *tofree;
2604 char_u *s;
2605
Bram Moolenaare38eab22019-12-05 21:50:01 +01002606 // The value may be very long. Skip the middle part, so that we
2607 // have some idea how it starts and ends. smsg() would always
2608 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002609 ++emsg_off;
2610 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2611 --emsg_off;
2612 if (s != NULL)
2613 {
2614 if (vim_strsize(s) > MSG_BUF_CLEN)
2615 {
2616 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2617 s = buf;
2618 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002619 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002620 vim_free(tofree);
2621 }
2622 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002623 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624
2625 verbose_leave_scroll();
2626 --no_wait_return;
2627 }
2628
Bram Moolenaare31ee862020-01-07 20:59:34 +01002629 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002630 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002631 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632#ifdef FEAT_PROFILE
2633 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002634 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002635#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002636 if (using_sandbox)
2637 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002639 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 {
2641 ++no_wait_return;
2642 verbose_enter_scroll();
2643
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002644 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002645 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646
2647 verbose_leave_scroll();
2648 --no_wait_return;
2649 }
2650
2651 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002652 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002653 for (i = 0; i < tv_to_free_len; ++i)
2654 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002655 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656}
2657
2658/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002659 * Check the argument count for user function "fp".
2660 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2661 */
2662 int
2663check_user_func_argcount(ufunc_T *fp, int argcount)
2664{
2665 int regular_args = fp->uf_args.ga_len;
2666
2667 if (argcount < regular_args - fp->uf_def_args.ga_len)
2668 return FCERR_TOOFEW;
2669 else if (!has_varargs(fp) && argcount > regular_args)
2670 return FCERR_TOOMANY;
2671 return FCERR_UNKNOWN;
2672}
2673
2674/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002675 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002676 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002677 int
2678call_user_func_check(
2679 ufunc_T *fp,
2680 int argcount,
2681 typval_T *argvars,
2682 typval_T *rettv,
2683 funcexe_T *funcexe,
2684 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002685{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002686 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002687
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002688 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2689 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002690 error = check_user_func_argcount(fp, argcount);
2691 if (error != FCERR_UNKNOWN)
2692 return error;
2693 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002694 error = FCERR_DICT;
2695 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002696 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002697 int did_save_redo = FALSE;
2698 save_redo_T save_redo;
2699
2700 /*
2701 * Call the user function.
2702 * Save and restore search patterns, script variables and
2703 * redo buffer.
2704 */
2705 save_search_patterns();
2706 if (!ins_compl_active())
2707 {
2708 saveRedobuff(&save_redo);
2709 did_save_redo = TRUE;
2710 }
2711 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002712 call_user_func(fp, argcount, argvars, rettv, funcexe,
2713 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002714 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2715 // Function was unreferenced while being used, free it now.
2716 func_clear_free(fp, FALSE);
2717 if (did_save_redo)
2718 restoreRedobuff(&save_redo);
2719 restore_search_patterns();
2720 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002721 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002722 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002723}
2724
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002725static funccal_entry_T *funccal_stack = NULL;
2726
2727/*
2728 * Save the current function call pointer, and set it to NULL.
2729 * Used when executing autocommands and for ":source".
2730 */
2731 void
2732save_funccal(funccal_entry_T *entry)
2733{
2734 entry->top_funccal = current_funccal;
2735 entry->next = funccal_stack;
2736 funccal_stack = entry;
2737 current_funccal = NULL;
2738}
2739
2740 void
2741restore_funccal(void)
2742{
2743 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002744 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002745 else
2746 {
2747 current_funccal = funccal_stack->top_funccal;
2748 funccal_stack = funccal_stack->next;
2749 }
2750}
2751
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002752 funccall_T *
2753get_current_funccal(void)
2754{
2755 return current_funccal;
2756}
2757
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002758/*
2759 * Mark all functions of script "sid" as deleted.
2760 */
2761 void
2762delete_script_functions(int sid)
2763{
2764 hashitem_T *hi;
2765 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002766 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002767 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002768 size_t len;
2769
2770 buf[0] = K_SPECIAL;
2771 buf[1] = KS_EXTRA;
2772 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002773 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002774 len = STRLEN(buf);
2775
Bram Moolenaarce658352020-07-31 23:47:12 +02002776 while (todo > 0)
2777 {
2778 todo = func_hashtab.ht_used;
2779 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2780 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002781 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002782 fp = HI2UF(hi);
2783 if (STRNCMP(fp->uf_name, buf, len) == 0)
2784 {
2785 int changed = func_hashtab.ht_changed;
2786
2787 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002788
2789 if (fp->uf_calls > 0)
2790 {
2791 // Function is executing, don't free it but do remove
2792 // it from the hashtable.
2793 if (func_remove(fp))
2794 fp->uf_refcount--;
2795 }
2796 else
2797 {
2798 func_clear(fp, TRUE);
2799 // When clearing a function another function can be
2800 // cleared as a side effect. When that happens start
2801 // over.
2802 if (changed != func_hashtab.ht_changed)
2803 break;
2804 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002805 }
2806 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002807 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002808 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002809}
2810
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002811#if defined(EXITFREE) || defined(PROTO)
2812 void
2813free_all_functions(void)
2814{
2815 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002816 ufunc_T *fp;
2817 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002818 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002819 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820
Bram Moolenaare38eab22019-12-05 21:50:01 +01002821 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002822 while (current_funccal != NULL)
2823 {
2824 clear_tv(current_funccal->rettv);
2825 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002826 if (current_funccal == NULL && funccal_stack != NULL)
2827 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002828 }
2829
Bram Moolenaare38eab22019-12-05 21:50:01 +01002830 // First clear what the functions contain. Since this may lower the
2831 // reference count of a function, it may also free a function and change
2832 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002833 while (todo > 0)
2834 {
2835 todo = func_hashtab.ht_used;
2836 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2837 if (!HASHITEM_EMPTY(hi))
2838 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002839 // clear the def function index now
2840 fp = HI2UF(hi);
2841 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002842 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002843
Bram Moolenaare38eab22019-12-05 21:50:01 +01002844 // Only free functions that are not refcounted, those are
2845 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002846 if (func_name_refcount(fp->uf_name))
2847 ++skipped;
2848 else
2849 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002850 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002851 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002852 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002853 {
2854 skipped = 0;
2855 break;
2856 }
2857 }
2858 --todo;
2859 }
2860 }
2861
Bram Moolenaare38eab22019-12-05 21:50:01 +01002862 // Now actually free the functions. Need to start all over every time,
2863 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002864 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002865 while (func_hashtab.ht_used > skipped)
2866 {
2867 todo = func_hashtab.ht_used;
2868 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 if (!HASHITEM_EMPTY(hi))
2870 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002871 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002872 // Only free functions that are not refcounted, those are
2873 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002874 fp = HI2UF(hi);
2875 if (func_name_refcount(fp->uf_name))
2876 ++skipped;
2877 else
2878 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002879 if (func_free(fp, FALSE) == OK)
2880 {
2881 skipped = 0;
2882 break;
2883 }
2884 // did not actually free it
2885 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002886 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002888 }
2889 if (skipped == 0)
2890 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002891
2892 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893}
2894#endif
2895
2896/*
2897 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002898 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002899 * "len" is the length of "name", or -1 for NUL terminated.
2900 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902builtin_function(char_u *name, int len)
2903{
2904 char_u *p;
2905
Bram Moolenaara26b9702020-04-18 19:53:28 +02002906 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 return FALSE;
2908 p = vim_strchr(name, AUTOLOAD_CHAR);
2909 return p == NULL || (len > 0 && p > name + len);
2910}
2911
2912 int
2913func_call(
2914 char_u *name,
2915 typval_T *args,
2916 partial_T *partial,
2917 dict_T *selfdict,
2918 typval_T *rettv)
2919{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002920 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002921 listitem_T *item;
2922 typval_T argv[MAX_FUNC_ARGS + 1];
2923 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 int r = 0;
2925
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002926 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002927 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928 {
2929 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2930 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002931 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932 break;
2933 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002934 // Make a copy of each argument. This is needed to be able to set
2935 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936 copy_tv(&item->li_tv, &argv[argc++]);
2937 }
2938
2939 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002940 {
2941 funcexe_T funcexe;
2942
Bram Moolenaara80faa82020-04-12 19:37:17 +02002943 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002944 funcexe.firstline = curwin->w_cursor.lnum;
2945 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002946 funcexe.evaluate = TRUE;
2947 funcexe.partial = partial;
2948 funcexe.selfdict = selfdict;
2949 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2950 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951
Bram Moolenaare38eab22019-12-05 21:50:01 +01002952 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002953 while (argc > 0)
2954 clear_tv(&argv[--argc]);
2955
2956 return r;
2957}
2958
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002959static int callback_depth = 0;
2960
2961 int
2962get_callback_depth(void)
2963{
2964 return callback_depth;
2965}
2966
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002968 * Invoke call_func() with a callback.
2969 */
2970 int
2971call_callback(
2972 callback_T *callback,
2973 int len, // length of "name" or -1 to use strlen()
2974 typval_T *rettv, // return value goes here
2975 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002976 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002977 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002978{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002979 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002980 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002981
Bram Moolenaara80faa82020-04-12 19:37:17 +02002982 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002983 funcexe.evaluate = TRUE;
2984 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002985 ++callback_depth;
2986 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2987 --callback_depth;
2988 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002989}
2990
2991/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002992 * Give an error message for the result of a function.
2993 * Nothing if "error" is FCERR_NONE.
2994 */
2995 void
2996user_func_error(int error, char_u *name)
2997{
2998 switch (error)
2999 {
3000 case FCERR_UNKNOWN:
3001 emsg_funcname(e_unknownfunc, name);
3002 break;
3003 case FCERR_NOTMETHOD:
3004 emsg_funcname(
3005 N_("E276: Cannot use function as a method: %s"), name);
3006 break;
3007 case FCERR_DELETED:
3008 emsg_funcname(N_(e_func_deleted), name);
3009 break;
3010 case FCERR_TOOMANY:
3011 emsg_funcname((char *)e_toomanyarg, name);
3012 break;
3013 case FCERR_TOOFEW:
3014 emsg_funcname((char *)e_toofewarg, name);
3015 break;
3016 case FCERR_SCRIPT:
3017 emsg_funcname(
3018 N_("E120: Using <SID> not in a script context: %s"), name);
3019 break;
3020 case FCERR_DICT:
3021 emsg_funcname(
3022 N_("E725: Calling dict function without Dictionary: %s"),
3023 name);
3024 break;
3025 }
3026}
3027
3028/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003030 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031 * Return FAIL when the function can't be called, OK otherwise.
3032 * Also returns OK when an error was encountered while executing the function.
3033 */
3034 int
3035call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003036 char_u *funcname, // name of the function
3037 int len, // length of "name" or -1 to use strlen()
3038 typval_T *rettv, // return value goes here
3039 int argcount_in, // number of "argvars"
3040 typval_T *argvars_in, // vars for arguments, must have "argcount"
3041 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003042 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043{
3044 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003045 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003047 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048 char_u fname_buf[FLEN_FIXED + 1];
3049 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003050 char_u *fname = NULL;
3051 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003052 int argcount = argcount_in;
3053 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003054 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003055 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3056 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003057 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003058 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003059 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003061 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3062 // even when call_func() returns FAIL.
3063 rettv->v_type = VAR_UNKNOWN;
3064
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003065 if (partial != NULL)
3066 fp = partial->pt_func;
3067 if (fp == NULL)
3068 {
3069 // Make a copy of the name, if it comes from a funcref variable it
3070 // could be changed or deleted in the called function.
3071 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3072 if (name == NULL)
3073 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003074
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003075 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3076 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003078 if (funcexe->doesrange != NULL)
3079 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003080
3081 if (partial != NULL)
3082 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003083 // When the function has a partial with a dict and there is a dict
3084 // argument, use the dict argument. That is backwards compatible.
3085 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003086 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003088 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003089 {
3090 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003091 {
3092 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3093 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003094 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003095 goto theend;
3096 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003097 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003098 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 for (i = 0; i < argcount_in; ++i)
3100 argv[i + argv_clear] = argvars_in[i];
3101 argvars = argv;
3102 argcount = partial->pt_argc + argcount_in;
3103 }
3104 }
3105
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003106 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3107 {
3108 // Check that the argument types are OK for the types of the funcref.
3109 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003110 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003111 error = FCERR_OTHER;
3112 }
3113
Bram Moolenaaref140542019-12-31 21:27:13 +01003114 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 {
3116 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003117 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118
Bram Moolenaar333894b2020-08-01 18:53:07 +02003119 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003120 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003121 {
3122 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003124 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125
Bram Moolenaare38eab22019-12-05 21:50:01 +01003126 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003128 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003130 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 {
3132 /*
3133 * User defined function.
3134 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003135 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003136 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003137
Bram Moolenaare38eab22019-12-05 21:50:01 +01003138 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 if (fp == NULL
3140 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003141 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142 && !aborting())
3143 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003144 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003145 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003146 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003147 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3149 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003150 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003151 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003153 if (fp == NULL)
3154 {
3155 char_u *p = untrans_function_name(rfname);
3156
3157 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003158 // Don't do this if the name starts with "s:".
3159 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003160 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003161 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003163 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003164 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003165#ifdef FEAT_LUA
3166 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3167 {
3168 cfunc_T cb = fp->uf_cb;
3169
3170 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3171 }
3172#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003173 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003175 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003176 // postponed filling in the arguments, do it now
3177 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003178 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003179
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003180 if (funcexe->basetv != NULL)
3181 {
3182 // Method call: base->Method()
3183 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3184 argv[0] = *funcexe->basetv;
3185 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003186 argvars = argv;
3187 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003188 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003189
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003190 error = call_user_func_check(fp, argcount, argvars, rettv,
3191 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192 }
3193 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003194 else if (funcexe->basetv != NULL)
3195 {
3196 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003197 * expr->method(): Find the method name in the table, call its
3198 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003199 */
3200 error = call_internal_method(fname, argcount, argvars, rettv,
3201 funcexe->basetv);
3202 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 else
3204 {
3205 /*
3206 * Find the function name in the table, call its implementation.
3207 */
3208 error = call_internal_func(fname, argcount, argvars, rettv);
3209 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003210
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211 /*
3212 * The function call (or "FuncUndefined" autocommand sequence) might
3213 * have been aborted by an error, an interrupt, or an explicitly thrown
3214 * exception that has not been caught so far. This situation can be
3215 * tested for by calling aborting(). For an error in an internal
3216 * function or for the "E132" error in call_user_func(), however, the
3217 * throw point at which the "force_abort" flag (temporarily reset by
3218 * emsg()) is normally updated has not been reached yet. We need to
3219 * update that flag first to make aborting() reliable.
3220 */
3221 update_force_abort();
3222 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003223 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003224 ret = OK;
3225
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003226theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227 /*
3228 * Report an error unless the argument evaluation or function call has been
3229 * cancelled due to an aborting error, an interrupt, or an exception.
3230 */
3231 if (!aborting())
3232 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003233 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 }
3235
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003236 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003238 clear_tv(&argv[--argv_clear + argv_base]);
3239
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003240 vim_free(tofree);
3241 vim_free(name);
3242
3243 return ret;
3244}
3245
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003246 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003247printable_func_name(ufunc_T *fp)
3248{
3249 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3250}
3251
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003253 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254 */
3255 static void
3256list_func_head(ufunc_T *fp, int indent)
3257{
3258 int j;
3259
3260 msg_start();
3261 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003262 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003263 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003264 msg_puts("def ");
3265 else
3266 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003267 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 msg_putchar('(');
3269 for (j = 0; j < fp->uf_args.ga_len; ++j)
3270 {
3271 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003272 msg_puts(", ");
3273 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003274 if (fp->uf_arg_types != NULL)
3275 {
3276 char *tofree;
3277
3278 msg_puts(": ");
3279 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3280 vim_free(tofree);
3281 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003282 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3283 {
3284 msg_puts(" = ");
3285 msg_puts(((char **)(fp->uf_def_args.ga_data))
3286 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3287 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003288 }
3289 if (fp->uf_varargs)
3290 {
3291 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003292 msg_puts(", ");
3293 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003295 if (fp->uf_va_name != NULL)
3296 {
3297 if (j)
3298 msg_puts(", ");
3299 msg_puts("...");
3300 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003301 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003302 {
3303 char *tofree;
3304
3305 msg_puts(": ");
3306 msg_puts(type_name(fp->uf_va_type, &tofree));
3307 vim_free(tofree);
3308 }
3309 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003311
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003312 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003313 {
3314 if (fp->uf_ret_type != &t_void)
3315 {
3316 char *tofree;
3317
3318 msg_puts(": ");
3319 msg_puts(type_name(fp->uf_ret_type, &tofree));
3320 vim_free(tofree);
3321 }
3322 }
3323 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003324 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003326 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003328 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003329 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003330 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 msg_clr_eos();
3332 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003333 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334}
3335
3336/*
3337 * Get a function name, translating "<SID>" and "<SNR>".
3338 * Also handles a Funcref in a List or Dictionary.
3339 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003340 * Set "*is_global" to TRUE when the function must be global, unless
3341 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342 * flags:
3343 * TFN_INT: internal function name OK
3344 * TFN_QUIET: be quiet
3345 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003346 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 * Advances "pp" to just after the function name (if no error).
3348 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003349 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350trans_function_name(
3351 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003352 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003353 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003355 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003356 partial_T **partial, // return: partial of a FuncRef
3357 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358{
3359 char_u *name = NULL;
3360 char_u *start;
3361 char_u *end;
3362 int lead;
3363 char_u sid_buf[20];
3364 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003365 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003367 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003368 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369
3370 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003371 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 start = *pp;
3373
Bram Moolenaare38eab22019-12-05 21:50:01 +01003374 // Check for hard coded <SNR>: already translated function ID (from a user
3375 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3377 && (*pp)[2] == (int)KE_SNR)
3378 {
3379 *pp += 3;
3380 len = get_id_len(pp) + 3;
3381 return vim_strnsave(start, len);
3382 }
3383
Bram Moolenaare38eab22019-12-05 21:50:01 +01003384 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3385 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 lead = eval_fname_script(start);
3387 if (lead > 2)
3388 start += lead;
3389
Bram Moolenaare38eab22019-12-05 21:50:01 +01003390 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003391 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 lead > 2 ? 0 : FNE_CHECK_START);
3393 if (end == start)
3394 {
3395 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003396 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 goto theend;
3398 }
3399 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3400 {
3401 /*
3402 * Report an invalid expression in braces, unless the expression
3403 * evaluation has been cancelled due to an aborting error, an
3404 * interrupt, or an exception.
3405 */
3406 if (!aborting())
3407 {
3408 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003409 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 }
3411 else
3412 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3413 goto theend;
3414 }
3415
3416 if (lv.ll_tv != NULL)
3417 {
3418 if (fdp != NULL)
3419 {
3420 fdp->fd_dict = lv.ll_dict;
3421 fdp->fd_newkey = lv.ll_newkey;
3422 lv.ll_newkey = NULL;
3423 fdp->fd_di = lv.ll_di;
3424 }
3425 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3426 {
3427 name = vim_strsave(lv.ll_tv->vval.v_string);
3428 *pp = end;
3429 }
3430 else if (lv.ll_tv->v_type == VAR_PARTIAL
3431 && lv.ll_tv->vval.v_partial != NULL)
3432 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003433 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 *pp = end;
3435 if (partial != NULL)
3436 *partial = lv.ll_tv->vval.v_partial;
3437 }
3438 else
3439 {
3440 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3441 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003442 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 else
3444 *pp = end;
3445 name = NULL;
3446 }
3447 goto theend;
3448 }
3449
3450 if (lv.ll_name == NULL)
3451 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003452 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453 *pp = end;
3454 goto theend;
3455 }
3456
Bram Moolenaare38eab22019-12-05 21:50:01 +01003457 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 if (lv.ll_exp_name != NULL)
3459 {
3460 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003461 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 flags & TFN_NO_AUTOLOAD);
3463 if (name == lv.ll_exp_name)
3464 name = NULL;
3465 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003466 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467 {
3468 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003469 name = deref_func_name(*pp, &len, partial, type,
3470 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 if (name == *pp)
3472 name = NULL;
3473 }
3474 if (name != NULL)
3475 {
3476 name = vim_strsave(name);
3477 *pp = end;
3478 if (STRNCMP(name, "<SNR>", 5) == 0)
3479 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003480 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003481 name[0] = K_SPECIAL;
3482 name[1] = KS_EXTRA;
3483 name[2] = (int)KE_SNR;
3484 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3485 }
3486 goto theend;
3487 }
3488
3489 if (lv.ll_exp_name != NULL)
3490 {
3491 len = (int)STRLEN(lv.ll_exp_name);
3492 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3493 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3494 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003495 // When there was "s:" already or the name expanded to get a
3496 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003497 lv.ll_name += 2;
3498 len -= 2;
3499 lead = 2;
3500 }
3501 }
3502 else
3503 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003504 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003506 {
3507 if (is_global != NULL && lv.ll_name[0] == 'g')
3508 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003510 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511 len = (int)(end - lv.ll_name);
3512 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003513 if (len <= 0)
3514 {
3515 if (!skip)
3516 emsg(_(e_function_name));
3517 goto theend;
3518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003519
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003520 // In Vim9 script a user function is script-local by default, unless it
3521 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003522 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003523 if (vim9script)
3524 {
3525 char_u *p;
3526
3527 // SomeScript#func() is a global function.
3528 for (p = start; *p != NUL && *p != '('; ++p)
3529 if (*p == AUTOLOAD_CHAR)
3530 vim9script = FALSE;
3531 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003532
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 /*
3534 * Copy the function name to allocated memory.
3535 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3536 * Accept <SNR>123_name() outside a script.
3537 */
3538 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003539 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003540 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003542 if (!vim9script)
3543 lead = 3;
3544 if (vim9script || (lv.ll_exp_name != NULL
3545 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 || eval_fname_sid(*pp))
3547 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003548 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003549 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003551 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 goto theend;
3553 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003554 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003555 if (vim9script)
3556 extra = 3 + (int)STRLEN(sid_buf);
3557 else
3558 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559 }
3560 }
3561 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3562 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003563 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 start);
3565 goto theend;
3566 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003567 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 {
3569 char_u *cp = vim_strchr(lv.ll_name, ':');
3570
3571 if (cp != NULL && cp < end)
3572 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003573 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003574 goto theend;
3575 }
3576 }
3577
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003578 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 if (name != NULL)
3580 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003581 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003582 {
3583 name[0] = K_SPECIAL;
3584 name[1] = KS_EXTRA;
3585 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003586 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 STRCPY(name + 3, sid_buf);
3588 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003589 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3590 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 }
3592 *pp = end;
3593
3594theend:
3595 clear_lval(&lv);
3596 return name;
3597}
3598
3599/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003600 * Assuming "name" is the result of trans_function_name() and it was prefixed
3601 * to use the script-local name, return the unmodified name (points into
3602 * "name"). Otherwise return NULL.
3603 * This can be used to first search for a script-local function and fall back
3604 * to the global function if not found.
3605 */
3606 char_u *
3607untrans_function_name(char_u *name)
3608{
3609 char_u *p;
3610
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003611 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003612 {
3613 p = vim_strchr(name, '_');
3614 if (p != NULL)
3615 return p + 1;
3616 }
3617 return NULL;
3618}
3619
3620/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003621 * List functions. When "regmatch" is NULL all of then.
3622 * Otherwise functions matching "regmatch".
3623 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003624 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003625list_functions(regmatch_T *regmatch)
3626{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003627 int changed = func_hashtab.ht_changed;
3628 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003629 hashitem_T *hi;
3630
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003631 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003632 {
3633 if (!HASHITEM_EMPTY(hi))
3634 {
3635 ufunc_T *fp = HI2UF(hi);
3636
3637 --todo;
3638 if ((fp->uf_flags & FC_DEAD) == 0
3639 && (regmatch == NULL
3640 ? !message_filtered(fp->uf_name)
3641 && !func_name_refcount(fp->uf_name)
3642 : !isdigit(*fp->uf_name)
3643 && vim_regexec(regmatch, fp->uf_name, 0)))
3644 {
3645 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003646 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003647 {
3648 emsg(_("E454: function list was modified"));
3649 return;
3650 }
3651 }
3652 }
3653 }
3654}
3655
3656/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003657 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003658 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3659 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003660 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003662 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003663define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003665 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003666 int j;
3667 int c;
3668 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003669 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003670 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 char_u *p;
3672 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003673 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 char_u *line_arg = NULL;
3675 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003676 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003677 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 garray_T newlines;
3679 int varargs = FALSE;
3680 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003681 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003682 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003683 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 dictitem_T *v;
3685 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003686 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003689 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003690 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003691 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692
3693 /*
3694 * ":function" without argument: list functions.
3695 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003696 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 {
3698 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003699 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003701 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702 }
3703
3704 /*
3705 * ":function /pat": list functions matching pattern.
3706 */
3707 if (*eap->arg == '/')
3708 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003709 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 if (!eap->skip)
3711 {
3712 regmatch_T regmatch;
3713
3714 c = *p;
3715 *p = NUL;
3716 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3717 *p = c;
3718 if (regmatch.regprog != NULL)
3719 {
3720 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003721 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 vim_regfree(regmatch.regprog);
3723 }
3724 }
3725 if (*p == '/')
3726 ++p;
3727 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003728 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 }
3730
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003731 ga_init(&newargs);
3732 ga_init(&argtypes);
3733 ga_init(&default_args);
3734
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 /*
3736 * Get the function name. There are these situations:
3737 * func normal function name
3738 * "name" == func, "fudi.fd_dict" == NULL
3739 * dict.func new dictionary entry
3740 * "name" == NULL, "fudi.fd_dict" set,
3741 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3742 * dict.func existing dict entry with a Funcref
3743 * "name" == func, "fudi.fd_dict" set,
3744 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3745 * dict.func existing dict entry that's not a Funcref
3746 * "name" == NULL, "fudi.fd_dict" set,
3747 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3748 * s:func script-local function name
3749 * g:func global function name, same as "func"
3750 */
3751 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003752 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003754 // nested function, argument is (args).
3755 paren = TRUE;
3756 CLEAR_FIELD(fudi);
3757 }
3758 else
3759 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003760 if (STRNCMP(p, "<lambda>", 8) == 0)
3761 {
3762 p += 8;
3763 (void)getdigits(&p);
3764 name = vim_strnsave(eap->arg, p - eap->arg);
3765 CLEAR_FIELD(fudi);
3766 }
3767 else
3768 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003769 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003770 paren = (vim_strchr(p, '(') != NULL);
3771 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003773 /*
3774 * Return on an invalid expression in braces, unless the expression
3775 * evaluation has been cancelled due to an aborting error, an
3776 * interrupt, or an exception.
3777 */
3778 if (!aborting())
3779 {
3780 if (!eap->skip && fudi.fd_newkey != NULL)
3781 semsg(_(e_dictkey), fudi.fd_newkey);
3782 vim_free(fudi.fd_newkey);
3783 return NULL;
3784 }
3785 else
3786 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 }
3789
Bram Moolenaare38eab22019-12-05 21:50:01 +01003790 // An error in a function call during evaluation of an expression in magic
3791 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 saved_did_emsg = did_emsg;
3793 did_emsg = FALSE;
3794
3795 /*
3796 * ":function func" with only function name: list function.
3797 */
3798 if (!paren)
3799 {
3800 if (!ends_excmd(*skipwhite(p)))
3801 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003802 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803 goto ret_free;
3804 }
3805 eap->nextcmd = check_nextcmd(p);
3806 if (eap->nextcmd != NULL)
3807 *p = NUL;
3808 if (!eap->skip && !got_int)
3809 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003810 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003811 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3812 {
3813 char_u *up = untrans_function_name(name);
3814
3815 // With Vim9 script the name was made script-local, if not
3816 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003817 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003818 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003819 }
3820
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 if (fp != NULL)
3822 {
3823 list_func_head(fp, TRUE);
3824 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3825 {
3826 if (FUNCLINE(fp, j) == NULL)
3827 continue;
3828 msg_putchar('\n');
3829 msg_outnum((long)(j + 1));
3830 if (j < 9)
3831 msg_putchar(' ');
3832 if (j < 99)
3833 msg_putchar(' ');
3834 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003835 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 ui_breakcheck();
3837 }
3838 if (!got_int)
3839 {
3840 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003841 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003842 msg_puts(" enddef");
3843 else
3844 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003845 }
3846 }
3847 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003848 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 }
3850 goto ret_free;
3851 }
3852
3853 /*
3854 * ":function name(arg1, arg2)" Define function.
3855 */
3856 p = skipwhite(p);
3857 if (*p != '(')
3858 {
3859 if (!eap->skip)
3860 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003861 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003862 goto ret_free;
3863 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003864 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865 if (vim_strchr(p, '(') != NULL)
3866 p = vim_strchr(p, '(');
3867 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003869 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3870 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003871 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003872 goto ret_free;
3873 }
3874
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003875 // In Vim9 script only global functions can be redefined.
3876 if (vim9script && eap->forceit && !is_global)
3877 {
3878 emsg(_(e_nobang));
3879 goto ret_free;
3880 }
3881
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003882 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003883
Bram Moolenaar04b12692020-05-04 23:24:44 +02003884 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003886 // Check the name of the function. Unless it's a dictionary function
3887 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888 if (name != NULL)
3889 arg = name;
3890 else
3891 arg = fudi.fd_newkey;
3892 if (arg != NULL && (fudi.fd_di == NULL
3893 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3894 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3895 {
3896 if (*arg == K_SPECIAL)
3897 j = 3;
3898 else
3899 j = 0;
3900 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3901 : eval_isnamec(arg[j])))
3902 ++j;
3903 if (arg[j] != NUL)
3904 emsg_funcname((char *)e_invarg2, arg);
3905 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003906 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003908 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909 }
3910
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003911 // This may get more lines and make the pointers into the first line
3912 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003913 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003914 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003915 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003916 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003917 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003919 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003921 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003922 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003923 // find the return type: :def Func(): type
3924 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003926 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003927 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003928 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003929 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003930 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003931 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003932 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003933 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003934 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003935 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003936 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003937 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003938 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003940 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003942 else
3943 // find extra arguments "range", "dict", "abort" and "closure"
3944 for (;;)
3945 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003946 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003947 p = skipwhite(p);
3948 if (STRNCMP(p, "range", 5) == 0)
3949 {
3950 flags |= FC_RANGE;
3951 p += 5;
3952 }
3953 else if (STRNCMP(p, "dict", 4) == 0)
3954 {
3955 flags |= FC_DICT;
3956 p += 4;
3957 }
3958 else if (STRNCMP(p, "abort", 5) == 0)
3959 {
3960 flags |= FC_ABORT;
3961 p += 5;
3962 }
3963 else if (STRNCMP(p, "closure", 7) == 0)
3964 {
3965 flags |= FC_CLOSURE;
3966 p += 7;
3967 if (current_funccal == NULL)
3968 {
3969 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3970 name == NULL ? (char_u *)"" : name);
3971 goto erret;
3972 }
3973 }
3974 else
3975 break;
3976 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977
Bram Moolenaare38eab22019-12-05 21:50:01 +01003978 // When there is a line break use what follows for the function body.
3979 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980 if (*p == '\n')
3981 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003982 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003983 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3984 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003985 && !(VIM_ISWHITE(*whitep) && *p == '#'
3986 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003987 && !eap->skip
3988 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003989 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990
3991 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003992 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3993 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 */
3995 if (KeyTyped)
3996 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003997 // Check if the function already exists, don't let the user type the
3998 // whole function before telling him it doesn't work! For a script we
3999 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000 if (!eap->skip && !eap->forceit)
4001 {
4002 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004003 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004004 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005 emsg_funcname(e_funcexts, name);
4006 }
4007
4008 if (!eap->skip && did_emsg)
4009 goto erret;
4010
Bram Moolenaare38eab22019-12-05 21:50:01 +01004011 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 cmdline_row = msg_row;
4013 }
4014
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004015 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004016 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004017
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004018 // Do not define the function when getting the body fails and when
4019 // skipping.
4020 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4021 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022 goto erret;
4023
4024 /*
4025 * If there are no errors, add the function
4026 */
4027 if (fudi.fd_dict == NULL)
4028 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004029 hashtab_T *ht;
4030
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004031 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4033 {
4034 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4035 name);
4036 goto erret;
4037 }
4038
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004039 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004040 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004042 char_u *uname = untrans_function_name(name);
4043
4044 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4045 }
4046
4047 if (fp != NULL || import != NULL)
4048 {
4049 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004050
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004051 // Function can be replaced with "function!" and when sourcing the
4052 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004053 // A name that is used by an import can not be overruled.
4054 if (import != NULL
4055 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004056 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004057 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004059 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004060 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004061 else
4062 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 goto erret;
4064 }
4065 if (fp->uf_calls > 0)
4066 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004067 emsg_funcname(
4068 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 name);
4070 goto erret;
4071 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004072 if (fp->uf_refcount > 1)
4073 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004074 // This function is referenced somewhere, don't redefine it but
4075 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004076 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004077 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004078 fp = NULL;
4079 overwrite = TRUE;
4080 }
4081 else
4082 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004083 char_u *exp_name = fp->uf_name_exp;
4084
4085 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004086 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004087 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004088 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004089 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004090 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004091#ifdef FEAT_PROFILE
4092 fp->uf_profiling = FALSE;
4093 fp->uf_prof_initialized = FALSE;
4094#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004095 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004096 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 }
4098 }
4099 else
4100 {
4101 char numbuf[20];
4102
4103 fp = NULL;
4104 if (fudi.fd_newkey == NULL && !eap->forceit)
4105 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004106 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 goto erret;
4108 }
4109 if (fudi.fd_di == NULL)
4110 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004111 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004112 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113 goto erret;
4114 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004115 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004116 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 goto erret;
4118
Bram Moolenaare38eab22019-12-05 21:50:01 +01004119 // Give the function a sequential number. Can only be used with a
4120 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121 vim_free(name);
4122 sprintf(numbuf, "%d", ++func_nr);
4123 name = vim_strsave((char_u *)numbuf);
4124 if (name == NULL)
4125 goto erret;
4126 }
4127
4128 if (fp == NULL)
4129 {
4130 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4131 {
4132 int slen, plen;
4133 char_u *scriptname;
4134
Bram Moolenaare38eab22019-12-05 21:50:01 +01004135 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004137 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138 {
4139 scriptname = autoload_name(name);
4140 if (scriptname != NULL)
4141 {
4142 p = vim_strchr(scriptname, '/');
4143 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004144 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004146 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 j = OK;
4148 vim_free(scriptname);
4149 }
4150 }
4151 if (j == FAIL)
4152 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004153 linenr_T save_lnum = SOURCING_LNUM;
4154
4155 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004156 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004157 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 goto erret;
4159 }
4160 }
4161
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004162 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163 if (fp == NULL)
4164 goto erret;
4165
4166 if (fudi.fd_dict != NULL)
4167 {
4168 if (fudi.fd_di == NULL)
4169 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004170 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4172 if (fudi.fd_di == NULL)
4173 {
4174 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004175 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 goto erret;
4177 }
4178 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4179 {
4180 vim_free(fudi.fd_di);
4181 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004182 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183 goto erret;
4184 }
4185 }
4186 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004187 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188 clear_tv(&fudi.fd_di->di_tv);
4189 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004191
Bram Moolenaare38eab22019-12-05 21:50:01 +01004192 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 flags |= FC_DICT;
4194 }
4195
Bram Moolenaare38eab22019-12-05 21:50:01 +01004196 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004197 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004198 if (overwrite)
4199 {
4200 hi = hash_find(&func_hashtab, name);
4201 hi->hi_key = UF2HIKEY(fp);
4202 }
4203 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 {
4205 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004206 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004207 goto erret;
4208 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004209 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004210 }
4211 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004212 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004213 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004214 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004215
4216 if (eap->cmdidx == CMD_def)
4217 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004218 int lnum_save = SOURCING_LNUM;
4219 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004220
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004221 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004222
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004223 // error messages are for the first function line
4224 SOURCING_LNUM = sourcing_lnum_top;
4225
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004226 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004227 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004228 int count = cstack->cs_idx + 1;
4229 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004230
4231 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004232 // a block that is visible now but not when the function is called
4233 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004234 fp->uf_block_ids = ALLOC_MULT(int, count);
4235 if (fp->uf_block_ids != NULL)
4236 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004237 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004238 sizeof(int) * count);
4239 fp->uf_block_depth = count;
4240 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004241
4242 // Set flag in each block to indicate a function was defined. This
4243 // is used to keep the variable when leaving the block, see
4244 // hide_script_var().
4245 for (i = 0; i <= cstack->cs_idx; ++i)
4246 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004247 }
4248
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004249 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004250 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004251 SOURCING_LNUM = lnum_save;
4252 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004253 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004254 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004255
4256 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004257 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004258 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004259 SOURCING_LNUM = lnum_save;
4260 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004261 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004262 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004263 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004264 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004265 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004266
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004268 if ((flags & FC_CLOSURE) != 0)
4269 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004270 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004271 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004272 }
4273 else
4274 fp->uf_scoped = NULL;
4275
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004277 if (prof_def_func())
4278 func_do_profile(fp);
4279#endif
4280 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004281 if (sandbox)
4282 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004283 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004284 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285 fp->uf_flags = flags;
4286 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004287 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004288 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004289 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004290 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004291 if (is_export)
4292 {
4293 fp->uf_flags |= FC_EXPORT;
4294 // let ex_export() know the export worked.
4295 is_export = FALSE;
4296 }
4297
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004298 if (eap->cmdidx == CMD_def)
4299 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004300 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4301 // :func does not use Vim9 script syntax, even in a Vim9 script file
4302 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004303
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 goto ret_free;
4305
4306erret:
4307 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004308 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004309 if (fp != NULL)
4310 {
4311 ga_init(&fp->uf_args);
4312 ga_init(&fp->uf_def_args);
4313 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314errret_2:
4315 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004316 if (fp != NULL)
4317 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004319 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004320 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004322 if (name != name_arg)
4323 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004324 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004326
4327 return fp;
4328}
4329
4330/*
4331 * ":function"
4332 */
4333 void
4334ex_function(exarg_T *eap)
4335{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004336 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004337}
4338
4339/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004340 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004341 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004342 */
4343 void
4344ex_defcompile(exarg_T *eap UNUSED)
4345{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004346 long todo = (long)func_hashtab.ht_used;
4347 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004348 hashitem_T *hi;
4349 ufunc_T *ufunc;
4350
4351 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4352 {
4353 if (!HASHITEM_EMPTY(hi))
4354 {
4355 --todo;
4356 ufunc = HI2UF(hi);
4357 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004358 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4359 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004360 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004361 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004362
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004363 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004364 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004365 // a function has been added or removed, need to start over
4366 todo = (long)func_hashtab.ht_used;
4367 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004368 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004369 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004370 }
4371 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004372 }
4373 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374}
4375
4376/*
4377 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4378 * Return 2 if "p" starts with "s:".
4379 * Return 0 otherwise.
4380 */
4381 int
4382eval_fname_script(char_u *p)
4383{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004384 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4385 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4387 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4388 return 5;
4389 if (p[0] == 's' && p[1] == ':')
4390 return 2;
4391 return 0;
4392}
4393
4394 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004395translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396{
4397 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004398 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004399 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004400}
4401
4402/*
4403 * Return TRUE when "ufunc" has old-style "..." varargs
4404 * or named varargs "...name: type".
4405 */
4406 int
4407has_varargs(ufunc_T *ufunc)
4408{
4409 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410}
4411
4412/*
4413 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004414 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415 */
4416 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004417function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418{
4419 char_u *nm = name;
4420 char_u *p;
4421 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004422 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004423 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004425 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4426 if (no_deref)
4427 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004428 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 nm = skipwhite(nm);
4430
Bram Moolenaare38eab22019-12-05 21:50:01 +01004431 // Only accept "funcname", "funcname ", "funcname (..." and
4432 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004434 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004435 vim_free(p);
4436 return n;
4437}
4438
Bram Moolenaar113e1072019-01-20 15:30:40 +01004439#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 char_u *
4441get_expanded_name(char_u *name, int check)
4442{
4443 char_u *nm = name;
4444 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004445 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004447 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004448 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004450 if (p != NULL && *nm == NUL
4451 && (!check || translated_function_exists(p, is_global)))
4452 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453
4454 vim_free(p);
4455 return NULL;
4456}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004457#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459/*
4460 * Function given to ExpandGeneric() to obtain the list of user defined
4461 * function names.
4462 */
4463 char_u *
4464get_user_func_name(expand_T *xp, int idx)
4465{
4466 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004467 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 static hashitem_T *hi;
4469 ufunc_T *fp;
4470
4471 if (idx == 0)
4472 {
4473 done = 0;
4474 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004475 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004477 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 {
4479 if (done++ > 0)
4480 ++hi;
4481 while (HASHITEM_EMPTY(hi))
4482 ++hi;
4483 fp = HI2UF(hi);
4484
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004485 // don't show dead, dict and lambda functions
4486 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004487 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004488 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489
4490 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004491 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004492
4493 cat_func_name(IObuff, fp);
4494 if (xp->xp_context != EXPAND_USER_FUNC)
4495 {
4496 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004497 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004498 STRCAT(IObuff, ")");
4499 }
4500 return IObuff;
4501 }
4502 return NULL;
4503}
4504
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004505/*
4506 * ":delfunction {name}"
4507 */
4508 void
4509ex_delfunction(exarg_T *eap)
4510{
4511 ufunc_T *fp = NULL;
4512 char_u *p;
4513 char_u *name;
4514 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004515 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516
4517 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004518 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4519 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004520 vim_free(fudi.fd_newkey);
4521 if (name == NULL)
4522 {
4523 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004524 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 return;
4526 }
4527 if (!ends_excmd(*skipwhite(p)))
4528 {
4529 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004530 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004531 return;
4532 }
4533 eap->nextcmd = check_nextcmd(p);
4534 if (eap->nextcmd != NULL)
4535 *p = NUL;
4536
4537 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004538 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539 vim_free(name);
4540
4541 if (!eap->skip)
4542 {
4543 if (fp == NULL)
4544 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004545 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004546 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004547 return;
4548 }
4549 if (fp->uf_calls > 0)
4550 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004551 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 return;
4553 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004554 if (fp->uf_flags & FC_VIM9)
4555 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004556 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004557 return;
4558 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559
4560 if (fudi.fd_dict != NULL)
4561 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004562 // Delete the dict item that refers to the function, it will
4563 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004564 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4565 }
4566 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004567 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004568 // A normal function (not a numbered function or lambda) has a
4569 // refcount of 1 for the entry in the hashtable. When deleting
4570 // it and the refcount is more than one, it should be kept.
4571 // A numbered function and lambda should be kept if the refcount is
4572 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004573 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004574 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004575 // Function is still referenced somewhere. Don't free it but
4576 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004577 if (func_remove(fp))
4578 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004579 }
4580 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004581 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004582 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 }
4584}
4585
4586/*
4587 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004588 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004589 */
4590 void
4591func_unref(char_u *name)
4592{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004593 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004595 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004597 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004598 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004601 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004602#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004603 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004605 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004606}
4607
4608/*
4609 * Unreference a Function: decrement the reference count and free it when it
4610 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004611 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004612 */
4613 void
4614func_ptr_unref(ufunc_T *fp)
4615{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004616 if (fp != NULL && (--fp->uf_refcount <= 0
4617 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4618 && fp->uf_partial->pt_refcount <= 1
4619 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004620 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004621 // Only delete it when it's not being used. Otherwise it's done
4622 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004623 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004624 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625 }
4626}
4627
4628/*
4629 * Count a reference to a Function.
4630 */
4631 void
4632func_ref(char_u *name)
4633{
4634 ufunc_T *fp;
4635
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004636 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004638 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004639 if (fp != NULL)
4640 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004641 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004642 // Only give an error for a numbered function.
4643 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004644 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004645}
4646
4647/*
4648 * Count a reference to a Function.
4649 */
4650 void
4651func_ptr_ref(ufunc_T *fp)
4652{
4653 if (fp != NULL)
4654 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655}
4656
4657/*
4658 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4659 * referenced from anywhere that is in use.
4660 */
4661 static int
4662can_free_funccal(funccall_T *fc, int copyID)
4663{
4664 return (fc->l_varlist.lv_copyID != copyID
4665 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004666 && fc->l_avars.dv_copyID != copyID
4667 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668}
4669
4670/*
4671 * ":return [expr]"
4672 */
4673 void
4674ex_return(exarg_T *eap)
4675{
4676 char_u *arg = eap->arg;
4677 typval_T rettv;
4678 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004679 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680
4681 if (current_funccal == NULL)
4682 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004683 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 return;
4685 }
4686
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004687 CLEAR_FIELD(evalarg);
4688 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4689
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 if (eap->skip)
4691 ++emsg_skip;
4692
4693 eap->nextcmd = NULL;
4694 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004695 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696 {
4697 if (!eap->skip)
4698 returning = do_return(eap, FALSE, TRUE, &rettv);
4699 else
4700 clear_tv(&rettv);
4701 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004702 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004703 else if (!eap->skip)
4704 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004705 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004706 update_force_abort();
4707
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 /*
4709 * Return unless the expression evaluation has been cancelled due to an
4710 * aborting error, an interrupt, or an exception.
4711 */
4712 if (!aborting())
4713 returning = do_return(eap, FALSE, TRUE, NULL);
4714 }
4715
Bram Moolenaare38eab22019-12-05 21:50:01 +01004716 // When skipping or the return gets pending, advance to the next command
4717 // in this line (!returning). Otherwise, ignore the rest of the line.
4718 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719 if (returning)
4720 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004721 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004722 eap->nextcmd = check_nextcmd(arg);
4723
4724 if (eap->skip)
4725 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004726 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727}
4728
4729/*
4730 * ":1,25call func(arg1, arg2)" function call.
4731 */
4732 void
4733ex_call(exarg_T *eap)
4734{
4735 char_u *arg = eap->arg;
4736 char_u *startarg;
4737 char_u *name;
4738 char_u *tofree;
4739 int len;
4740 typval_T rettv;
4741 linenr_T lnum;
4742 int doesrange;
4743 int failed = FALSE;
4744 funcdict_T fudi;
4745 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004746 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004747 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748
Bram Moolenaare6b53242020-07-01 17:28:33 +02004749 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750 if (eap->skip)
4751 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004752 // trans_function_name() doesn't work well when skipping, use eval0()
4753 // instead to skip to any following command, e.g. for:
4754 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004755 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004756 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 clear_tv(&rettv);
4758 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004759 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004760 return;
4761 }
4762
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004763 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4764 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004765 if (fudi.fd_newkey != NULL)
4766 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004767 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004768 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 vim_free(fudi.fd_newkey);
4770 }
4771 if (tofree == NULL)
4772 return;
4773
Bram Moolenaare38eab22019-12-05 21:50:01 +01004774 // Increase refcount on dictionary, it could get deleted when evaluating
4775 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004776 if (fudi.fd_dict != NULL)
4777 ++fudi.fd_dict->dv_refcount;
4778
Bram Moolenaare38eab22019-12-05 21:50:01 +01004779 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4780 // contents. For VAR_PARTIAL get its partial, unless we already have one
4781 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004783 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4784 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785
Bram Moolenaare38eab22019-12-05 21:50:01 +01004786 // Skip white space to allow ":call func ()". Not good, but required for
4787 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004789 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004790
4791 if (*startarg != '(')
4792 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004793 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004794 goto end;
4795 }
4796
4797 /*
4798 * When skipping, evaluate the function once, to find the end of the
4799 * arguments.
4800 * When the function takes a range, this is discovered after the first
4801 * call, and the loop is broken.
4802 */
4803 if (eap->skip)
4804 {
4805 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004806 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 }
4808 else
4809 lnum = eap->line1;
4810 for ( ; lnum <= eap->line2; ++lnum)
4811 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004812 funcexe_T funcexe;
4813
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004814 if (!eap->skip && eap->addr_count > 0)
4815 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004816 if (lnum > curbuf->b_ml.ml_line_count)
4817 {
4818 // If the function deleted lines or switched to another buffer
4819 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004820 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004821 break;
4822 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823 curwin->w_cursor.lnum = lnum;
4824 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826 }
4827 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004828
Bram Moolenaara80faa82020-04-12 19:37:17 +02004829 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004830 funcexe.firstline = eap->line1;
4831 funcexe.lastline = eap->line2;
4832 funcexe.doesrange = &doesrange;
4833 funcexe.evaluate = !eap->skip;
4834 funcexe.partial = partial;
4835 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004836 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004837 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 {
4839 failed = TRUE;
4840 break;
4841 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004842 if (has_watchexpr())
4843 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004845 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004846 if (handle_subscript(&arg, &rettv,
4847 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848 {
4849 failed = TRUE;
4850 break;
4851 }
4852
4853 clear_tv(&rettv);
4854 if (doesrange || eap->skip)
4855 break;
4856
Bram Moolenaare38eab22019-12-05 21:50:01 +01004857 // Stop when immediately aborting on error, or when an interrupt
4858 // occurred or an exception was thrown but not caught.
4859 // get_func_tv() returned OK, so that the check for trailing
4860 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004861 if (aborting())
4862 break;
4863 }
4864 if (eap->skip)
4865 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004866 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004867
Bram Moolenaare51bb172020-02-16 19:42:23 +01004868 // When inside :try we need to check for following "| catch".
4869 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004871 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004872 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004873 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004875 if (!failed)
4876 {
4877 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004878 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004879 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880 }
4881 else
4882 eap->nextcmd = check_nextcmd(arg);
4883 }
4884
4885end:
4886 dict_unref(fudi.fd_dict);
4887 vim_free(tofree);
4888}
4889
4890/*
4891 * Return from a function. Possibly makes the return pending. Also called
4892 * for a pending return at the ":endtry" or after returning from an extra
4893 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4894 * when called due to a ":return" command. "rettv" may point to a typval_T
4895 * with the return rettv. Returns TRUE when the return can be carried out,
4896 * FALSE when the return gets pending.
4897 */
4898 int
4899do_return(
4900 exarg_T *eap,
4901 int reanimate,
4902 int is_cmd,
4903 void *rettv)
4904{
4905 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004906 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907
4908 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004909 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910 current_funccal->returned = FALSE;
4911
4912 /*
4913 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4914 * not in its finally clause (which then is to be executed next) is found.
4915 * In this case, make the ":return" pending for execution at the ":endtry".
4916 * Otherwise, return normally.
4917 */
4918 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4919 if (idx >= 0)
4920 {
4921 cstack->cs_pending[idx] = CSTP_RETURN;
4922
4923 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004924 // A pending return again gets pending. "rettv" points to an
4925 // allocated variable with the rettv of the original ":return"'s
4926 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927 cstack->cs_rettv[idx] = rettv;
4928 else
4929 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004930 // When undoing a return in order to make it pending, get the stored
4931 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004932 if (reanimate)
4933 rettv = current_funccal->rettv;
4934
4935 if (rettv != NULL)
4936 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004937 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4939 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4940 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004941 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942 }
4943 else
4944 cstack->cs_rettv[idx] = NULL;
4945
4946 if (reanimate)
4947 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004948 // The pending return value could be overwritten by a ":return"
4949 // without argument in a finally clause; reset the default
4950 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004951 current_funccal->rettv->v_type = VAR_NUMBER;
4952 current_funccal->rettv->vval.v_number = 0;
4953 }
4954 }
4955 report_make_pending(CSTP_RETURN, rettv);
4956 }
4957 else
4958 {
4959 current_funccal->returned = TRUE;
4960
Bram Moolenaare38eab22019-12-05 21:50:01 +01004961 // If the return is carried out now, store the return value. For
4962 // a return immediately after reanimation, the value is already
4963 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004964 if (!reanimate && rettv != NULL)
4965 {
4966 clear_tv(current_funccal->rettv);
4967 *current_funccal->rettv = *(typval_T *)rettv;
4968 if (!is_cmd)
4969 vim_free(rettv);
4970 }
4971 }
4972
4973 return idx < 0;
4974}
4975
4976/*
4977 * Free the variable with a pending return value.
4978 */
4979 void
4980discard_pending_return(void *rettv)
4981{
4982 free_tv((typval_T *)rettv);
4983}
4984
4985/*
4986 * Generate a return command for producing the value of "rettv". The result
4987 * is an allocated string. Used by report_pending() for verbose messages.
4988 */
4989 char_u *
4990get_return_cmd(void *rettv)
4991{
4992 char_u *s = NULL;
4993 char_u *tofree = NULL;
4994 char_u numbuf[NUMBUFLEN];
4995
4996 if (rettv != NULL)
4997 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4998 if (s == NULL)
4999 s = (char_u *)"";
5000
5001 STRCPY(IObuff, ":return ");
5002 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5003 if (STRLEN(s) + 8 >= IOSIZE)
5004 STRCPY(IObuff + IOSIZE - 4, "...");
5005 vim_free(tofree);
5006 return vim_strsave(IObuff);
5007}
5008
5009/*
5010 * Get next function line.
5011 * Called by do_cmdline() to get the next line.
5012 * Returns allocated string, or NULL for end of function.
5013 */
5014 char_u *
5015get_func_line(
5016 int c UNUSED,
5017 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005018 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005019 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005020{
5021 funccall_T *fcp = (funccall_T *)cookie;
5022 ufunc_T *fp = fcp->func;
5023 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005024 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005025
Bram Moolenaare38eab22019-12-05 21:50:01 +01005026 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005027 if (fcp->dbg_tick != debug_tick)
5028 {
5029 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005030 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005031 fcp->dbg_tick = debug_tick;
5032 }
5033#ifdef FEAT_PROFILE
5034 if (do_profiling == PROF_YES)
5035 func_line_end(cookie);
5036#endif
5037
5038 gap = &fp->uf_lines;
5039 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5040 || fcp->returned)
5041 retval = NULL;
5042 else
5043 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005044 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005045 while (fcp->linenr < gap->ga_len
5046 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5047 ++fcp->linenr;
5048 if (fcp->linenr >= gap->ga_len)
5049 retval = NULL;
5050 else
5051 {
5052 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005053 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005054#ifdef FEAT_PROFILE
5055 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005056 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005057#endif
5058 }
5059 }
5060
Bram Moolenaare38eab22019-12-05 21:50:01 +01005061 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005062 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005064 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005065 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005066 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005067 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068 fcp->dbg_tick = debug_tick;
5069 }
5070
5071 return retval;
5072}
5073
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074/*
5075 * Return TRUE if the currently active function should be ended, because a
5076 * return was encountered or an error occurred. Used inside a ":while".
5077 */
5078 int
5079func_has_ended(void *cookie)
5080{
5081 funccall_T *fcp = (funccall_T *)cookie;
5082
Bram Moolenaare38eab22019-12-05 21:50:01 +01005083 // Ignore the "abort" flag if the abortion behavior has been changed due to
5084 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5086 || fcp->returned);
5087}
5088
5089/*
5090 * return TRUE if cookie indicates a function which "abort"s on errors.
5091 */
5092 int
5093func_has_abort(
5094 void *cookie)
5095{
5096 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5097}
5098
5099
5100/*
5101 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5102 * Don't do this when "Func" is already a partial that was bound
5103 * explicitly (pt_auto is FALSE).
5104 * Changes "rettv" in-place.
5105 * Returns the updated "selfdict_in".
5106 */
5107 dict_T *
5108make_partial(dict_T *selfdict_in, typval_T *rettv)
5109{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005110 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005111 char_u *tofree = NULL;
5112 ufunc_T *fp;
5113 char_u fname_buf[FLEN_FIXED + 1];
5114 int error;
5115 dict_T *selfdict = selfdict_in;
5116
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005117 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5118 fp = rettv->vval.v_partial->pt_func;
5119 else
5120 {
5121 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5122 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005123 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005124 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005125 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005126 vim_free(tofree);
5127 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128
5129 if (fp != NULL && (fp->uf_flags & FC_DICT))
5130 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005131 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005132
5133 if (pt != NULL)
5134 {
5135 pt->pt_refcount = 1;
5136 pt->pt_dict = selfdict;
5137 pt->pt_auto = TRUE;
5138 selfdict = NULL;
5139 if (rettv->v_type == VAR_FUNC)
5140 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005141 // Just a function: Take over the function name and use
5142 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005143 pt->pt_name = rettv->vval.v_string;
5144 }
5145 else
5146 {
5147 partial_T *ret_pt = rettv->vval.v_partial;
5148 int i;
5149
Bram Moolenaare38eab22019-12-05 21:50:01 +01005150 // Partial: copy the function name, use selfdict and copy
5151 // args. Can't take over name or args, the partial might
5152 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005153 if (ret_pt->pt_name != NULL)
5154 {
5155 pt->pt_name = vim_strsave(ret_pt->pt_name);
5156 func_ref(pt->pt_name);
5157 }
5158 else
5159 {
5160 pt->pt_func = ret_pt->pt_func;
5161 func_ptr_ref(pt->pt_func);
5162 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005163 if (ret_pt->pt_argc > 0)
5164 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005165 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005166 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005167 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005168 pt->pt_argc = 0;
5169 else
5170 {
5171 pt->pt_argc = ret_pt->pt_argc;
5172 for (i = 0; i < pt->pt_argc; i++)
5173 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5174 }
5175 }
5176 partial_unref(ret_pt);
5177 }
5178 rettv->v_type = VAR_PARTIAL;
5179 rettv->vval.v_partial = pt;
5180 }
5181 }
5182 return selfdict;
5183}
5184
5185/*
5186 * Return the name of the executed function.
5187 */
5188 char_u *
5189func_name(void *cookie)
5190{
5191 return ((funccall_T *)cookie)->func->uf_name;
5192}
5193
5194/*
5195 * Return the address holding the next breakpoint line for a funccall cookie.
5196 */
5197 linenr_T *
5198func_breakpoint(void *cookie)
5199{
5200 return &((funccall_T *)cookie)->breakpoint;
5201}
5202
5203/*
5204 * Return the address holding the debug tick for a funccall cookie.
5205 */
5206 int *
5207func_dbg_tick(void *cookie)
5208{
5209 return &((funccall_T *)cookie)->dbg_tick;
5210}
5211
5212/*
5213 * Return the nesting level for a funccall cookie.
5214 */
5215 int
5216func_level(void *cookie)
5217{
5218 return ((funccall_T *)cookie)->level;
5219}
5220
5221/*
5222 * Return TRUE when a function was ended by a ":return" command.
5223 */
5224 int
5225current_func_returned(void)
5226{
5227 return current_funccal->returned;
5228}
5229
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005230 int
5231free_unref_funccal(int copyID, int testing)
5232{
5233 int did_free = FALSE;
5234 int did_free_funccal = FALSE;
5235 funccall_T *fc, **pfc;
5236
5237 for (pfc = &previous_funccal; *pfc != NULL; )
5238 {
5239 if (can_free_funccal(*pfc, copyID))
5240 {
5241 fc = *pfc;
5242 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005243 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005244 did_free = TRUE;
5245 did_free_funccal = TRUE;
5246 }
5247 else
5248 pfc = &(*pfc)->caller;
5249 }
5250 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005251 // When a funccal was freed some more items might be garbage
5252 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005253 (void)garbage_collect(testing);
5254
5255 return did_free;
5256}
5257
5258/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005259 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005260 */
5261 static funccall_T *
5262get_funccal(void)
5263{
5264 int i;
5265 funccall_T *funccal;
5266 funccall_T *temp_funccal;
5267
5268 funccal = current_funccal;
5269 if (debug_backtrace_level > 0)
5270 {
5271 for (i = 0; i < debug_backtrace_level; i++)
5272 {
5273 temp_funccal = funccal->caller;
5274 if (temp_funccal)
5275 funccal = temp_funccal;
5276 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005277 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005278 debug_backtrace_level = i;
5279 }
5280 }
5281 return funccal;
5282}
5283
5284/*
5285 * Return the hashtable used for local variables in the current funccal.
5286 * Return NULL if there is no current funccal.
5287 */
5288 hashtab_T *
5289get_funccal_local_ht()
5290{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005291 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005292 return NULL;
5293 return &get_funccal()->l_vars.dv_hashtab;
5294}
5295
5296/*
5297 * Return the l: scope variable.
5298 * Return NULL if there is no current funccal.
5299 */
5300 dictitem_T *
5301get_funccal_local_var()
5302{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005303 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005304 return NULL;
5305 return &get_funccal()->l_vars_var;
5306}
5307
5308/*
5309 * Return the hashtable used for argument in the current funccal.
5310 * Return NULL if there is no current funccal.
5311 */
5312 hashtab_T *
5313get_funccal_args_ht()
5314{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005315 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005316 return NULL;
5317 return &get_funccal()->l_avars.dv_hashtab;
5318}
5319
5320/*
5321 * Return the a: scope variable.
5322 * Return NULL if there is no current funccal.
5323 */
5324 dictitem_T *
5325get_funccal_args_var()
5326{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005327 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005328 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005329 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005330}
5331
5332/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005333 * List function variables, if there is a function.
5334 */
5335 void
5336list_func_vars(int *first)
5337{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005338 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005340 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005341}
5342
5343/*
5344 * If "ht" is the hashtable for local variables in the current funccal, return
5345 * the dict that contains it.
5346 * Otherwise return NULL.
5347 */
5348 dict_T *
5349get_current_funccal_dict(hashtab_T *ht)
5350{
5351 if (current_funccal != NULL
5352 && ht == &current_funccal->l_vars.dv_hashtab)
5353 return &current_funccal->l_vars;
5354 return NULL;
5355}
5356
5357/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005358 * Search hashitem in parent scope.
5359 */
5360 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005361find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005362{
5363 funccall_T *old_current_funccal = current_funccal;
5364 hashtab_T *ht;
5365 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005366 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005367
5368 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5369 return NULL;
5370
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005371 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005372 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005373 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005374 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005375 ht = find_var_ht(name, &varname);
5376 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005377 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005378 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005379 if (!HASHITEM_EMPTY(hi))
5380 {
5381 *pht = ht;
5382 break;
5383 }
5384 }
5385 if (current_funccal == current_funccal->func->uf_scoped)
5386 break;
5387 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005388 }
5389 current_funccal = old_current_funccal;
5390
5391 return hi;
5392}
5393
5394/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005395 * Search variable in parent scope.
5396 */
5397 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005398find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005399{
5400 dictitem_T *v = NULL;
5401 funccall_T *old_current_funccal = current_funccal;
5402 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005403 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005404
5405 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5406 return NULL;
5407
Bram Moolenaare38eab22019-12-05 21:50:01 +01005408 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005409 current_funccal = current_funccal->func->uf_scoped;
5410 while (current_funccal)
5411 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005412 ht = find_var_ht(name, &varname);
5413 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005414 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005415 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005416 if (v != NULL)
5417 break;
5418 }
5419 if (current_funccal == current_funccal->func->uf_scoped)
5420 break;
5421 current_funccal = current_funccal->func->uf_scoped;
5422 }
5423 current_funccal = old_current_funccal;
5424
5425 return v;
5426}
5427
5428/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005429 * Set "copyID + 1" in previous_funccal and callers.
5430 */
5431 int
5432set_ref_in_previous_funccal(int copyID)
5433{
5434 int abort = FALSE;
5435 funccall_T *fc;
5436
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005437 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005438 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005439 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005440 abort = abort
5441 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5442 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005443 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005444 }
5445 return abort;
5446}
5447
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005448 static int
5449set_ref_in_funccal(funccall_T *fc, int copyID)
5450{
5451 int abort = FALSE;
5452
5453 if (fc->fc_copyID != copyID)
5454 {
5455 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005456 abort = abort
5457 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5458 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005459 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005460 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005461 }
5462 return abort;
5463}
5464
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005465/*
5466 * Set "copyID" in all local vars and arguments in the call stack.
5467 */
5468 int
5469set_ref_in_call_stack(int copyID)
5470{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005471 int abort = FALSE;
5472 funccall_T *fc;
5473 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005474
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005475 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005476 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005477
5478 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005479 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5480 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005481 abort = abort || set_ref_in_funccal(fc, copyID);
5482
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005483 return abort;
5484}
5485
5486/*
5487 * Set "copyID" in all functions available by name.
5488 */
5489 int
5490set_ref_in_functions(int copyID)
5491{
5492 int todo;
5493 hashitem_T *hi = NULL;
5494 int abort = FALSE;
5495 ufunc_T *fp;
5496
5497 todo = (int)func_hashtab.ht_used;
5498 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005499 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005500 if (!HASHITEM_EMPTY(hi))
5501 {
5502 --todo;
5503 fp = HI2UF(hi);
5504 if (!func_name_refcount(fp->uf_name))
5505 abort = abort || set_ref_in_func(NULL, fp, copyID);
5506 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005507 }
5508 return abort;
5509}
5510
5511/*
5512 * Set "copyID" in all function arguments.
5513 */
5514 int
5515set_ref_in_func_args(int copyID)
5516{
5517 int i;
5518 int abort = FALSE;
5519
5520 for (i = 0; i < funcargs.ga_len; ++i)
5521 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5522 copyID, NULL, NULL);
5523 return abort;
5524}
5525
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005526/*
5527 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005528 * Returns TRUE if setting references failed somehow.
5529 */
5530 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005531set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005532{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005533 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005534 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005535 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005536 char_u fname_buf[FLEN_FIXED + 1];
5537 char_u *tofree = NULL;
5538 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005539 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005540
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005541 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005542 return FALSE;
5543
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005544 if (fp_in == NULL)
5545 {
5546 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005547 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005548 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005549 if (fp != NULL)
5550 {
5551 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005552 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005553 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005554
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005555 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005556 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005557}
5558
Bram Moolenaare38eab22019-12-05 21:50:01 +01005559#endif // FEAT_EVAL