blob: b88b512c5471ea2a7dc4724516586df3b2cee6cf [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 Moolenaar79efa2e2021-03-27 15:40:11 +0100979 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100980 exarg_T eap;
981 garray_T newlines;
982 char_u *cmdline = NULL;
983 int ret = FAIL;
984 char_u *line_to_free = NULL;
985 partial_T *pt;
986 char_u *name;
987 int lnum_save = -1;
988 linenr_T sourcing_lnum_top = SOURCING_LNUM;
989
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100990 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
991 {
992 semsg(_(e_trailing_arg), *arg + 1);
993 return FAIL;
994 }
995
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100996 CLEAR_FIELD(eap);
997 eap.cmdidx = CMD_block;
998 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100999 eap.cmdlinep = &cmdline;
1000 eap.skip = !evaluate;
1001 if (evalarg->eval_cctx != NULL)
1002 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1003 else
1004 {
1005 eap.getline = evalarg->eval_getline;
1006 eap.cookie = evalarg->eval_cookie;
1007 }
1008
1009 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1010 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001011 {
1012 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001013 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001014 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001015
1016 // When inside a lambda must add the function lines to evalarg.eval_ga.
1017 evalarg->eval_break_count += newlines.ga_len;
1018 if (gap->ga_itemsize > 0)
1019 {
1020 int idx;
1021 char_u *last;
1022 size_t plen;
1023 char_u *pnl;
1024
1025 for (idx = 0; idx < newlines.ga_len; ++idx)
1026 {
1027 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1028
1029 if (ga_grow(gap, 1) == FAIL)
1030 goto erret;
1031
1032 // Going to concatenate the lines after parsing. For an empty or
1033 // comment line use an empty string.
1034 // Insert NL characters at the start of each line, the string will
1035 // be split again later in .get_lambda_tv().
1036 if (*p == NUL || vim9_comment_start(p))
1037 p = (char_u *)"";
1038 plen = STRLEN(p);
1039 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1040 if (pnl != NULL)
1041 mch_memmove(pnl + 1, p, plen + 1);
1042 ((char_u **)gap->ga_data)[gap->ga_len] = pnl;
1043 ++gap->ga_len;
1044 }
1045 if (ga_grow(gap, 1) == FAIL)
1046 goto erret;
1047 if (cmdline != NULL)
1048 // more is following after the "}", which was skipped
1049 last = cmdline;
1050 else
1051 // nothing is following the "}"
1052 last = (char_u *)"}";
1053 plen = STRLEN(last);
1054 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1055 if (pnl != NULL)
1056 mch_memmove(pnl + 1, last, plen + 1);
1057 ((char_u **)gap->ga_data)[gap->ga_len] = pnl;
1058 ++gap->ga_len;
1059 }
1060
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001061 if (cmdline != NULL)
1062 {
1063 // Something comes after the "}".
1064 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001065
1066 // "arg" points into cmdline, need to keep the line and free it later.
1067 vim_free(evalarg->eval_tofree_cmdline);
1068 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001069 }
1070 else
1071 *arg = (char_u *)"";
1072
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001073 if (!evaluate)
1074 {
1075 ret = OK;
1076 goto erret;
1077 }
1078
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001079 name = get_lambda_name();
1080 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1081 if (ufunc == NULL)
1082 goto erret;
1083 set_ufunc_name(ufunc, name);
1084 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001085 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001086 ufunc->uf_refcount = 1;
1087 ufunc->uf_args = *newargs;
1088 newargs->ga_data = NULL;
1089 ufunc->uf_def_args = *default_args;
1090 default_args->ga_data = NULL;
1091 ufunc->uf_func_type = &t_func_any;
1092
1093 // error messages are for the first function line
1094 lnum_save = SOURCING_LNUM;
1095 SOURCING_LNUM = sourcing_lnum_top;
1096
1097 // parse argument types
1098 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1099 {
1100 SOURCING_LNUM = lnum_save;
1101 goto erret;
1102 }
1103
1104 // parse the return type, if any
1105 if (parse_return_type(ufunc, ret_type) == FAIL)
1106 goto erret;
1107
1108 pt = ALLOC_CLEAR_ONE(partial_T);
1109 if (pt == NULL)
1110 goto erret;
1111 pt->pt_func = ufunc;
1112 pt->pt_refcount = 1;
1113
1114 ufunc->uf_lines = newlines;
1115 newlines.ga_data = NULL;
1116 if (sandbox)
1117 ufunc->uf_flags |= FC_SANDBOX;
1118 if (!ASCII_ISUPPER(*ufunc->uf_name))
1119 ufunc->uf_flags |= FC_VIM9;
1120 ufunc->uf_script_ctx = current_sctx;
1121 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1122 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1123 set_function_type(ufunc);
1124
1125 rettv->vval.v_partial = pt;
1126 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001127 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001128 ret = OK;
1129
1130erret:
1131 if (lnum_save >= 0)
1132 SOURCING_LNUM = lnum_save;
1133 vim_free(line_to_free);
1134 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001135 if (newargs != NULL)
1136 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001137 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001138 if (ufunc != NULL)
1139 {
1140 func_clear(ufunc, TRUE);
1141 func_free(ufunc, TRUE);
1142 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001143 return ret;
1144}
1145
1146/*
1147 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001148 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001149 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001150 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1151 */
1152 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001153get_lambda_tv(
1154 char_u **arg,
1155 typval_T *rettv,
1156 int types_optional,
1157 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001158{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001159 int evaluate = evalarg != NULL
1160 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001161 garray_T newargs;
1162 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001163 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001164 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001165 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001166 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001167 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001168 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001169 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001170 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001171 char_u *s;
1172 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001173 int *old_eval_lavars = eval_lavars_used;
1174 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001175 char_u *tofree1 = NULL;
1176 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001177 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001178 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001179 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001180
1181 if (equal_arrow && !in_vim9script())
1182 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001183
1184 ga_init(&newargs);
1185 ga_init(&newlines);
1186
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001187 // First, check if this is really a lambda expression. "->" or "=>" must
1188 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001189 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001190 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001191 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001192 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001193 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001194 {
1195 if (types_optional)
1196 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001197 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001199
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001200 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001201 if (evaluate)
1202 pnewargs = &newargs;
1203 else
1204 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001205 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001206 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001207 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001208 &varargs, &default_args,
1209 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001210 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001211 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001212 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001213 {
1214 if (types_optional)
1215 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001216 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001217 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001218 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001219 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001220
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001221 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1222 if (ret_type != NULL)
1223 {
1224 ret_type = vim_strsave(ret_type);
1225 tofree2 = ret_type;
1226 }
1227
Bram Moolenaare38eab22019-12-05 21:50:01 +01001228 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001229 if (evaluate)
1230 eval_lavars_used = &eval_lavars;
1231
Bram Moolenaar65c44152020-12-24 15:14:01 +01001232 *arg = skipwhite_and_linebreak(*arg, evalarg);
1233
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001234 // Recognize "{" as the start of a function body.
1235 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001236 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001237 if (evalarg == NULL)
1238 // cannot happen?
1239 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001240 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1241 types_optional ? &argtypes : NULL, varargs,
1242 &default_args, ret_type) == FAIL)
1243 goto errret;
1244 goto theend;
1245 }
1246 if (default_args.ga_len > 0)
1247 {
1248 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001249 goto errret;
1250 }
1251
Bram Moolenaare38eab22019-12-05 21:50:01 +01001252 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001253 start = *arg;
1254 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001255 if (ret == FAIL)
1256 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001257 if (evalarg != NULL)
1258 {
1259 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001260 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001261 evalarg->eval_tofree = NULL;
1262 }
1263
Bram Moolenaar65c44152020-12-24 15:14:01 +01001264 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001265 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001266 *arg = skipwhite_and_linebreak(*arg, evalarg);
1267 if (**arg != '}')
1268 {
1269 semsg(_("E451: Expected }: %s"), *arg);
1270 goto errret;
1271 }
1272 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001273 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274
1275 if (evaluate)
1276 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001277 int len;
1278 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001279 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001280 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001281 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001282
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001283 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001284 if (fp == NULL)
1285 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001286 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001287 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001288 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001289 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001290
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1292 if (ga_grow(&newlines, 1) == FAIL)
1293 goto errret;
1294
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001295 // If there are line breaks, we need to split up the string.
1296 line_end = vim_strchr(start, '\n');
1297 if (line_end == NULL)
1298 line_end = end;
1299
1300 // Add "return " before the expression (or the first line).
1301 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001302 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001303 if (p == NULL)
1304 goto errret;
1305 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1306 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001307 vim_strncpy(p + 7, start, line_end - start);
1308
1309 if (line_end != end)
1310 {
1311 // Add more lines, split by line breaks. Thus is used when a
1312 // lambda with { cmds } is encountered.
1313 while (*line_end == '\n')
1314 {
1315 if (ga_grow(&newlines, 1) == FAIL)
1316 goto errret;
1317 start = line_end + 1;
1318 line_end = vim_strchr(start, '\n');
1319 if (line_end == NULL)
1320 line_end = end;
1321 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1322 vim_strnsave(start, line_end - start);
1323 }
1324 }
1325
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001326 if (strstr((char *)p + 7, "a:") == NULL)
1327 // No a: variables are used for sure.
1328 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001329
1330 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001331 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001333 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001334 if (types_optional)
1335 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001336 if (parse_argument_types(fp, &argtypes,
1337 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001338 goto errret;
1339 if (ret_type != NULL)
1340 {
1341 fp->uf_ret_type = parse_type(&ret_type,
1342 &fp->uf_type_list, TRUE);
1343 if (fp->uf_ret_type == NULL)
1344 goto errret;
1345 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001346 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001347 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001348 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001349
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001350 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001351 if (current_funccal != NULL && eval_lavars)
1352 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001353 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001354 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001355 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001356 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001357
1358#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001359 if (prof_def_func())
1360 func_do_profile(fp);
1361#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001362 if (sandbox)
1363 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001364 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001365 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1366 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001367 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001368 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001369 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001370 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001371
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001372 pt->pt_func = fp;
1373 pt->pt_refcount = 1;
1374 rettv->vval.v_partial = pt;
1375 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001376
1377 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001378 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001380theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001381 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001382 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001383 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001384 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001385 vim_free(tofree1);
1386 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001387 if (types_optional)
1388 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001389 return OK;
1390
1391errret:
1392 ga_clear_strings(&newargs);
1393 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001394 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001395 if (types_optional)
1396 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001397 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001398 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001399 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001400 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001401 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001402 vim_free(tofree1);
1403 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001404 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001405 return FAIL;
1406}
1407
1408/*
1409 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1410 * name it contains, otherwise return "name".
1411 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1412 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001413 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1414 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001415 */
1416 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001417deref_func_name(
1418 char_u *name,
1419 int *lenp,
1420 partial_T **partialp,
1421 type_T **type,
1422 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001423{
1424 dictitem_T *v;
1425 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001426 char_u *s = NULL;
1427 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001428
1429 if (partialp != NULL)
1430 *partialp = NULL;
1431
1432 cc = name[*lenp];
1433 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001434 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001436 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001437 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001438 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001439 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001440 if (v->di_tv.vval.v_string == NULL)
1441 {
1442 *lenp = 0;
1443 return (char_u *)""; // just in case
1444 }
1445 s = v->di_tv.vval.v_string;
1446 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001449 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001450 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001451 partial_T *pt = v->di_tv.vval.v_partial;
1452
1453 if (pt == NULL)
1454 {
1455 *lenp = 0;
1456 return (char_u *)""; // just in case
1457 }
1458 if (partialp != NULL)
1459 *partialp = pt;
1460 s = partial_name(pt);
1461 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001463
1464 if (s != NULL)
1465 {
1466 if (type != NULL && ht == get_script_local_ht())
1467 {
1468 svar_T *sv = find_typval_in_script(&v->di_tv);
1469
1470 if (sv != NULL)
1471 *type = sv->sv_type;
1472 }
1473 return s;
1474 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475 }
1476
1477 return name;
1478}
1479
1480/*
1481 * Give an error message with a function name. Handle <SNR> things.
1482 * "ermsg" is to be passed without translation, use N_() instead of _().
1483 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001484 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485emsg_funcname(char *ermsg, char_u *name)
1486{
1487 char_u *p;
1488
1489 if (*name == K_SPECIAL)
1490 p = concat_str((char_u *)"<SNR>", name + 3);
1491 else
1492 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001493 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001494 if (p != name)
1495 vim_free(p);
1496}
1497
1498/*
1499 * Allocate a variable for the result of a function.
1500 * Return OK or FAIL.
1501 */
1502 int
1503get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001504 char_u *name, // name of the function
1505 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001507 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001508 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001509 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001510{
1511 char_u *argp;
1512 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001513 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1514 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001515 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516
1517 /*
1518 * Get the arguments.
1519 */
1520 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001521 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1522 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001524 // skip the '(' or ',' and possibly line breaks
1525 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1526
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001527 if (*argp == ')' || *argp == ',' || *argp == NUL)
1528 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001529 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001530 {
1531 ret = FAIL;
1532 break;
1533 }
1534 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001535 // The comma should come right after the argument, but this wasn't
1536 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001537 if (vim9script)
1538 {
1539 if (*argp != ',' && *skipwhite(argp) == ',')
1540 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001541 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001542 ret = FAIL;
1543 break;
1544 }
1545 }
1546 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001547 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548 if (*argp != ',')
1549 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001550 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1551 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001552 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001553 ret = FAIL;
1554 break;
1555 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001557 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001558 if (*argp == ')')
1559 ++argp;
1560 else
1561 ret = FAIL;
1562
1563 if (ret == OK)
1564 {
1565 int i = 0;
1566
1567 if (get_vim_var_nr(VV_TESTING))
1568 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001569 // Prepare for calling test_garbagecollect_now(), need to know
1570 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001571 if (funcargs.ga_itemsize == 0)
1572 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1573 for (i = 0; i < argcount; ++i)
1574 if (ga_grow(&funcargs, 1) == OK)
1575 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1576 &argvars[i];
1577 }
1578
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001579 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580
1581 funcargs.ga_len -= i;
1582 }
1583 else if (!aborting())
1584 {
1585 if (argcount == MAX_FUNC_ARGS)
1586 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1587 else
1588 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1589 }
1590
1591 while (--argcount >= 0)
1592 clear_tv(&argvars[argcount]);
1593
Bram Moolenaar8294d492020-08-10 22:40:56 +02001594 if (in_vim9script())
1595 *arg = argp;
1596 else
1597 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 return ret;
1599}
1600
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601/*
1602 * Return TRUE if "p" starts with "<SID>" or "s:".
1603 * Only works if eval_fname_script() returned non-zero for "p"!
1604 */
1605 static int
1606eval_fname_sid(char_u *p)
1607{
1608 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1609}
1610
1611/*
1612 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1613 * Change <SNR>123_name() to K_SNR 123_name().
1614 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1615 * (slow).
1616 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001617 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1619{
1620 int llen;
1621 char_u *fname;
1622 int i;
1623
1624 llen = eval_fname_script(name);
1625 if (llen > 0)
1626 {
1627 fname_buf[0] = K_SPECIAL;
1628 fname_buf[1] = KS_EXTRA;
1629 fname_buf[2] = (int)KE_SNR;
1630 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001631 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001632 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001633 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001634 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 else
1636 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001637 sprintf((char *)fname_buf + 3, "%ld_",
1638 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 i = (int)STRLEN(fname_buf);
1640 }
1641 }
1642 if (i + STRLEN(name + llen) < FLEN_FIXED)
1643 {
1644 STRCPY(fname_buf + i, name + llen);
1645 fname = fname_buf;
1646 }
1647 else
1648 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001649 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001651 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652 else
1653 {
1654 *tofree = fname;
1655 mch_memmove(fname, fname_buf, (size_t)i);
1656 STRCPY(fname + i, name + llen);
1657 }
1658 }
1659 }
1660 else
1661 fname = name;
1662 return fname;
1663}
1664
1665/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001666 * Find a function "name" in script "sid".
1667 */
1668 static ufunc_T *
1669find_func_with_sid(char_u *name, int sid)
1670{
1671 hashitem_T *hi;
1672 char_u buffer[200];
1673
1674 buffer[0] = K_SPECIAL;
1675 buffer[1] = KS_EXTRA;
1676 buffer[2] = (int)KE_SNR;
1677 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1678 (long)sid, name);
1679 hi = hash_find(&func_hashtab, buffer);
1680 if (!HASHITEM_EMPTY(hi))
1681 return HI2UF(hi);
1682
1683 return NULL;
1684}
1685
1686/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001688 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001689 * Return NULL for unknown function.
1690 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001691 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001692find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693{
1694 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001695 ufunc_T *func;
1696 imported_T *imported;
1697
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001698 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001699 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001700 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001701 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001702 int find_script_local = in_vim9script()
1703 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001704
Bram Moolenaar95006e32020-08-29 17:47:08 +02001705 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001706 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001707 // Find script-local function before global one.
1708 func = find_func_with_sid(name, current_sctx.sc_sid);
1709 if (func != NULL)
1710 return func;
1711 }
1712
Bram Moolenaarefa94442020-08-08 22:16:00 +02001713 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001714 && name[1] == KS_EXTRA
1715 && name[2] == KE_SNR)
1716 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001717 // Caller changes s: to <SNR>99_name.
1718
1719 after_script = name + 3;
1720 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001721 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001722 ++after_script;
1723 else
1724 after_script = NULL;
1725 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001726 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001727 {
1728 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001729 if (after_script != NULL && sid != current_sctx.sc_sid)
1730 imported = find_imported_in_script(after_script, 0, sid);
1731 else
1732 imported = find_imported(after_script == NULL
1733 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001734 if (imported != NULL && imported->imp_funcname != NULL)
1735 {
1736 hi = hash_find(&func_hashtab, imported->imp_funcname);
1737 if (!HASHITEM_EMPTY(hi))
1738 return HI2UF(hi);
1739 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001740 }
1741 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001742
Bram Moolenaara26b9702020-04-18 19:53:28 +02001743 hi = hash_find(&func_hashtab,
1744 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 if (!HASHITEM_EMPTY(hi))
1746 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001747
1748 return NULL;
1749}
1750
1751/*
1752 * Find a function by name, return pointer to it in ufuncs.
1753 * "cctx" is passed in a :def function to find imported functions.
1754 * Return NULL for unknown or dead function.
1755 */
1756 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001757find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001758{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001759 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001760
1761 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1762 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001763 return NULL;
1764}
1765
1766/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001767 * Return TRUE if "ufunc" is a global function.
1768 */
1769 int
1770func_is_global(ufunc_T *ufunc)
1771{
1772 return ufunc->uf_name[0] != K_SPECIAL;
1773}
1774
1775/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 * Copy the function name of "fp" to buffer "buf".
1777 * "buf" must be able to hold the function name plus three bytes.
1778 * Takes care of script-local function names.
1779 */
1780 static void
1781cat_func_name(char_u *buf, ufunc_T *fp)
1782{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001783 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001784 {
1785 STRCPY(buf, "<SNR>");
1786 STRCAT(buf, fp->uf_name + 3);
1787 }
1788 else
1789 STRCPY(buf, fp->uf_name);
1790}
1791
1792/*
1793 * Add a number variable "name" to dict "dp" with value "nr".
1794 */
1795 static void
1796add_nr_var(
1797 dict_T *dp,
1798 dictitem_T *v,
1799 char *name,
1800 varnumber_T nr)
1801{
1802 STRCPY(v->di_key, name);
1803 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1804 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1805 v->di_tv.v_type = VAR_NUMBER;
1806 v->di_tv.v_lock = VAR_FIXED;
1807 v->di_tv.vval.v_number = nr;
1808}
1809
1810/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001811 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001812 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001813 static void
1814free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001815{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001816 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001817
1818 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1819 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001820 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001821
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001822 // When garbage collecting a funccall_T may be freed before the
1823 // function that references it, clear its uf_scoped field.
1824 // The function may have been redefined and point to another
1825 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001826 if (fp != NULL && fp->uf_scoped == fc)
1827 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001828 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001829 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001831 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001832 vim_free(fc);
1833}
1834
1835/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001836 * Free "fc" and what it contains.
1837 * Can be called only when "fc" is kept beyond the period of it called,
1838 * i.e. after cleanup_function_call(fc).
1839 */
1840 static void
1841free_funccal_contents(funccall_T *fc)
1842{
1843 listitem_T *li;
1844
1845 // Free all l: variables.
1846 vars_clear(&fc->l_vars.dv_hashtab);
1847
1848 // Free all a: variables.
1849 vars_clear(&fc->l_avars.dv_hashtab);
1850
1851 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001852 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001853 clear_tv(&li->li_tv);
1854
1855 free_funccal(fc);
1856}
1857
1858/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001859 * Handle the last part of returning from a function: free the local hashtable.
1860 * Unless it is still in use by a closure.
1861 */
1862 static void
1863cleanup_function_call(funccall_T *fc)
1864{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001865 int may_free_fc = fc->fc_refcount <= 0;
1866 int free_fc = TRUE;
1867
Bram Moolenaar6914c642017-04-01 21:21:30 +02001868 current_funccal = fc->caller;
1869
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001870 // Free all l: variables if not referred.
1871 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1872 vars_clear(&fc->l_vars.dv_hashtab);
1873 else
1874 free_fc = FALSE;
1875
1876 // If the a:000 list and the l: and a: dicts are not referenced and
1877 // there is no closure using it, we can free the funccall_T and what's
1878 // in it.
1879 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1880 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001881 else
1882 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001883 int todo;
1884 hashitem_T *hi;
1885 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001886
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001887 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001888
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001889 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001890 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1891 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1892 {
1893 if (!HASHITEM_EMPTY(hi))
1894 {
1895 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001896 di = HI2DI(hi);
1897 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001898 }
1899 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001900 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001901
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001902 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1903 fc->l_varlist.lv_first = NULL;
1904 else
1905 {
1906 listitem_T *li;
1907
1908 free_fc = FALSE;
1909
1910 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001911 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001912 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001913 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001914
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001915 if (free_fc)
1916 free_funccal(fc);
1917 else
1918 {
1919 static int made_copy = 0;
1920
1921 // "fc" is still in use. This can happen when returning "a:000",
1922 // assigning "l:" to a global variable or defining a closure.
1923 // Link "fc" in the list for garbage collection later.
1924 fc->caller = previous_funccal;
1925 previous_funccal = fc;
1926
1927 if (want_garbage_collect)
1928 // If garbage collector is ready, clear count.
1929 made_copy = 0;
1930 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001931 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001932 // We have made a lot of copies, worth 4 Mbyte. This can happen
1933 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001934 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001935 // too much memory.
1936 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001937 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001938 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001939 }
1940}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001941
1942/*
1943 * There are two kinds of function names:
1944 * 1. ordinary names, function defined with :function or :def
1945 * 2. numbered functions and lambdas
1946 * For the first we only count the name stored in func_hashtab as a reference,
1947 * using function() does not count as a reference, because the function is
1948 * looked up by name.
1949 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001950 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001951func_name_refcount(char_u *name)
1952{
1953 return isdigit(*name) || *name == '<';
1954}
1955
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001956/*
1957 * Unreference "fc": decrement the reference count and free it when it
1958 * becomes zero. "fp" is detached from "fc".
1959 * When "force" is TRUE we are exiting.
1960 */
1961 static void
1962funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1963{
1964 funccall_T **pfc;
1965 int i;
1966
1967 if (fc == NULL)
1968 return;
1969
1970 if (--fc->fc_refcount <= 0 && (force || (
1971 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1972 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1973 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1974 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1975 {
1976 if (fc == *pfc)
1977 {
1978 *pfc = fc->caller;
1979 free_funccal_contents(fc);
1980 return;
1981 }
1982 }
1983 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1984 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1985 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1986}
1987
1988/*
1989 * Remove the function from the function hashtable. If the function was
1990 * deleted while it still has references this was already done.
1991 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1992 */
1993 static int
1994func_remove(ufunc_T *fp)
1995{
1996 hashitem_T *hi;
1997
1998 // Return if it was already virtually deleted.
1999 if (fp->uf_flags & FC_DEAD)
2000 return FALSE;
2001
2002 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2003 if (!HASHITEM_EMPTY(hi))
2004 {
2005 // When there is a def-function index do not actually remove the
2006 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002007 // Do remove it when it's a copy.
2008 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002009 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002010 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002011 return FALSE;
2012 }
2013 hash_remove(&func_hashtab, hi);
2014 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002015 return TRUE;
2016 }
2017 return FALSE;
2018}
2019
2020 static void
2021func_clear_items(ufunc_T *fp)
2022{
2023 ga_clear_strings(&(fp->uf_args));
2024 ga_clear_strings(&(fp->uf_def_args));
2025 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002026 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002027 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002028 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002029 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002030
2031 // Increment the refcount of this function to avoid it being freed
2032 // recursively when the partial is freed.
2033 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002034 partial_unref(fp->uf_partial);
2035 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002036 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002037
2038#ifdef FEAT_LUA
2039 if (fp->uf_cb_free != NULL)
2040 {
2041 fp->uf_cb_free(fp->uf_cb_state);
2042 fp->uf_cb_free = NULL;
2043 }
2044
2045 fp->uf_cb_state = NULL;
2046 fp->uf_cb = NULL;
2047#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002048#ifdef FEAT_PROFILE
2049 VIM_CLEAR(fp->uf_tml_count);
2050 VIM_CLEAR(fp->uf_tml_total);
2051 VIM_CLEAR(fp->uf_tml_self);
2052#endif
2053}
2054
2055/*
2056 * Free all things that a function contains. Does not free the function
2057 * itself, use func_free() for that.
2058 * When "force" is TRUE we are exiting.
2059 */
2060 static void
2061func_clear(ufunc_T *fp, int force)
2062{
2063 if (fp->uf_cleared)
2064 return;
2065 fp->uf_cleared = TRUE;
2066
2067 // clear this function
2068 func_clear_items(fp);
2069 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002070 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002071}
2072
2073/*
2074 * Free a function and remove it from the list of functions. Does not free
2075 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002076 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002077 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002078 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002079 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002080func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002081{
2082 // Only remove it when not done already, otherwise we would remove a newer
2083 // version of the function with the same name.
2084 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2085 func_remove(fp);
2086
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002087 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002088 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002089 if (fp->uf_dfunc_idx > 0)
2090 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002091 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002092 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002093 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002094 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002095 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002096}
2097
2098/*
2099 * Free all things that a function contains and free the function itself.
2100 * When "force" is TRUE we are exiting.
2101 */
2102 static void
2103func_clear_free(ufunc_T *fp, int force)
2104{
2105 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002106 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2107 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002108 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002109 else
2110 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002111}
2112
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002113/*
2114 * Copy already defined function "lambda" to a new function with name "global".
2115 * This is for when a compiled function defines a global function.
2116 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002117 int
2118copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002119{
2120 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002121 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002122
2123 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002124 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002125 semsg(_(e_lambda_function_not_found_str), lambda);
2126 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002127 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002128
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002129 fp = find_func(global, TRUE, NULL);
2130 if (fp != NULL)
2131 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002132 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002133 semsg(_(e_funcexts), global);
2134 return FAIL;
2135 }
2136
2137 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2138 if (fp == NULL)
2139 return FAIL;
2140
2141 fp->uf_varargs = ufunc->uf_varargs;
2142 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2143 fp->uf_def_status = ufunc->uf_def_status;
2144 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2145 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2146 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2147 == FAIL
2148 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2149 goto failed;
2150
2151 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2152 : vim_strsave(ufunc->uf_name_exp);
2153 if (ufunc->uf_arg_types != NULL)
2154 {
2155 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2156 if (fp->uf_arg_types == NULL)
2157 goto failed;
2158 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2159 sizeof(type_T *) * fp->uf_args.ga_len);
2160 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002161 if (ufunc->uf_va_name != NULL)
2162 {
2163 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2164 if (fp->uf_va_name == NULL)
2165 goto failed;
2166 }
2167 fp->uf_ret_type = ufunc->uf_ret_type;
2168
2169 fp->uf_refcount = 1;
2170 STRCPY(fp->uf_name, global);
2171 hash_add(&func_hashtab, UF2HIKEY(fp));
2172
2173 // the referenced dfunc_T is now used one more time
2174 link_def_function(fp);
2175
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002176 // Create a partial to store the context of the function where it was
2177 // instantiated. Only needs to be done once. Do this on the original
2178 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002179 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2180 {
2181 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2182
2183 if (pt == NULL)
2184 goto failed;
2185 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002186 {
2187 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002188 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002189 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002190 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002191 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002192 }
2193
2194 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002195
2196failed:
2197 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002198 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002199}
2200
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002201static int funcdepth = 0;
2202
2203/*
2204 * Increment the function call depth count.
2205 * Return FAIL when going over 'maxfuncdepth'.
2206 * Otherwise return OK, must call funcdepth_decrement() later!
2207 */
2208 int
2209funcdepth_increment(void)
2210{
2211 if (funcdepth >= p_mfd)
2212 {
2213 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2214 return FAIL;
2215 }
2216 ++funcdepth;
2217 return OK;
2218}
2219
2220 void
2221funcdepth_decrement(void)
2222{
2223 --funcdepth;
2224}
2225
2226/*
2227 * Get the current function call depth.
2228 */
2229 int
2230funcdepth_get(void)
2231{
2232 return funcdepth;
2233}
2234
2235/*
2236 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002237 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002238 * times as funcdepth_increment().
2239 */
2240 void
2241funcdepth_restore(int depth)
2242{
2243 funcdepth = depth;
2244}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002245
2246/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 * Call a user function.
2248 */
2249 static void
2250call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002251 ufunc_T *fp, // pointer to function
2252 int argcount, // nr of args
2253 typval_T *argvars, // arguments
2254 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002255 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002256 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002257{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002258 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002259 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002260 funccall_T *fc;
2261 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002262 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002263 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002264 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265 int i;
2266 int ai;
2267 int islambda = FALSE;
2268 char_u numbuf[NUMBUFLEN];
2269 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002270 typval_T *tv_to_free[MAX_FUNC_ARGS];
2271 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002272#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002273 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002274#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002275 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002276
Bram Moolenaarb2049902021-01-24 12:53:53 +01002277#ifdef FEAT_PROFILE
2278 CLEAR_FIELD(profile_info);
2279#endif
2280
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002281 // If depth of calling is getting too high, don't execute the function.
2282 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002283 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002284 rettv->v_type = VAR_NUMBER;
2285 rettv->vval.v_number = -1;
2286 return;
2287 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002288
Bram Moolenaare38eab22019-12-05 21:50:01 +01002289 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002290
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002291 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002292 if (fc == NULL)
2293 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002294 fc->caller = current_funccal;
2295 current_funccal = fc;
2296 fc->func = fp;
2297 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002299 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002300 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2301 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002302 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002303 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002304 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002305
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002306 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002307 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002308#ifdef FEAT_PROFILE
2309 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2310#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002311 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002312#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002313 if (do_profiling == PROF_YES)
2314 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002315#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002316 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002317 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002318#ifdef FEAT_PROFILE
2319 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002320 || (caller != NULL && caller->uf_profiling)))
2321 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002322#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002324 free_funccal(fc);
2325 return;
2326 }
2327
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002328 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2329 islambda = TRUE;
2330
2331 /*
2332 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2333 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2334 * each argument variable and saves a lot of time.
2335 */
2336 /*
2337 * Init l: variables.
2338 */
2339 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2340 if (selfdict != NULL)
2341 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002342 // Set l:self to "selfdict". Use "name" to avoid a warning from
2343 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344 v = &fc->fixvar[fixvar_idx++].var;
2345 name = v->di_key;
2346 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002347 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2349 v->di_tv.v_type = VAR_DICT;
2350 v->di_tv.v_lock = 0;
2351 v->di_tv.vval.v_dict = selfdict;
2352 ++selfdict->dv_refcount;
2353 }
2354
2355 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002356 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002357 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358 * Set a:000 to a list with room for the "..." arguments.
2359 */
2360 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002361 if ((fp->uf_flags & FC_NOARGS) == 0)
2362 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002363 (varnumber_T)(argcount >= fp->uf_args.ga_len
2364 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002365 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002366 if ((fp->uf_flags & FC_NOARGS) == 0)
2367 {
2368 // Use "name" to avoid a warning from some compiler that checks the
2369 // destination size.
2370 v = &fc->fixvar[fixvar_idx++].var;
2371 name = v->di_key;
2372 STRCPY(name, "000");
2373 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2374 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2375 v->di_tv.v_type = VAR_LIST;
2376 v->di_tv.v_lock = VAR_FIXED;
2377 v->di_tv.vval.v_list = &fc->l_varlist;
2378 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002379 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002380 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2381 fc->l_varlist.lv_lock = VAR_FIXED;
2382
2383 /*
2384 * Set a:firstline to "firstline" and a:lastline to "lastline".
2385 * Set a:name to named arguments.
2386 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002387 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002388 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002389 if ((fp->uf_flags & FC_NOARGS) == 0)
2390 {
2391 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002392 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002393 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002394 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002395 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002396 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002397 {
2398 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002399 typval_T def_rettv;
2400 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401
2402 ai = i - fp->uf_args.ga_len;
2403 if (ai < 0)
2404 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002405 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406 name = FUNCARG(fp, i);
2407 if (islambda)
2408 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002409
2410 // evaluate named argument default expression
2411 isdefault = ai + fp->uf_def_args.ga_len >= 0
2412 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2413 && argvars[i].vval.v_number == VVAL_NONE));
2414 if (isdefault)
2415 {
2416 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002417
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002418 def_rettv.v_type = VAR_NUMBER;
2419 def_rettv.vval.v_number = -1;
2420
2421 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2422 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002423 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002424 {
2425 default_arg_err = 1;
2426 break;
2427 }
2428 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002429 }
2430 else
2431 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002432 if ((fp->uf_flags & FC_NOARGS) != 0)
2433 // Bail out if no a: arguments used (in lambda).
2434 break;
2435
Bram Moolenaare38eab22019-12-05 21:50:01 +01002436 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002437 sprintf((char *)numbuf, "%d", ai + 1);
2438 name = numbuf;
2439 }
2440 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2441 {
2442 v = &fc->fixvar[fixvar_idx++].var;
2443 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002444 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002445 }
2446 else
2447 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002448 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 if (v == NULL)
2450 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002451 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002454 // Note: the values are copied directly to avoid alloc/free.
2455 // "argvars" must have VAR_FIXED for v_lock.
2456 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 v->di_tv.v_lock = VAR_FIXED;
2458
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002459 if (isdefault)
2460 // Need to free this later, no matter where it's stored.
2461 tv_to_free[tv_to_free_len++] = &v->di_tv;
2462
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463 if (addlocal)
2464 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002465 // Named arguments should be accessed without the "a:" prefix in
2466 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002467 copy_tv(&v->di_tv, &v->di_tv);
2468 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002470 else
2471 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472
2473 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2474 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002475 listitem_T *li = &fc->l_listitems[ai];
2476
2477 li->li_tv = argvars[i];
2478 li->li_tv.v_lock = VAR_FIXED;
2479 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 }
2481 }
2482
Bram Moolenaare38eab22019-12-05 21:50:01 +01002483 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002485
2486 if (fp->uf_flags & FC_SANDBOX)
2487 {
2488 using_sandbox = TRUE;
2489 ++sandbox;
2490 }
2491
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002492 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002493 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002494 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002496 ++no_wait_return;
2497 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002498
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002499 smsg(_("calling %s"), SOURCING_NAME);
2500 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002502 char_u buf[MSG_BUF_LEN];
2503 char_u numbuf2[NUMBUFLEN];
2504 char_u *tofree;
2505 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002507 msg_puts("(");
2508 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002510 if (i > 0)
2511 msg_puts(", ");
2512 if (argvars[i].v_type == VAR_NUMBER)
2513 msg_outnum((long)argvars[i].vval.v_number);
2514 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002516 // Do not want errors such as E724 here.
2517 ++emsg_off;
2518 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2519 --emsg_off;
2520 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002522 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002524 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2525 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002527 msg_puts((char *)s);
2528 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 }
2530 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002532 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002534 msg_puts("\n"); // don't overwrite this either
2535
2536 verbose_leave_scroll();
2537 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 }
2539#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002540 if (do_profiling == PROF_YES)
2541 profile_may_start_func(&profile_info, fp,
2542 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543#endif
2544
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002545 save_current_sctx = current_sctx;
2546 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 save_did_emsg = did_emsg;
2548 did_emsg = FALSE;
2549
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002550 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2551 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002552 else if (islambda)
2553 {
2554 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2555
2556 // A Lambda always has the command "return {expr}". It is much faster
2557 // to evaluate {expr} directly.
2558 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002559 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002560 --ex_nesting_level;
2561 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002562 else
2563 // call do_cmdline() to execute the lines
2564 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002565 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2566
2567 --RedrawingDisabled;
2568
Bram Moolenaare38eab22019-12-05 21:50:01 +01002569 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2571 {
2572 clear_tv(rettv);
2573 rettv->v_type = VAR_NUMBER;
2574 rettv->vval.v_number = -1;
2575 }
2576
2577#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002578 if (do_profiling == PROF_YES)
2579 {
2580 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2581
2582 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2583 profile_may_end_func(&profile_info, fp, caller);
2584 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585#endif
2586
Bram Moolenaare38eab22019-12-05 21:50:01 +01002587 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588 if (p_verbose >= 12)
2589 {
2590 ++no_wait_return;
2591 verbose_enter_scroll();
2592
2593 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002594 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002595 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002596 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002597 (long)fc->rettv->vval.v_number);
2598 else
2599 {
2600 char_u buf[MSG_BUF_LEN];
2601 char_u numbuf2[NUMBUFLEN];
2602 char_u *tofree;
2603 char_u *s;
2604
Bram Moolenaare38eab22019-12-05 21:50:01 +01002605 // The value may be very long. Skip the middle part, so that we
2606 // have some idea how it starts and ends. smsg() would always
2607 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 ++emsg_off;
2609 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2610 --emsg_off;
2611 if (s != NULL)
2612 {
2613 if (vim_strsize(s) > MSG_BUF_CLEN)
2614 {
2615 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2616 s = buf;
2617 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002618 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002619 vim_free(tofree);
2620 }
2621 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002622 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623
2624 verbose_leave_scroll();
2625 --no_wait_return;
2626 }
2627
Bram Moolenaare31ee862020-01-07 20:59:34 +01002628 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002629 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002630 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631#ifdef FEAT_PROFILE
2632 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002633 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002635 if (using_sandbox)
2636 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002638 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 {
2640 ++no_wait_return;
2641 verbose_enter_scroll();
2642
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002643 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002644 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002645
2646 verbose_leave_scroll();
2647 --no_wait_return;
2648 }
2649
2650 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002651 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002652 for (i = 0; i < tv_to_free_len; ++i)
2653 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002654 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655}
2656
2657/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002658 * Check the argument count for user function "fp".
2659 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2660 */
2661 int
2662check_user_func_argcount(ufunc_T *fp, int argcount)
2663{
2664 int regular_args = fp->uf_args.ga_len;
2665
2666 if (argcount < regular_args - fp->uf_def_args.ga_len)
2667 return FCERR_TOOFEW;
2668 else if (!has_varargs(fp) && argcount > regular_args)
2669 return FCERR_TOOMANY;
2670 return FCERR_UNKNOWN;
2671}
2672
2673/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002674 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002675 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002676 int
2677call_user_func_check(
2678 ufunc_T *fp,
2679 int argcount,
2680 typval_T *argvars,
2681 typval_T *rettv,
2682 funcexe_T *funcexe,
2683 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002684{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002685 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002686
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002687 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2688 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002689 error = check_user_func_argcount(fp, argcount);
2690 if (error != FCERR_UNKNOWN)
2691 return error;
2692 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002693 error = FCERR_DICT;
2694 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002695 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002696 int did_save_redo = FALSE;
2697 save_redo_T save_redo;
2698
2699 /*
2700 * Call the user function.
2701 * Save and restore search patterns, script variables and
2702 * redo buffer.
2703 */
2704 save_search_patterns();
2705 if (!ins_compl_active())
2706 {
2707 saveRedobuff(&save_redo);
2708 did_save_redo = TRUE;
2709 }
2710 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002711 call_user_func(fp, argcount, argvars, rettv, funcexe,
2712 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002713 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2714 // Function was unreferenced while being used, free it now.
2715 func_clear_free(fp, FALSE);
2716 if (did_save_redo)
2717 restoreRedobuff(&save_redo);
2718 restore_search_patterns();
2719 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002720 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002721 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002722}
2723
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002724static funccal_entry_T *funccal_stack = NULL;
2725
2726/*
2727 * Save the current function call pointer, and set it to NULL.
2728 * Used when executing autocommands and for ":source".
2729 */
2730 void
2731save_funccal(funccal_entry_T *entry)
2732{
2733 entry->top_funccal = current_funccal;
2734 entry->next = funccal_stack;
2735 funccal_stack = entry;
2736 current_funccal = NULL;
2737}
2738
2739 void
2740restore_funccal(void)
2741{
2742 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002743 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002744 else
2745 {
2746 current_funccal = funccal_stack->top_funccal;
2747 funccal_stack = funccal_stack->next;
2748 }
2749}
2750
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002751 funccall_T *
2752get_current_funccal(void)
2753{
2754 return current_funccal;
2755}
2756
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002757/*
2758 * Mark all functions of script "sid" as deleted.
2759 */
2760 void
2761delete_script_functions(int sid)
2762{
2763 hashitem_T *hi;
2764 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002765 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002766 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002767 size_t len;
2768
2769 buf[0] = K_SPECIAL;
2770 buf[1] = KS_EXTRA;
2771 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002772 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002773 len = STRLEN(buf);
2774
Bram Moolenaarce658352020-07-31 23:47:12 +02002775 while (todo > 0)
2776 {
2777 todo = func_hashtab.ht_used;
2778 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2779 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002780 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002781 fp = HI2UF(hi);
2782 if (STRNCMP(fp->uf_name, buf, len) == 0)
2783 {
2784 int changed = func_hashtab.ht_changed;
2785
2786 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002787
2788 if (fp->uf_calls > 0)
2789 {
2790 // Function is executing, don't free it but do remove
2791 // it from the hashtable.
2792 if (func_remove(fp))
2793 fp->uf_refcount--;
2794 }
2795 else
2796 {
2797 func_clear(fp, TRUE);
2798 // When clearing a function another function can be
2799 // cleared as a side effect. When that happens start
2800 // over.
2801 if (changed != func_hashtab.ht_changed)
2802 break;
2803 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002804 }
2805 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002806 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002807 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002808}
2809
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810#if defined(EXITFREE) || defined(PROTO)
2811 void
2812free_all_functions(void)
2813{
2814 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002815 ufunc_T *fp;
2816 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002817 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002818 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819
Bram Moolenaare38eab22019-12-05 21:50:01 +01002820 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002821 while (current_funccal != NULL)
2822 {
2823 clear_tv(current_funccal->rettv);
2824 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002825 if (current_funccal == NULL && funccal_stack != NULL)
2826 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002827 }
2828
Bram Moolenaare38eab22019-12-05 21:50:01 +01002829 // First clear what the functions contain. Since this may lower the
2830 // reference count of a function, it may also free a function and change
2831 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002832 while (todo > 0)
2833 {
2834 todo = func_hashtab.ht_used;
2835 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2836 if (!HASHITEM_EMPTY(hi))
2837 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002838 // clear the def function index now
2839 fp = HI2UF(hi);
2840 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002841 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002842
Bram Moolenaare38eab22019-12-05 21:50:01 +01002843 // Only free functions that are not refcounted, those are
2844 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002845 if (func_name_refcount(fp->uf_name))
2846 ++skipped;
2847 else
2848 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002849 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002850 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002851 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002852 {
2853 skipped = 0;
2854 break;
2855 }
2856 }
2857 --todo;
2858 }
2859 }
2860
Bram Moolenaare38eab22019-12-05 21:50:01 +01002861 // Now actually free the functions. Need to start all over every time,
2862 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002863 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002864 while (func_hashtab.ht_used > skipped)
2865 {
2866 todo = func_hashtab.ht_used;
2867 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 if (!HASHITEM_EMPTY(hi))
2869 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002870 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002871 // Only free functions that are not refcounted, those are
2872 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002873 fp = HI2UF(hi);
2874 if (func_name_refcount(fp->uf_name))
2875 ++skipped;
2876 else
2877 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002878 if (func_free(fp, FALSE) == OK)
2879 {
2880 skipped = 0;
2881 break;
2882 }
2883 // did not actually free it
2884 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002885 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002886 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002887 }
2888 if (skipped == 0)
2889 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002890
2891 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892}
2893#endif
2894
2895/*
2896 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002897 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 * "len" is the length of "name", or -1 for NUL terminated.
2899 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002900 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901builtin_function(char_u *name, int len)
2902{
2903 char_u *p;
2904
Bram Moolenaara26b9702020-04-18 19:53:28 +02002905 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 return FALSE;
2907 p = vim_strchr(name, AUTOLOAD_CHAR);
2908 return p == NULL || (len > 0 && p > name + len);
2909}
2910
2911 int
2912func_call(
2913 char_u *name,
2914 typval_T *args,
2915 partial_T *partial,
2916 dict_T *selfdict,
2917 typval_T *rettv)
2918{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002919 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920 listitem_T *item;
2921 typval_T argv[MAX_FUNC_ARGS + 1];
2922 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923 int r = 0;
2924
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002925 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002926 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927 {
2928 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2929 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002930 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002931 break;
2932 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002933 // Make a copy of each argument. This is needed to be able to set
2934 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002935 copy_tv(&item->li_tv, &argv[argc++]);
2936 }
2937
2938 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002939 {
2940 funcexe_T funcexe;
2941
Bram Moolenaara80faa82020-04-12 19:37:17 +02002942 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002943 funcexe.firstline = curwin->w_cursor.lnum;
2944 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002945 funcexe.evaluate = TRUE;
2946 funcexe.partial = partial;
2947 funcexe.selfdict = selfdict;
2948 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2949 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950
Bram Moolenaare38eab22019-12-05 21:50:01 +01002951 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 while (argc > 0)
2953 clear_tv(&argv[--argc]);
2954
2955 return r;
2956}
2957
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002958static int callback_depth = 0;
2959
2960 int
2961get_callback_depth(void)
2962{
2963 return callback_depth;
2964}
2965
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002967 * Invoke call_func() with a callback.
2968 */
2969 int
2970call_callback(
2971 callback_T *callback,
2972 int len, // length of "name" or -1 to use strlen()
2973 typval_T *rettv, // return value goes here
2974 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002975 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002976 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002977{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002978 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002979 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002980
Bram Moolenaara80faa82020-04-12 19:37:17 +02002981 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002982 funcexe.evaluate = TRUE;
2983 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002984 ++callback_depth;
2985 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2986 --callback_depth;
2987 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002988}
2989
2990/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002991 * Give an error message for the result of a function.
2992 * Nothing if "error" is FCERR_NONE.
2993 */
2994 void
2995user_func_error(int error, char_u *name)
2996{
2997 switch (error)
2998 {
2999 case FCERR_UNKNOWN:
3000 emsg_funcname(e_unknownfunc, name);
3001 break;
3002 case FCERR_NOTMETHOD:
3003 emsg_funcname(
3004 N_("E276: Cannot use function as a method: %s"), name);
3005 break;
3006 case FCERR_DELETED:
3007 emsg_funcname(N_(e_func_deleted), name);
3008 break;
3009 case FCERR_TOOMANY:
3010 emsg_funcname((char *)e_toomanyarg, name);
3011 break;
3012 case FCERR_TOOFEW:
3013 emsg_funcname((char *)e_toofewarg, name);
3014 break;
3015 case FCERR_SCRIPT:
3016 emsg_funcname(
3017 N_("E120: Using <SID> not in a script context: %s"), name);
3018 break;
3019 case FCERR_DICT:
3020 emsg_funcname(
3021 N_("E725: Calling dict function without Dictionary: %s"),
3022 name);
3023 break;
3024 }
3025}
3026
3027/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003029 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 * Return FAIL when the function can't be called, OK otherwise.
3031 * Also returns OK when an error was encountered while executing the function.
3032 */
3033 int
3034call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003035 char_u *funcname, // name of the function
3036 int len, // length of "name" or -1 to use strlen()
3037 typval_T *rettv, // return value goes here
3038 int argcount_in, // number of "argvars"
3039 typval_T *argvars_in, // vars for arguments, must have "argcount"
3040 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003041 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003042{
3043 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003044 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003045 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003046 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 char_u fname_buf[FLEN_FIXED + 1];
3048 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003049 char_u *fname = NULL;
3050 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 int argcount = argcount_in;
3052 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003053 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003054 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3055 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003056 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003057 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003058 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003060 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3061 // even when call_func() returns FAIL.
3062 rettv->v_type = VAR_UNKNOWN;
3063
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003064 if (partial != NULL)
3065 fp = partial->pt_func;
3066 if (fp == NULL)
3067 {
3068 // Make a copy of the name, if it comes from a funcref variable it
3069 // could be changed or deleted in the called function.
3070 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3071 if (name == NULL)
3072 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003074 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3075 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003076
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003077 if (funcexe->doesrange != NULL)
3078 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003079
3080 if (partial != NULL)
3081 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003082 // When the function has a partial with a dict and there is a dict
3083 // argument, use the dict argument. That is backwards compatible.
3084 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003085 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003086 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003087 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003088 {
3089 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003090 {
3091 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3092 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003093 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003094 goto theend;
3095 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003097 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003098 for (i = 0; i < argcount_in; ++i)
3099 argv[i + argv_clear] = argvars_in[i];
3100 argvars = argv;
3101 argcount = partial->pt_argc + argcount_in;
3102 }
3103 }
3104
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003105 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3106 {
3107 // Check that the argument types are OK for the types of the funcref.
3108 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003109 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003110 error = FCERR_OTHER;
3111 }
3112
Bram Moolenaaref140542019-12-31 21:27:13 +01003113 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003114 {
3115 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003116 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003117
Bram Moolenaar333894b2020-08-01 18:53:07 +02003118 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003119 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003120 {
3121 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003123 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124
Bram Moolenaare38eab22019-12-05 21:50:01 +01003125 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003127 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003129 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 {
3131 /*
3132 * User defined function.
3133 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003134 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003135 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136
Bram Moolenaare38eab22019-12-05 21:50:01 +01003137 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 if (fp == NULL
3139 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003140 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141 && !aborting())
3142 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003143 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003144 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003146 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3148 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003149 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003150 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003152 if (fp == NULL)
3153 {
3154 char_u *p = untrans_function_name(rfname);
3155
3156 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003157 // Don't do this if the name starts with "s:".
3158 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003159 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003160 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003162 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003163 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003164#ifdef FEAT_LUA
3165 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3166 {
3167 cfunc_T cb = fp->uf_cb;
3168
3169 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3170 }
3171#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003172 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003173 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003174 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003175 // postponed filling in the arguments, do it now
3176 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003177 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003178
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003179 if (funcexe->basetv != NULL)
3180 {
3181 // Method call: base->Method()
3182 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3183 argv[0] = *funcexe->basetv;
3184 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003185 argvars = argv;
3186 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003187 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003188
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003189 error = call_user_func_check(fp, argcount, argvars, rettv,
3190 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191 }
3192 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003193 else if (funcexe->basetv != NULL)
3194 {
3195 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003196 * expr->method(): Find the method name in the table, call its
3197 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003198 */
3199 error = call_internal_method(fname, argcount, argvars, rettv,
3200 funcexe->basetv);
3201 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003202 else
3203 {
3204 /*
3205 * Find the function name in the table, call its implementation.
3206 */
3207 error = call_internal_func(fname, argcount, argvars, rettv);
3208 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003209
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 /*
3211 * The function call (or "FuncUndefined" autocommand sequence) might
3212 * have been aborted by an error, an interrupt, or an explicitly thrown
3213 * exception that has not been caught so far. This situation can be
3214 * tested for by calling aborting(). For an error in an internal
3215 * function or for the "E132" error in call_user_func(), however, the
3216 * throw point at which the "force_abort" flag (temporarily reset by
3217 * emsg()) is normally updated has not been reached yet. We need to
3218 * update that flag first to make aborting() reliable.
3219 */
3220 update_force_abort();
3221 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003222 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 ret = OK;
3224
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003225theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 /*
3227 * Report an error unless the argument evaluation or function call has been
3228 * cancelled due to an aborting error, an interrupt, or an exception.
3229 */
3230 if (!aborting())
3231 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003232 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233 }
3234
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003235 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003237 clear_tv(&argv[--argv_clear + argv_base]);
3238
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239 vim_free(tofree);
3240 vim_free(name);
3241
3242 return ret;
3243}
3244
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003245 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003246printable_func_name(ufunc_T *fp)
3247{
3248 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3249}
3250
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003251/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003252 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253 */
3254 static void
3255list_func_head(ufunc_T *fp, int indent)
3256{
3257 int j;
3258
3259 msg_start();
3260 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003261 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003262 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003263 msg_puts("def ");
3264 else
3265 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003266 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 msg_putchar('(');
3268 for (j = 0; j < fp->uf_args.ga_len; ++j)
3269 {
3270 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003271 msg_puts(", ");
3272 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003273 if (fp->uf_arg_types != NULL)
3274 {
3275 char *tofree;
3276
3277 msg_puts(": ");
3278 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3279 vim_free(tofree);
3280 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003281 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3282 {
3283 msg_puts(" = ");
3284 msg_puts(((char **)(fp->uf_def_args.ga_data))
3285 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3286 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287 }
3288 if (fp->uf_varargs)
3289 {
3290 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003291 msg_puts(", ");
3292 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003293 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003294 if (fp->uf_va_name != NULL)
3295 {
3296 if (j)
3297 msg_puts(", ");
3298 msg_puts("...");
3299 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003300 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003301 {
3302 char *tofree;
3303
3304 msg_puts(": ");
3305 msg_puts(type_name(fp->uf_va_type, &tofree));
3306 vim_free(tofree);
3307 }
3308 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003310
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003311 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003312 {
3313 if (fp->uf_ret_type != &t_void)
3314 {
3315 char *tofree;
3316
3317 msg_puts(": ");
3318 msg_puts(type_name(fp->uf_ret_type, &tofree));
3319 vim_free(tofree);
3320 }
3321 }
3322 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003323 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003324 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003325 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003326 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003327 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003328 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003329 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 msg_clr_eos();
3331 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003332 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003333}
3334
3335/*
3336 * Get a function name, translating "<SID>" and "<SNR>".
3337 * Also handles a Funcref in a List or Dictionary.
3338 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003339 * Set "*is_global" to TRUE when the function must be global, unless
3340 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 * flags:
3342 * TFN_INT: internal function name OK
3343 * TFN_QUIET: be quiet
3344 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003345 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 * Advances "pp" to just after the function name (if no error).
3347 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003348 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349trans_function_name(
3350 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003351 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003352 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003354 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003355 partial_T **partial, // return: partial of a FuncRef
3356 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357{
3358 char_u *name = NULL;
3359 char_u *start;
3360 char_u *end;
3361 int lead;
3362 char_u sid_buf[20];
3363 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003364 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003366 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003367 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368
3369 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003370 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 start = *pp;
3372
Bram Moolenaare38eab22019-12-05 21:50:01 +01003373 // Check for hard coded <SNR>: already translated function ID (from a user
3374 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3376 && (*pp)[2] == (int)KE_SNR)
3377 {
3378 *pp += 3;
3379 len = get_id_len(pp) + 3;
3380 return vim_strnsave(start, len);
3381 }
3382
Bram Moolenaare38eab22019-12-05 21:50:01 +01003383 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3384 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385 lead = eval_fname_script(start);
3386 if (lead > 2)
3387 start += lead;
3388
Bram Moolenaare38eab22019-12-05 21:50:01 +01003389 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003390 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391 lead > 2 ? 0 : FNE_CHECK_START);
3392 if (end == start)
3393 {
3394 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003395 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396 goto theend;
3397 }
3398 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3399 {
3400 /*
3401 * Report an invalid expression in braces, unless the expression
3402 * evaluation has been cancelled due to an aborting error, an
3403 * interrupt, or an exception.
3404 */
3405 if (!aborting())
3406 {
3407 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003408 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 }
3410 else
3411 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3412 goto theend;
3413 }
3414
3415 if (lv.ll_tv != NULL)
3416 {
3417 if (fdp != NULL)
3418 {
3419 fdp->fd_dict = lv.ll_dict;
3420 fdp->fd_newkey = lv.ll_newkey;
3421 lv.ll_newkey = NULL;
3422 fdp->fd_di = lv.ll_di;
3423 }
3424 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3425 {
3426 name = vim_strsave(lv.ll_tv->vval.v_string);
3427 *pp = end;
3428 }
3429 else if (lv.ll_tv->v_type == VAR_PARTIAL
3430 && lv.ll_tv->vval.v_partial != NULL)
3431 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003432 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433 *pp = end;
3434 if (partial != NULL)
3435 *partial = lv.ll_tv->vval.v_partial;
3436 }
3437 else
3438 {
3439 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3440 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003441 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 else
3443 *pp = end;
3444 name = NULL;
3445 }
3446 goto theend;
3447 }
3448
3449 if (lv.ll_name == NULL)
3450 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003451 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 *pp = end;
3453 goto theend;
3454 }
3455
Bram Moolenaare38eab22019-12-05 21:50:01 +01003456 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 if (lv.ll_exp_name != NULL)
3458 {
3459 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003460 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 flags & TFN_NO_AUTOLOAD);
3462 if (name == lv.ll_exp_name)
3463 name = NULL;
3464 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003465 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 {
3467 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003468 name = deref_func_name(*pp, &len, partial, type,
3469 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470 if (name == *pp)
3471 name = NULL;
3472 }
3473 if (name != NULL)
3474 {
3475 name = vim_strsave(name);
3476 *pp = end;
3477 if (STRNCMP(name, "<SNR>", 5) == 0)
3478 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003479 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480 name[0] = K_SPECIAL;
3481 name[1] = KS_EXTRA;
3482 name[2] = (int)KE_SNR;
3483 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3484 }
3485 goto theend;
3486 }
3487
3488 if (lv.ll_exp_name != NULL)
3489 {
3490 len = (int)STRLEN(lv.ll_exp_name);
3491 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3492 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3493 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003494 // When there was "s:" already or the name expanded to get a
3495 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 lv.ll_name += 2;
3497 len -= 2;
3498 lead = 2;
3499 }
3500 }
3501 else
3502 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003503 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003505 {
3506 if (is_global != NULL && lv.ll_name[0] == 'g')
3507 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003509 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003510 len = (int)(end - lv.ll_name);
3511 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003512 if (len <= 0)
3513 {
3514 if (!skip)
3515 emsg(_(e_function_name));
3516 goto theend;
3517 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003518
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003519 // In Vim9 script a user function is script-local by default, unless it
3520 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003521 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003522 if (vim9script)
3523 {
3524 char_u *p;
3525
3526 // SomeScript#func() is a global function.
3527 for (p = start; *p != NUL && *p != '('; ++p)
3528 if (*p == AUTOLOAD_CHAR)
3529 vim9script = FALSE;
3530 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003531
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 /*
3533 * Copy the function name to allocated memory.
3534 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3535 * Accept <SNR>123_name() outside a script.
3536 */
3537 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003538 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003539 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003541 if (!vim9script)
3542 lead = 3;
3543 if (vim9script || (lv.ll_exp_name != NULL
3544 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 || eval_fname_sid(*pp))
3546 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003547 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003548 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003550 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 goto theend;
3552 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003553 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003554 if (vim9script)
3555 extra = 3 + (int)STRLEN(sid_buf);
3556 else
3557 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 }
3559 }
3560 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3561 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003562 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 start);
3564 goto theend;
3565 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003566 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 {
3568 char_u *cp = vim_strchr(lv.ll_name, ':');
3569
3570 if (cp != NULL && cp < end)
3571 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003572 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 goto theend;
3574 }
3575 }
3576
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003577 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 if (name != NULL)
3579 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003580 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 {
3582 name[0] = K_SPECIAL;
3583 name[1] = KS_EXTRA;
3584 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003585 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 STRCPY(name + 3, sid_buf);
3587 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003588 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3589 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 }
3591 *pp = end;
3592
3593theend:
3594 clear_lval(&lv);
3595 return name;
3596}
3597
3598/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003599 * Assuming "name" is the result of trans_function_name() and it was prefixed
3600 * to use the script-local name, return the unmodified name (points into
3601 * "name"). Otherwise return NULL.
3602 * This can be used to first search for a script-local function and fall back
3603 * to the global function if not found.
3604 */
3605 char_u *
3606untrans_function_name(char_u *name)
3607{
3608 char_u *p;
3609
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003610 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003611 {
3612 p = vim_strchr(name, '_');
3613 if (p != NULL)
3614 return p + 1;
3615 }
3616 return NULL;
3617}
3618
3619/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003620 * List functions. When "regmatch" is NULL all of then.
3621 * Otherwise functions matching "regmatch".
3622 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003623 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003624list_functions(regmatch_T *regmatch)
3625{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003626 int changed = func_hashtab.ht_changed;
3627 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003628 hashitem_T *hi;
3629
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003630 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003631 {
3632 if (!HASHITEM_EMPTY(hi))
3633 {
3634 ufunc_T *fp = HI2UF(hi);
3635
3636 --todo;
3637 if ((fp->uf_flags & FC_DEAD) == 0
3638 && (regmatch == NULL
3639 ? !message_filtered(fp->uf_name)
3640 && !func_name_refcount(fp->uf_name)
3641 : !isdigit(*fp->uf_name)
3642 && vim_regexec(regmatch, fp->uf_name, 0)))
3643 {
3644 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003645 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003646 {
3647 emsg(_("E454: function list was modified"));
3648 return;
3649 }
3650 }
3651 }
3652 }
3653}
3654
3655/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003656 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003657 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3658 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003659 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003660 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003661 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003662define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003664 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 int j;
3666 int c;
3667 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003668 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003669 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 char_u *p;
3671 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003672 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 char_u *line_arg = NULL;
3674 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003675 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003676 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 garray_T newlines;
3678 int varargs = FALSE;
3679 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003680 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003681 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003682 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 dictitem_T *v;
3684 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003685 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003688 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003689 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003690 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003691
3692 /*
3693 * ":function" without argument: list functions.
3694 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003695 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 {
3697 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003698 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003700 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 }
3702
3703 /*
3704 * ":function /pat": list functions matching pattern.
3705 */
3706 if (*eap->arg == '/')
3707 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003708 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 if (!eap->skip)
3710 {
3711 regmatch_T regmatch;
3712
3713 c = *p;
3714 *p = NUL;
3715 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3716 *p = c;
3717 if (regmatch.regprog != NULL)
3718 {
3719 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003720 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 vim_regfree(regmatch.regprog);
3722 }
3723 }
3724 if (*p == '/')
3725 ++p;
3726 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003727 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003728 }
3729
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003730 ga_init(&newargs);
3731 ga_init(&argtypes);
3732 ga_init(&default_args);
3733
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 /*
3735 * Get the function name. There are these situations:
3736 * func normal function name
3737 * "name" == func, "fudi.fd_dict" == NULL
3738 * dict.func new dictionary entry
3739 * "name" == NULL, "fudi.fd_dict" set,
3740 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3741 * dict.func existing dict entry with a Funcref
3742 * "name" == func, "fudi.fd_dict" set,
3743 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3744 * dict.func existing dict entry that's not a Funcref
3745 * "name" == NULL, "fudi.fd_dict" set,
3746 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3747 * s:func script-local function name
3748 * g:func global function name, same as "func"
3749 */
3750 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003751 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003753 // nested function, argument is (args).
3754 paren = TRUE;
3755 CLEAR_FIELD(fudi);
3756 }
3757 else
3758 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003759 if (STRNCMP(p, "<lambda>", 8) == 0)
3760 {
3761 p += 8;
3762 (void)getdigits(&p);
3763 name = vim_strnsave(eap->arg, p - eap->arg);
3764 CLEAR_FIELD(fudi);
3765 }
3766 else
3767 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003768 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003769 paren = (vim_strchr(p, '(') != NULL);
3770 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003772 /*
3773 * Return on an invalid expression in braces, unless the expression
3774 * evaluation has been cancelled due to an aborting error, an
3775 * interrupt, or an exception.
3776 */
3777 if (!aborting())
3778 {
3779 if (!eap->skip && fudi.fd_newkey != NULL)
3780 semsg(_(e_dictkey), fudi.fd_newkey);
3781 vim_free(fudi.fd_newkey);
3782 return NULL;
3783 }
3784 else
3785 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 }
3788
Bram Moolenaare38eab22019-12-05 21:50:01 +01003789 // An error in a function call during evaluation of an expression in magic
3790 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 saved_did_emsg = did_emsg;
3792 did_emsg = FALSE;
3793
3794 /*
3795 * ":function func" with only function name: list function.
3796 */
3797 if (!paren)
3798 {
3799 if (!ends_excmd(*skipwhite(p)))
3800 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003801 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802 goto ret_free;
3803 }
3804 eap->nextcmd = check_nextcmd(p);
3805 if (eap->nextcmd != NULL)
3806 *p = NUL;
3807 if (!eap->skip && !got_int)
3808 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003809 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003810 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3811 {
3812 char_u *up = untrans_function_name(name);
3813
3814 // With Vim9 script the name was made script-local, if not
3815 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003816 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003817 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003818 }
3819
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 if (fp != NULL)
3821 {
3822 list_func_head(fp, TRUE);
3823 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3824 {
3825 if (FUNCLINE(fp, j) == NULL)
3826 continue;
3827 msg_putchar('\n');
3828 msg_outnum((long)(j + 1));
3829 if (j < 9)
3830 msg_putchar(' ');
3831 if (j < 99)
3832 msg_putchar(' ');
3833 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003834 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 ui_breakcheck();
3836 }
3837 if (!got_int)
3838 {
3839 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003840 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841 msg_puts(" enddef");
3842 else
3843 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 }
3845 }
3846 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003847 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848 }
3849 goto ret_free;
3850 }
3851
3852 /*
3853 * ":function name(arg1, arg2)" Define function.
3854 */
3855 p = skipwhite(p);
3856 if (*p != '(')
3857 {
3858 if (!eap->skip)
3859 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003860 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861 goto ret_free;
3862 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003863 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864 if (vim_strchr(p, '(') != NULL)
3865 p = vim_strchr(p, '(');
3866 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003868 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3869 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003870 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003871 goto ret_free;
3872 }
3873
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003874 // In Vim9 script only global functions can be redefined.
3875 if (vim9script && eap->forceit && !is_global)
3876 {
3877 emsg(_(e_nobang));
3878 goto ret_free;
3879 }
3880
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003881 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882
Bram Moolenaar04b12692020-05-04 23:24:44 +02003883 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003884 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003885 // Check the name of the function. Unless it's a dictionary function
3886 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 if (name != NULL)
3888 arg = name;
3889 else
3890 arg = fudi.fd_newkey;
3891 if (arg != NULL && (fudi.fd_di == NULL
3892 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3893 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3894 {
3895 if (*arg == K_SPECIAL)
3896 j = 3;
3897 else
3898 j = 0;
3899 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3900 : eval_isnamec(arg[j])))
3901 ++j;
3902 if (arg[j] != NUL)
3903 emsg_funcname((char *)e_invarg2, arg);
3904 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003905 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003907 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003908 }
3909
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003910 // This may get more lines and make the pointers into the first line
3911 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003912 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003913 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003914 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003915 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003916 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003918 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003920 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003921 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003922 // find the return type: :def Func(): type
3923 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003925 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003926 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003927 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003928 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003929 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003930 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003931 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003932 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003933 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003934 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003935 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003936 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003937 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003939 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003941 else
3942 // find extra arguments "range", "dict", "abort" and "closure"
3943 for (;;)
3944 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003945 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003946 p = skipwhite(p);
3947 if (STRNCMP(p, "range", 5) == 0)
3948 {
3949 flags |= FC_RANGE;
3950 p += 5;
3951 }
3952 else if (STRNCMP(p, "dict", 4) == 0)
3953 {
3954 flags |= FC_DICT;
3955 p += 4;
3956 }
3957 else if (STRNCMP(p, "abort", 5) == 0)
3958 {
3959 flags |= FC_ABORT;
3960 p += 5;
3961 }
3962 else if (STRNCMP(p, "closure", 7) == 0)
3963 {
3964 flags |= FC_CLOSURE;
3965 p += 7;
3966 if (current_funccal == NULL)
3967 {
3968 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3969 name == NULL ? (char_u *)"" : name);
3970 goto erret;
3971 }
3972 }
3973 else
3974 break;
3975 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976
Bram Moolenaare38eab22019-12-05 21:50:01 +01003977 // When there is a line break use what follows for the function body.
3978 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979 if (*p == '\n')
3980 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003981 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003982 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3983 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003984 && !(VIM_ISWHITE(*whitep) && *p == '#'
3985 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003986 && !eap->skip
3987 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003988 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989
3990 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003991 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3992 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 */
3994 if (KeyTyped)
3995 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003996 // Check if the function already exists, don't let the user type the
3997 // whole function before telling him it doesn't work! For a script we
3998 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 if (!eap->skip && !eap->forceit)
4000 {
4001 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004002 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004003 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 emsg_funcname(e_funcexts, name);
4005 }
4006
4007 if (!eap->skip && did_emsg)
4008 goto erret;
4009
Bram Moolenaare38eab22019-12-05 21:50:01 +01004010 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 cmdline_row = msg_row;
4012 }
4013
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004014 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004015 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004016
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004017 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004018 goto erret;
4019
4020 /*
4021 * If there are no errors, add the function
4022 */
4023 if (fudi.fd_dict == NULL)
4024 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004025 hashtab_T *ht;
4026
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004027 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4029 {
4030 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4031 name);
4032 goto erret;
4033 }
4034
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004035 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004036 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004038 char_u *uname = untrans_function_name(name);
4039
4040 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4041 }
4042
4043 if (fp != NULL || import != NULL)
4044 {
4045 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004046
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004047 // Function can be replaced with "function!" and when sourcing the
4048 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004049 // A name that is used by an import can not be overruled.
4050 if (import != NULL
4051 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004052 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004053 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004055 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004056 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004057 else
4058 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 goto erret;
4060 }
4061 if (fp->uf_calls > 0)
4062 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004063 emsg_funcname(
4064 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 name);
4066 goto erret;
4067 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004068 if (fp->uf_refcount > 1)
4069 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004070 // This function is referenced somewhere, don't redefine it but
4071 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004072 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004073 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004074 fp = NULL;
4075 overwrite = TRUE;
4076 }
4077 else
4078 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004079 char_u *exp_name = fp->uf_name_exp;
4080
4081 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004082 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004083 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004084 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004085 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004086 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004087#ifdef FEAT_PROFILE
4088 fp->uf_profiling = FALSE;
4089 fp->uf_prof_initialized = FALSE;
4090#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004091 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004092 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 }
4094 }
4095 else
4096 {
4097 char numbuf[20];
4098
4099 fp = NULL;
4100 if (fudi.fd_newkey == NULL && !eap->forceit)
4101 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004102 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103 goto erret;
4104 }
4105 if (fudi.fd_di == NULL)
4106 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004107 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004108 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004109 goto erret;
4110 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004111 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004112 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113 goto erret;
4114
Bram Moolenaare38eab22019-12-05 21:50:01 +01004115 // Give the function a sequential number. Can only be used with a
4116 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 vim_free(name);
4118 sprintf(numbuf, "%d", ++func_nr);
4119 name = vim_strsave((char_u *)numbuf);
4120 if (name == NULL)
4121 goto erret;
4122 }
4123
4124 if (fp == NULL)
4125 {
4126 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4127 {
4128 int slen, plen;
4129 char_u *scriptname;
4130
Bram Moolenaare38eab22019-12-05 21:50:01 +01004131 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004132 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004133 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134 {
4135 scriptname = autoload_name(name);
4136 if (scriptname != NULL)
4137 {
4138 p = vim_strchr(scriptname, '/');
4139 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004140 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004142 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004143 j = OK;
4144 vim_free(scriptname);
4145 }
4146 }
4147 if (j == FAIL)
4148 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004149 linenr_T save_lnum = SOURCING_LNUM;
4150
4151 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004152 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004153 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 goto erret;
4155 }
4156 }
4157
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004158 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 if (fp == NULL)
4160 goto erret;
4161
4162 if (fudi.fd_dict != NULL)
4163 {
4164 if (fudi.fd_di == NULL)
4165 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004166 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4168 if (fudi.fd_di == NULL)
4169 {
4170 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004171 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 goto erret;
4173 }
4174 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4175 {
4176 vim_free(fudi.fd_di);
4177 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004178 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 goto erret;
4180 }
4181 }
4182 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004183 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184 clear_tv(&fudi.fd_di->di_tv);
4185 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187
Bram Moolenaare38eab22019-12-05 21:50:01 +01004188 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 flags |= FC_DICT;
4190 }
4191
Bram Moolenaare38eab22019-12-05 21:50:01 +01004192 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004193 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004194 if (overwrite)
4195 {
4196 hi = hash_find(&func_hashtab, name);
4197 hi->hi_key = UF2HIKEY(fp);
4198 }
4199 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004200 {
4201 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004202 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203 goto erret;
4204 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004205 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004206 }
4207 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004208 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004209 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004210 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004211
4212 if (eap->cmdidx == CMD_def)
4213 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004214 int lnum_save = SOURCING_LNUM;
4215 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004216
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004217 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004218
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004219 // error messages are for the first function line
4220 SOURCING_LNUM = sourcing_lnum_top;
4221
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004222 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004223 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004224 int count = cstack->cs_idx + 1;
4225 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004226
4227 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004228 // a block that is visible now but not when the function is called
4229 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004230 fp->uf_block_ids = ALLOC_MULT(int, count);
4231 if (fp->uf_block_ids != NULL)
4232 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004233 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004234 sizeof(int) * count);
4235 fp->uf_block_depth = count;
4236 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004237
4238 // Set flag in each block to indicate a function was defined. This
4239 // is used to keep the variable when leaving the block, see
4240 // hide_script_var().
4241 for (i = 0; i <= cstack->cs_idx; ++i)
4242 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004243 }
4244
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004245 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004246 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004247 SOURCING_LNUM = lnum_save;
4248 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004249 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004250 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004251
4252 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004253 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004254 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004255 SOURCING_LNUM = lnum_save;
4256 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004257 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004258 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004259 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004260 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004261 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004262
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004264 if ((flags & FC_CLOSURE) != 0)
4265 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004266 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004267 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004268 }
4269 else
4270 fp->uf_scoped = NULL;
4271
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004272#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 if (prof_def_func())
4274 func_do_profile(fp);
4275#endif
4276 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004277 if (sandbox)
4278 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004279 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004280 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281 fp->uf_flags = flags;
4282 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004283 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004284 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004285 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004286 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004287 if (is_export)
4288 {
4289 fp->uf_flags |= FC_EXPORT;
4290 // let ex_export() know the export worked.
4291 is_export = FALSE;
4292 }
4293
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004294 if (eap->cmdidx == CMD_def)
4295 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004296 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4297 // :func does not use Vim9 script syntax, even in a Vim9 script file
4298 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004299
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 goto ret_free;
4301
4302erret:
4303 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004304 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004305 if (fp != NULL)
4306 {
4307 ga_init(&fp->uf_args);
4308 ga_init(&fp->uf_def_args);
4309 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310errret_2:
4311 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004312 if (fp != NULL)
4313 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004315 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004316 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004318 if (name != name_arg)
4319 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004320 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004322
4323 return fp;
4324}
4325
4326/*
4327 * ":function"
4328 */
4329 void
4330ex_function(exarg_T *eap)
4331{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004332 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004333}
4334
4335/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004336 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004337 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004338 */
4339 void
4340ex_defcompile(exarg_T *eap UNUSED)
4341{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004342 long todo = (long)func_hashtab.ht_used;
4343 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004344 hashitem_T *hi;
4345 ufunc_T *ufunc;
4346
4347 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4348 {
4349 if (!HASHITEM_EMPTY(hi))
4350 {
4351 --todo;
4352 ufunc = HI2UF(hi);
4353 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004354 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4355 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004356 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004357 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004358
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004359 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004360 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004361 // a function has been added or removed, need to start over
4362 todo = (long)func_hashtab.ht_used;
4363 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004364 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004365 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004366 }
4367 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004368 }
4369 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370}
4371
4372/*
4373 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4374 * Return 2 if "p" starts with "s:".
4375 * Return 0 otherwise.
4376 */
4377 int
4378eval_fname_script(char_u *p)
4379{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004380 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4381 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4383 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4384 return 5;
4385 if (p[0] == 's' && p[1] == ':')
4386 return 2;
4387 return 0;
4388}
4389
4390 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004391translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392{
4393 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004394 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004395 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004396}
4397
4398/*
4399 * Return TRUE when "ufunc" has old-style "..." varargs
4400 * or named varargs "...name: type".
4401 */
4402 int
4403has_varargs(ufunc_T *ufunc)
4404{
4405 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004406}
4407
4408/*
4409 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004410 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 */
4412 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004413function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414{
4415 char_u *nm = name;
4416 char_u *p;
4417 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004418 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004419 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004421 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4422 if (no_deref)
4423 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004424 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 nm = skipwhite(nm);
4426
Bram Moolenaare38eab22019-12-05 21:50:01 +01004427 // Only accept "funcname", "funcname ", "funcname (..." and
4428 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004430 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 vim_free(p);
4432 return n;
4433}
4434
Bram Moolenaar113e1072019-01-20 15:30:40 +01004435#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 char_u *
4437get_expanded_name(char_u *name, int check)
4438{
4439 char_u *nm = name;
4440 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004441 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004443 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004444 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004445
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004446 if (p != NULL && *nm == NUL
4447 && (!check || translated_function_exists(p, is_global)))
4448 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449
4450 vim_free(p);
4451 return NULL;
4452}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004453#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004454
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455/*
4456 * Function given to ExpandGeneric() to obtain the list of user defined
4457 * function names.
4458 */
4459 char_u *
4460get_user_func_name(expand_T *xp, int idx)
4461{
4462 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004463 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 static hashitem_T *hi;
4465 ufunc_T *fp;
4466
4467 if (idx == 0)
4468 {
4469 done = 0;
4470 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004471 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004473 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474 {
4475 if (done++ > 0)
4476 ++hi;
4477 while (HASHITEM_EMPTY(hi))
4478 ++hi;
4479 fp = HI2UF(hi);
4480
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004481 // don't show dead, dict and lambda functions
4482 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004483 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004484 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485
4486 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004487 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488
4489 cat_func_name(IObuff, fp);
4490 if (xp->xp_context != EXPAND_USER_FUNC)
4491 {
4492 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004493 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 STRCAT(IObuff, ")");
4495 }
4496 return IObuff;
4497 }
4498 return NULL;
4499}
4500
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501/*
4502 * ":delfunction {name}"
4503 */
4504 void
4505ex_delfunction(exarg_T *eap)
4506{
4507 ufunc_T *fp = NULL;
4508 char_u *p;
4509 char_u *name;
4510 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004511 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004512
4513 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004514 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4515 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 vim_free(fudi.fd_newkey);
4517 if (name == NULL)
4518 {
4519 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004520 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004521 return;
4522 }
4523 if (!ends_excmd(*skipwhite(p)))
4524 {
4525 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004526 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004527 return;
4528 }
4529 eap->nextcmd = check_nextcmd(p);
4530 if (eap->nextcmd != NULL)
4531 *p = NUL;
4532
4533 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004534 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 vim_free(name);
4536
4537 if (!eap->skip)
4538 {
4539 if (fp == NULL)
4540 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004541 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004542 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543 return;
4544 }
4545 if (fp->uf_calls > 0)
4546 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004547 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 return;
4549 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004550 if (fp->uf_flags & FC_VIM9)
4551 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004552 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004553 return;
4554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555
4556 if (fudi.fd_dict != NULL)
4557 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004558 // Delete the dict item that refers to the function, it will
4559 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004560 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4561 }
4562 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004563 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004564 // A normal function (not a numbered function or lambda) has a
4565 // refcount of 1 for the entry in the hashtable. When deleting
4566 // it and the refcount is more than one, it should be kept.
4567 // A numbered function and lambda should be kept if the refcount is
4568 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004569 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004570 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004571 // Function is still referenced somewhere. Don't free it but
4572 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004573 if (func_remove(fp))
4574 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004575 }
4576 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004577 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004578 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579 }
4580}
4581
4582/*
4583 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004584 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 */
4586 void
4587func_unref(char_u *name)
4588{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004589 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004591 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004593 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004594 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004597 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004599 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004601 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004602}
4603
4604/*
4605 * Unreference a Function: decrement the reference count and free it when it
4606 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004607 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004608 */
4609 void
4610func_ptr_unref(ufunc_T *fp)
4611{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004612 if (fp != NULL && (--fp->uf_refcount <= 0
4613 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4614 && fp->uf_partial->pt_refcount <= 1
4615 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004616 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004617 // Only delete it when it's not being used. Otherwise it's done
4618 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004619 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004620 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004621 }
4622}
4623
4624/*
4625 * Count a reference to a Function.
4626 */
4627 void
4628func_ref(char_u *name)
4629{
4630 ufunc_T *fp;
4631
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004632 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004634 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004635 if (fp != NULL)
4636 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004638 // Only give an error for a numbered function.
4639 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004640 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004641}
4642
4643/*
4644 * Count a reference to a Function.
4645 */
4646 void
4647func_ptr_ref(ufunc_T *fp)
4648{
4649 if (fp != NULL)
4650 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651}
4652
4653/*
4654 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4655 * referenced from anywhere that is in use.
4656 */
4657 static int
4658can_free_funccal(funccall_T *fc, int copyID)
4659{
4660 return (fc->l_varlist.lv_copyID != copyID
4661 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004662 && fc->l_avars.dv_copyID != copyID
4663 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664}
4665
4666/*
4667 * ":return [expr]"
4668 */
4669 void
4670ex_return(exarg_T *eap)
4671{
4672 char_u *arg = eap->arg;
4673 typval_T rettv;
4674 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004675 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676
4677 if (current_funccal == NULL)
4678 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004679 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 return;
4681 }
4682
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004683 CLEAR_FIELD(evalarg);
4684 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4685
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004686 if (eap->skip)
4687 ++emsg_skip;
4688
4689 eap->nextcmd = NULL;
4690 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004691 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692 {
4693 if (!eap->skip)
4694 returning = do_return(eap, FALSE, TRUE, &rettv);
4695 else
4696 clear_tv(&rettv);
4697 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004698 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 else if (!eap->skip)
4700 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004701 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004702 update_force_abort();
4703
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004704 /*
4705 * Return unless the expression evaluation has been cancelled due to an
4706 * aborting error, an interrupt, or an exception.
4707 */
4708 if (!aborting())
4709 returning = do_return(eap, FALSE, TRUE, NULL);
4710 }
4711
Bram Moolenaare38eab22019-12-05 21:50:01 +01004712 // When skipping or the return gets pending, advance to the next command
4713 // in this line (!returning). Otherwise, ignore the rest of the line.
4714 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715 if (returning)
4716 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004717 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718 eap->nextcmd = check_nextcmd(arg);
4719
4720 if (eap->skip)
4721 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004722 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723}
4724
4725/*
4726 * ":1,25call func(arg1, arg2)" function call.
4727 */
4728 void
4729ex_call(exarg_T *eap)
4730{
4731 char_u *arg = eap->arg;
4732 char_u *startarg;
4733 char_u *name;
4734 char_u *tofree;
4735 int len;
4736 typval_T rettv;
4737 linenr_T lnum;
4738 int doesrange;
4739 int failed = FALSE;
4740 funcdict_T fudi;
4741 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004742 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004743 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744
Bram Moolenaare6b53242020-07-01 17:28:33 +02004745 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 if (eap->skip)
4747 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004748 // trans_function_name() doesn't work well when skipping, use eval0()
4749 // instead to skip to any following command, e.g. for:
4750 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004752 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004753 clear_tv(&rettv);
4754 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004755 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 return;
4757 }
4758
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004759 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4760 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761 if (fudi.fd_newkey != NULL)
4762 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004763 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004764 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004765 vim_free(fudi.fd_newkey);
4766 }
4767 if (tofree == NULL)
4768 return;
4769
Bram Moolenaare38eab22019-12-05 21:50:01 +01004770 // Increase refcount on dictionary, it could get deleted when evaluating
4771 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004772 if (fudi.fd_dict != NULL)
4773 ++fudi.fd_dict->dv_refcount;
4774
Bram Moolenaare38eab22019-12-05 21:50:01 +01004775 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4776 // contents. For VAR_PARTIAL get its partial, unless we already have one
4777 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004779 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4780 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004781
Bram Moolenaare38eab22019-12-05 21:50:01 +01004782 // Skip white space to allow ":call func ()". Not good, but required for
4783 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004785 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786
4787 if (*startarg != '(')
4788 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004789 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004790 goto end;
4791 }
4792
4793 /*
4794 * When skipping, evaluate the function once, to find the end of the
4795 * arguments.
4796 * When the function takes a range, this is discovered after the first
4797 * call, and the loop is broken.
4798 */
4799 if (eap->skip)
4800 {
4801 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004802 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004803 }
4804 else
4805 lnum = eap->line1;
4806 for ( ; lnum <= eap->line2; ++lnum)
4807 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004808 funcexe_T funcexe;
4809
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810 if (!eap->skip && eap->addr_count > 0)
4811 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004812 if (lnum > curbuf->b_ml.ml_line_count)
4813 {
4814 // If the function deleted lines or switched to another buffer
4815 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004816 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004817 break;
4818 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 curwin->w_cursor.lnum = lnum;
4820 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004821 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004822 }
4823 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004824
Bram Moolenaara80faa82020-04-12 19:37:17 +02004825 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004826 funcexe.firstline = eap->line1;
4827 funcexe.lastline = eap->line2;
4828 funcexe.doesrange = &doesrange;
4829 funcexe.evaluate = !eap->skip;
4830 funcexe.partial = partial;
4831 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004832 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004833 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004834 {
4835 failed = TRUE;
4836 break;
4837 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004838 if (has_watchexpr())
4839 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004840
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004841 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004842 if (handle_subscript(&arg, &rettv,
4843 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844 {
4845 failed = TRUE;
4846 break;
4847 }
4848
4849 clear_tv(&rettv);
4850 if (doesrange || eap->skip)
4851 break;
4852
Bram Moolenaare38eab22019-12-05 21:50:01 +01004853 // Stop when immediately aborting on error, or when an interrupt
4854 // occurred or an exception was thrown but not caught.
4855 // get_func_tv() returned OK, so that the check for trailing
4856 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 if (aborting())
4858 break;
4859 }
4860 if (eap->skip)
4861 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004862 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863
Bram Moolenaare51bb172020-02-16 19:42:23 +01004864 // When inside :try we need to check for following "| catch".
4865 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004867 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004868 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004869 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004870 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004871 if (!failed)
4872 {
4873 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004874 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004875 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004876 }
4877 else
4878 eap->nextcmd = check_nextcmd(arg);
4879 }
4880
4881end:
4882 dict_unref(fudi.fd_dict);
4883 vim_free(tofree);
4884}
4885
4886/*
4887 * Return from a function. Possibly makes the return pending. Also called
4888 * for a pending return at the ":endtry" or after returning from an extra
4889 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4890 * when called due to a ":return" command. "rettv" may point to a typval_T
4891 * with the return rettv. Returns TRUE when the return can be carried out,
4892 * FALSE when the return gets pending.
4893 */
4894 int
4895do_return(
4896 exarg_T *eap,
4897 int reanimate,
4898 int is_cmd,
4899 void *rettv)
4900{
4901 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004902 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903
4904 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004905 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906 current_funccal->returned = FALSE;
4907
4908 /*
4909 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4910 * not in its finally clause (which then is to be executed next) is found.
4911 * In this case, make the ":return" pending for execution at the ":endtry".
4912 * Otherwise, return normally.
4913 */
4914 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4915 if (idx >= 0)
4916 {
4917 cstack->cs_pending[idx] = CSTP_RETURN;
4918
4919 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004920 // A pending return again gets pending. "rettv" points to an
4921 // allocated variable with the rettv of the original ":return"'s
4922 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923 cstack->cs_rettv[idx] = rettv;
4924 else
4925 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004926 // When undoing a return in order to make it pending, get the stored
4927 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004928 if (reanimate)
4929 rettv = current_funccal->rettv;
4930
4931 if (rettv != NULL)
4932 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004933 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004934 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4935 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4936 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004937 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938 }
4939 else
4940 cstack->cs_rettv[idx] = NULL;
4941
4942 if (reanimate)
4943 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004944 // The pending return value could be overwritten by a ":return"
4945 // without argument in a finally clause; reset the default
4946 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004947 current_funccal->rettv->v_type = VAR_NUMBER;
4948 current_funccal->rettv->vval.v_number = 0;
4949 }
4950 }
4951 report_make_pending(CSTP_RETURN, rettv);
4952 }
4953 else
4954 {
4955 current_funccal->returned = TRUE;
4956
Bram Moolenaare38eab22019-12-05 21:50:01 +01004957 // If the return is carried out now, store the return value. For
4958 // a return immediately after reanimation, the value is already
4959 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004960 if (!reanimate && rettv != NULL)
4961 {
4962 clear_tv(current_funccal->rettv);
4963 *current_funccal->rettv = *(typval_T *)rettv;
4964 if (!is_cmd)
4965 vim_free(rettv);
4966 }
4967 }
4968
4969 return idx < 0;
4970}
4971
4972/*
4973 * Free the variable with a pending return value.
4974 */
4975 void
4976discard_pending_return(void *rettv)
4977{
4978 free_tv((typval_T *)rettv);
4979}
4980
4981/*
4982 * Generate a return command for producing the value of "rettv". The result
4983 * is an allocated string. Used by report_pending() for verbose messages.
4984 */
4985 char_u *
4986get_return_cmd(void *rettv)
4987{
4988 char_u *s = NULL;
4989 char_u *tofree = NULL;
4990 char_u numbuf[NUMBUFLEN];
4991
4992 if (rettv != NULL)
4993 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4994 if (s == NULL)
4995 s = (char_u *)"";
4996
4997 STRCPY(IObuff, ":return ");
4998 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4999 if (STRLEN(s) + 8 >= IOSIZE)
5000 STRCPY(IObuff + IOSIZE - 4, "...");
5001 vim_free(tofree);
5002 return vim_strsave(IObuff);
5003}
5004
5005/*
5006 * Get next function line.
5007 * Called by do_cmdline() to get the next line.
5008 * Returns allocated string, or NULL for end of function.
5009 */
5010 char_u *
5011get_func_line(
5012 int c UNUSED,
5013 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005014 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005015 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016{
5017 funccall_T *fcp = (funccall_T *)cookie;
5018 ufunc_T *fp = fcp->func;
5019 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005020 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005021
Bram Moolenaare38eab22019-12-05 21:50:01 +01005022 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005023 if (fcp->dbg_tick != debug_tick)
5024 {
5025 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005026 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005027 fcp->dbg_tick = debug_tick;
5028 }
5029#ifdef FEAT_PROFILE
5030 if (do_profiling == PROF_YES)
5031 func_line_end(cookie);
5032#endif
5033
5034 gap = &fp->uf_lines;
5035 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5036 || fcp->returned)
5037 retval = NULL;
5038 else
5039 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005040 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 while (fcp->linenr < gap->ga_len
5042 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5043 ++fcp->linenr;
5044 if (fcp->linenr >= gap->ga_len)
5045 retval = NULL;
5046 else
5047 {
5048 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005049 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005050#ifdef FEAT_PROFILE
5051 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005052 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005053#endif
5054 }
5055 }
5056
Bram Moolenaare38eab22019-12-05 21:50:01 +01005057 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005058 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005059 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005060 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005061 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005062 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005063 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005064 fcp->dbg_tick = debug_tick;
5065 }
5066
5067 return retval;
5068}
5069
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005070/*
5071 * Return TRUE if the currently active function should be ended, because a
5072 * return was encountered or an error occurred. Used inside a ":while".
5073 */
5074 int
5075func_has_ended(void *cookie)
5076{
5077 funccall_T *fcp = (funccall_T *)cookie;
5078
Bram Moolenaare38eab22019-12-05 21:50:01 +01005079 // Ignore the "abort" flag if the abortion behavior has been changed due to
5080 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005081 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5082 || fcp->returned);
5083}
5084
5085/*
5086 * return TRUE if cookie indicates a function which "abort"s on errors.
5087 */
5088 int
5089func_has_abort(
5090 void *cookie)
5091{
5092 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5093}
5094
5095
5096/*
5097 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5098 * Don't do this when "Func" is already a partial that was bound
5099 * explicitly (pt_auto is FALSE).
5100 * Changes "rettv" in-place.
5101 * Returns the updated "selfdict_in".
5102 */
5103 dict_T *
5104make_partial(dict_T *selfdict_in, typval_T *rettv)
5105{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005106 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005107 char_u *tofree = NULL;
5108 ufunc_T *fp;
5109 char_u fname_buf[FLEN_FIXED + 1];
5110 int error;
5111 dict_T *selfdict = selfdict_in;
5112
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005113 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5114 fp = rettv->vval.v_partial->pt_func;
5115 else
5116 {
5117 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5118 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005119 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005120 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005121 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005122 vim_free(tofree);
5123 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124
5125 if (fp != NULL && (fp->uf_flags & FC_DICT))
5126 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005127 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128
5129 if (pt != NULL)
5130 {
5131 pt->pt_refcount = 1;
5132 pt->pt_dict = selfdict;
5133 pt->pt_auto = TRUE;
5134 selfdict = NULL;
5135 if (rettv->v_type == VAR_FUNC)
5136 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005137 // Just a function: Take over the function name and use
5138 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005139 pt->pt_name = rettv->vval.v_string;
5140 }
5141 else
5142 {
5143 partial_T *ret_pt = rettv->vval.v_partial;
5144 int i;
5145
Bram Moolenaare38eab22019-12-05 21:50:01 +01005146 // Partial: copy the function name, use selfdict and copy
5147 // args. Can't take over name or args, the partial might
5148 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005149 if (ret_pt->pt_name != NULL)
5150 {
5151 pt->pt_name = vim_strsave(ret_pt->pt_name);
5152 func_ref(pt->pt_name);
5153 }
5154 else
5155 {
5156 pt->pt_func = ret_pt->pt_func;
5157 func_ptr_ref(pt->pt_func);
5158 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159 if (ret_pt->pt_argc > 0)
5160 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005161 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005163 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005164 pt->pt_argc = 0;
5165 else
5166 {
5167 pt->pt_argc = ret_pt->pt_argc;
5168 for (i = 0; i < pt->pt_argc; i++)
5169 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5170 }
5171 }
5172 partial_unref(ret_pt);
5173 }
5174 rettv->v_type = VAR_PARTIAL;
5175 rettv->vval.v_partial = pt;
5176 }
5177 }
5178 return selfdict;
5179}
5180
5181/*
5182 * Return the name of the executed function.
5183 */
5184 char_u *
5185func_name(void *cookie)
5186{
5187 return ((funccall_T *)cookie)->func->uf_name;
5188}
5189
5190/*
5191 * Return the address holding the next breakpoint line for a funccall cookie.
5192 */
5193 linenr_T *
5194func_breakpoint(void *cookie)
5195{
5196 return &((funccall_T *)cookie)->breakpoint;
5197}
5198
5199/*
5200 * Return the address holding the debug tick for a funccall cookie.
5201 */
5202 int *
5203func_dbg_tick(void *cookie)
5204{
5205 return &((funccall_T *)cookie)->dbg_tick;
5206}
5207
5208/*
5209 * Return the nesting level for a funccall cookie.
5210 */
5211 int
5212func_level(void *cookie)
5213{
5214 return ((funccall_T *)cookie)->level;
5215}
5216
5217/*
5218 * Return TRUE when a function was ended by a ":return" command.
5219 */
5220 int
5221current_func_returned(void)
5222{
5223 return current_funccal->returned;
5224}
5225
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005226 int
5227free_unref_funccal(int copyID, int testing)
5228{
5229 int did_free = FALSE;
5230 int did_free_funccal = FALSE;
5231 funccall_T *fc, **pfc;
5232
5233 for (pfc = &previous_funccal; *pfc != NULL; )
5234 {
5235 if (can_free_funccal(*pfc, copyID))
5236 {
5237 fc = *pfc;
5238 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005239 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005240 did_free = TRUE;
5241 did_free_funccal = TRUE;
5242 }
5243 else
5244 pfc = &(*pfc)->caller;
5245 }
5246 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005247 // When a funccal was freed some more items might be garbage
5248 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249 (void)garbage_collect(testing);
5250
5251 return did_free;
5252}
5253
5254/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005255 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005256 */
5257 static funccall_T *
5258get_funccal(void)
5259{
5260 int i;
5261 funccall_T *funccal;
5262 funccall_T *temp_funccal;
5263
5264 funccal = current_funccal;
5265 if (debug_backtrace_level > 0)
5266 {
5267 for (i = 0; i < debug_backtrace_level; i++)
5268 {
5269 temp_funccal = funccal->caller;
5270 if (temp_funccal)
5271 funccal = temp_funccal;
5272 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005273 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005274 debug_backtrace_level = i;
5275 }
5276 }
5277 return funccal;
5278}
5279
5280/*
5281 * Return the hashtable used for local variables in the current funccal.
5282 * Return NULL if there is no current funccal.
5283 */
5284 hashtab_T *
5285get_funccal_local_ht()
5286{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005287 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005288 return NULL;
5289 return &get_funccal()->l_vars.dv_hashtab;
5290}
5291
5292/*
5293 * Return the l: scope variable.
5294 * Return NULL if there is no current funccal.
5295 */
5296 dictitem_T *
5297get_funccal_local_var()
5298{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005299 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005300 return NULL;
5301 return &get_funccal()->l_vars_var;
5302}
5303
5304/*
5305 * Return the hashtable used for argument in the current funccal.
5306 * Return NULL if there is no current funccal.
5307 */
5308 hashtab_T *
5309get_funccal_args_ht()
5310{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005311 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005312 return NULL;
5313 return &get_funccal()->l_avars.dv_hashtab;
5314}
5315
5316/*
5317 * Return the a: scope variable.
5318 * Return NULL if there is no current funccal.
5319 */
5320 dictitem_T *
5321get_funccal_args_var()
5322{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005323 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005324 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005325 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005326}
5327
5328/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329 * List function variables, if there is a function.
5330 */
5331 void
5332list_func_vars(int *first)
5333{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005334 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005335 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005336 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337}
5338
5339/*
5340 * If "ht" is the hashtable for local variables in the current funccal, return
5341 * the dict that contains it.
5342 * Otherwise return NULL.
5343 */
5344 dict_T *
5345get_current_funccal_dict(hashtab_T *ht)
5346{
5347 if (current_funccal != NULL
5348 && ht == &current_funccal->l_vars.dv_hashtab)
5349 return &current_funccal->l_vars;
5350 return NULL;
5351}
5352
5353/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005354 * Search hashitem in parent scope.
5355 */
5356 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005357find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005358{
5359 funccall_T *old_current_funccal = current_funccal;
5360 hashtab_T *ht;
5361 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005362 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005363
5364 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5365 return NULL;
5366
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005367 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005368 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005369 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005370 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005371 ht = find_var_ht(name, &varname);
5372 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005373 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005374 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005375 if (!HASHITEM_EMPTY(hi))
5376 {
5377 *pht = ht;
5378 break;
5379 }
5380 }
5381 if (current_funccal == current_funccal->func->uf_scoped)
5382 break;
5383 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005384 }
5385 current_funccal = old_current_funccal;
5386
5387 return hi;
5388}
5389
5390/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005391 * Search variable in parent scope.
5392 */
5393 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005394find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005395{
5396 dictitem_T *v = NULL;
5397 funccall_T *old_current_funccal = current_funccal;
5398 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005399 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005400
5401 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5402 return NULL;
5403
Bram Moolenaare38eab22019-12-05 21:50:01 +01005404 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005405 current_funccal = current_funccal->func->uf_scoped;
5406 while (current_funccal)
5407 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005408 ht = find_var_ht(name, &varname);
5409 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005410 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005411 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005412 if (v != NULL)
5413 break;
5414 }
5415 if (current_funccal == current_funccal->func->uf_scoped)
5416 break;
5417 current_funccal = current_funccal->func->uf_scoped;
5418 }
5419 current_funccal = old_current_funccal;
5420
5421 return v;
5422}
5423
5424/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005425 * Set "copyID + 1" in previous_funccal and callers.
5426 */
5427 int
5428set_ref_in_previous_funccal(int copyID)
5429{
5430 int abort = FALSE;
5431 funccall_T *fc;
5432
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005433 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005434 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005435 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005436 abort = abort
5437 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5438 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005439 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005440 }
5441 return abort;
5442}
5443
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005444 static int
5445set_ref_in_funccal(funccall_T *fc, int copyID)
5446{
5447 int abort = FALSE;
5448
5449 if (fc->fc_copyID != copyID)
5450 {
5451 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005452 abort = abort
5453 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5454 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005455 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005456 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005457 }
5458 return abort;
5459}
5460
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461/*
5462 * Set "copyID" in all local vars and arguments in the call stack.
5463 */
5464 int
5465set_ref_in_call_stack(int copyID)
5466{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005467 int abort = FALSE;
5468 funccall_T *fc;
5469 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005470
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005471 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005472 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005473
5474 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005475 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5476 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005477 abort = abort || set_ref_in_funccal(fc, copyID);
5478
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005479 return abort;
5480}
5481
5482/*
5483 * Set "copyID" in all functions available by name.
5484 */
5485 int
5486set_ref_in_functions(int copyID)
5487{
5488 int todo;
5489 hashitem_T *hi = NULL;
5490 int abort = FALSE;
5491 ufunc_T *fp;
5492
5493 todo = (int)func_hashtab.ht_used;
5494 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005495 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005496 if (!HASHITEM_EMPTY(hi))
5497 {
5498 --todo;
5499 fp = HI2UF(hi);
5500 if (!func_name_refcount(fp->uf_name))
5501 abort = abort || set_ref_in_func(NULL, fp, copyID);
5502 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005503 }
5504 return abort;
5505}
5506
5507/*
5508 * Set "copyID" in all function arguments.
5509 */
5510 int
5511set_ref_in_func_args(int copyID)
5512{
5513 int i;
5514 int abort = FALSE;
5515
5516 for (i = 0; i < funcargs.ga_len; ++i)
5517 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5518 copyID, NULL, NULL);
5519 return abort;
5520}
5521
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005522/*
5523 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005524 * Returns TRUE if setting references failed somehow.
5525 */
5526 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005527set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005528{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005529 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005530 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005531 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005532 char_u fname_buf[FLEN_FIXED + 1];
5533 char_u *tofree = NULL;
5534 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005535 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005536
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005537 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005538 return FALSE;
5539
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005540 if (fp_in == NULL)
5541 {
5542 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005543 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005544 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005545 if (fp != NULL)
5546 {
5547 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005548 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005549 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005550
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005551 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005552 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005553}
5554
Bram Moolenaare38eab22019-12-05 21:50:01 +01005555#endif // FEAT_EVAL