blob: f5d9063028a7ff9840ee7c77e05016b298ac6bd8 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020058 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020076 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010077
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020081 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010089
Bram Moolenaar057e84a2021-02-28 16:55:11 +010090 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200171 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100172 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100173 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200174 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100175 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100180 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100181 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100182 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200183 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200184 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188{
189 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100190 char_u *arg;
191 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 int any_default = FALSE;
194 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100195 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200201 if (default_args != NULL)
202 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100210 arg = skipwhite(*argp);
211 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 while (*p != endchar)
213 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200225 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100233 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200234 }
235 if (*p == endchar)
236 break;
237
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200248 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100253 }
254
255 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100256 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200257 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100258 if (p == arg)
259 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 }
267 else
268 {
269 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100270 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200271 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200273 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200274
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200275 if (*skipwhite(p) == '=' && default_args != NULL)
276 {
277 typval_T rettv;
278
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100279 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200280 any_default = TRUE;
281 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200282 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200283 p = skipwhite(p);
284 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200285 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200286 {
287 if (ga_grow(default_args, 1) == FAIL)
288 goto err_ret;
289
290 // trim trailing whitespace
291 while (p > expr && VIM_ISWHITE(p[-1]))
292 p--;
293 c = *p;
294 *p = NUL;
295 expr = vim_strsave(expr);
296 if (expr == NULL)
297 {
298 *p = c;
299 goto err_ret;
300 }
301 ((char_u **)(default_args->ga_data))
302 [default_args->ga_len] = expr;
303 default_args->ga_len++;
304 *p = c;
305 }
306 else
307 mustend = TRUE;
308 }
309 else if (any_default)
310 {
311 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200312 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200313 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200314
315 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
316 {
317 // Be tolerant when skipping
318 if (!skip)
319 {
320 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
321 goto err_ret;
322 }
323 p = skipwhite(p);
324 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200325 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200326 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200327 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200328 // Don't give this error when skipping, it makes the "->" not
329 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100330 // Allow missing space after comma in legacy functions.
331 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200332 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
333 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100334 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200335 goto err_ret;
336 }
337 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200338 else
339 mustend = TRUE;
340 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200341 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200342 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200343 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200344
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200345 if (*p != endchar)
346 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100347 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200348
349 *argp = p;
350 return OK;
351
352err_ret:
353 if (newargs != NULL)
354 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200355 if (default_args != NULL)
356 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357 return FAIL;
358}
359
360/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100361 * Parse the argument types, filling "fp->uf_arg_types".
362 * Return OK or FAIL.
363 */
364 static int
365parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
366{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200367 int len = 0;
368
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100369 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
370 if (argtypes->ga_len > 0)
371 {
372 // When "varargs" is set the last name/type goes into uf_va_name
373 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200374 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100375
376 if (len > 0)
377 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
378 if (fp->uf_arg_types != NULL)
379 {
380 int i;
381 type_T *type;
382
383 for (i = 0; i < len; ++ i)
384 {
385 char_u *p = ((char_u **)argtypes->ga_data)[i];
386
387 if (p == NULL)
388 // will get the type from the default value
389 type = &t_unknown;
390 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100391 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100392 if (type == NULL)
393 return FAIL;
394 fp->uf_arg_types[i] = type;
395 }
396 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100397 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200398
399 if (varargs)
400 {
401 char_u *p;
402
403 // Move the last argument "...name: type" to uf_va_name and
404 // uf_va_type.
405 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
406 [fp->uf_args.ga_len - 1];
407 --fp->uf_args.ga_len;
408 p = ((char_u **)argtypes->ga_data)[len];
409 if (p == NULL)
410 // TODO: get type from default value
411 fp->uf_va_type = &t_list_any;
412 else
413 {
414 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
415 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
416 {
417 semsg(_(e_variable_arguments_type_must_be_list_str),
418 ((char_u **)argtypes->ga_data)[len]);
419 return FAIL;
420 }
421 }
422 if (fp->uf_va_type == NULL)
423 return FAIL;
424 }
425
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100426 return OK;
427}
428
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100429 static int
430parse_return_type(ufunc_T *fp, char_u *ret_type)
431{
432 if (ret_type == NULL)
433 fp->uf_ret_type = &t_void;
434 else
435 {
436 char_u *p = ret_type;
437
438 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
439 if (fp->uf_ret_type == NULL)
440 {
441 fp->uf_ret_type = &t_void;
442 return FAIL;
443 }
444 }
445 return OK;
446}
447
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100448/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200449 * Register function "fp" as using "current_funccal" as its scope.
450 */
451 static int
452register_closure(ufunc_T *fp)
453{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200454 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100455 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200456 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200457 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200458 fp->uf_scoped = current_funccal;
459 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200460
Bram Moolenaar58016442016-07-31 18:30:22 +0200461 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
462 return FAIL;
463 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
464 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200465 return OK;
466}
467
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100468 static void
469set_ufunc_name(ufunc_T *fp, char_u *name)
470{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100471 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
472 // actually extends beyond the struct.
473 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100474
475 if (name[0] == K_SPECIAL)
476 {
477 fp->uf_name_exp = alloc(STRLEN(name) + 3);
478 if (fp->uf_name_exp != NULL)
479 {
480 STRCPY(fp->uf_name_exp, "<SNR>");
481 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
482 }
483 }
484}
485
Bram Moolenaar58016442016-07-31 18:30:22 +0200486/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200487 * Get a name for a lambda. Returned in static memory.
488 */
489 char_u *
490get_lambda_name(void)
491{
492 static char_u name[30];
493 static int lambda_no = 0;
494
495 sprintf((char*)name, "<lambda>%d", ++lambda_no);
496 return name;
497}
498
Bram Moolenaar801ab062020-06-25 19:27:56 +0200499#if defined(FEAT_LUA) || defined(PROTO)
500/*
501 * Registers a native C callback which can be called from Vim script.
502 * Returns the name of the Vim script function.
503 */
504 char_u *
505register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
506{
507 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200508 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200509
510 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
511 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200512 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200513
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200514 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200515 fp->uf_refcount = 1;
516 fp->uf_varargs = TRUE;
517 fp->uf_flags = FC_CFUNC;
518 fp->uf_calls = 0;
519 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200520 fp->uf_cb = cb;
521 fp->uf_cb_free = cb_free;
522 fp->uf_cb_state = state;
523
524 set_ufunc_name(fp, name);
525 hash_add(&func_hashtab, UF2HIKEY(fp));
526
527 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200528}
529#endif
530
Bram Moolenaar04b12692020-05-04 23:24:44 +0200531/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100532 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100533 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100534 * If "white_error" is not NULL check for correct use of white space and set
535 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100536 * Return NULL if no valid arrow found.
537 */
538 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100539skip_arrow(
540 char_u *start,
541 int equal_arrow,
542 char_u **ret_type,
543 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100544{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100545 char_u *s = start;
546 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100547
548 if (equal_arrow)
549 {
550 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100551 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100552 if (white_error != NULL && !VIM_ISWHITE(s[1]))
553 {
554 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100555 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100556 return NULL;
557 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100558 s = skipwhite(s + 1);
559 *ret_type = s;
560 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100561 if (s == *ret_type)
562 {
563 emsg(_(e_missing_return_type));
564 return NULL;
565 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100566 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100567 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100568 s = skipwhite(s);
569 if (*s != '=')
570 return NULL;
571 ++s;
572 }
573 if (*s != '>')
574 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100575 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
576 || !IS_WHITE_OR_NUL(s[1])))
577 {
578 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100579 semsg(_(e_white_space_required_before_and_after_str_at_str),
580 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100581 return NULL;
582 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100583 return skipwhite(s + 1);
584}
585
586/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100587 * Check if "*cmd" points to a function command and if so advance "*cmd" and
588 * return TRUE.
589 * Otherwise return FALSE;
590 * Do not consider "function(" to be a command.
591 */
592 static int
593is_function_cmd(char_u **cmd)
594{
595 char_u *p = *cmd;
596
597 if (checkforcmd(&p, "function", 2))
598 {
599 if (*p == '(')
600 return FALSE;
601 *cmd = p;
602 return TRUE;
603 }
604 return FALSE;
605}
606
607/*
608 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200609 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100610 * "newlines" must already have been initialized.
611 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
612 */
613 static int
614get_function_body(
615 exarg_T *eap,
616 garray_T *newlines,
617 char_u *line_arg_in,
618 char_u **line_to_free)
619{
620 linenr_T sourcing_lnum_top = SOURCING_LNUM;
621 linenr_T sourcing_lnum_off;
622 int saved_wait_return = need_wait_return;
623 char_u *line_arg = line_arg_in;
624 int vim9_function = eap->cmdidx == CMD_def
625 || eap->cmdidx == CMD_block;
626#define MAX_FUNC_NESTING 50
627 char nesting_def[MAX_FUNC_NESTING];
628 int nesting = 0;
629 getline_opt_T getline_options;
630 int indent = 2;
631 char_u *skip_until = NULL;
632 int ret = FAIL;
633 int is_heredoc = FALSE;
634 char_u *heredoc_trimmed = NULL;
635
636 // Detect having skipped over comment lines to find the return
637 // type. Add NULL lines to keep the line count correct.
638 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
639 if (SOURCING_LNUM < sourcing_lnum_off)
640 {
641 sourcing_lnum_off -= SOURCING_LNUM;
642 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
643 goto theend;
644 while (sourcing_lnum_off-- > 0)
645 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
646 }
647
648 nesting_def[nesting] = vim9_function;
649 getline_options = vim9_function
650 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
651 for (;;)
652 {
653 char_u *theline;
654 char_u *p;
655 char_u *arg;
656
657 if (KeyTyped)
658 {
659 msg_scroll = TRUE;
660 saved_wait_return = FALSE;
661 }
662 need_wait_return = FALSE;
663
664 if (line_arg != NULL)
665 {
666 // Use eap->arg, split up in parts by line breaks.
667 theline = line_arg;
668 p = vim_strchr(theline, '\n');
669 if (p == NULL)
670 line_arg += STRLEN(line_arg);
671 else
672 {
673 *p = NUL;
674 line_arg = p + 1;
675 }
676 }
677 else
678 {
679 vim_free(*line_to_free);
680 if (eap->getline == NULL)
681 theline = getcmdline(':', 0L, indent, getline_options);
682 else
683 theline = eap->getline(':', eap->cookie, indent,
684 getline_options);
685 *line_to_free = theline;
686 }
687 if (KeyTyped)
688 lines_left = Rows - 1;
689 if (theline == NULL)
690 {
691 // Use the start of the function for the line number.
692 SOURCING_LNUM = sourcing_lnum_top;
693 if (skip_until != NULL)
694 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
695 else if (eap->cmdidx == CMD_def)
696 emsg(_(e_missing_enddef));
697 else if (eap->cmdidx == CMD_block)
698 emsg(_(e_missing_end_block));
699 else
700 emsg(_("E126: Missing :endfunction"));
701 goto theend;
702 }
703
704 // Detect line continuation: SOURCING_LNUM increased more than one.
705 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
706 if (SOURCING_LNUM < sourcing_lnum_off)
707 sourcing_lnum_off -= SOURCING_LNUM;
708 else
709 sourcing_lnum_off = 0;
710
711 if (skip_until != NULL)
712 {
713 // Don't check for ":endfunc"/":enddef" between
714 // * ":append" and "."
715 // * ":python <<EOF" and "EOF"
716 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
717 if (heredoc_trimmed == NULL
718 || (is_heredoc && skipwhite(theline) == theline)
719 || STRNCMP(theline, heredoc_trimmed,
720 STRLEN(heredoc_trimmed)) == 0)
721 {
722 if (heredoc_trimmed == NULL)
723 p = theline;
724 else if (is_heredoc)
725 p = skipwhite(theline) == theline
726 ? theline : theline + STRLEN(heredoc_trimmed);
727 else
728 p = theline + STRLEN(heredoc_trimmed);
729 if (STRCMP(p, skip_until) == 0)
730 {
731 VIM_CLEAR(skip_until);
732 VIM_CLEAR(heredoc_trimmed);
733 getline_options = vim9_function
734 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
735 is_heredoc = FALSE;
736 }
737 }
738 }
739 else
740 {
741 int c;
742
743 // skip ':' and blanks
744 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
745 ;
746
747 // Check for "endfunction", "enddef" or "}".
748 // When a ":" follows it must be a dict key; "enddef: value,"
749 if ((nesting == 0 && eap->cmdidx == CMD_block)
750 ? *p == '}'
751 : (checkforcmd(&p, nesting_def[nesting]
752 ? "enddef" : "endfunction", 4)
753 && *p != ':'))
754 {
755 if (nesting-- == 0)
756 {
757 char_u *nextcmd = NULL;
758
759 if (*p == '|' || *p == '}')
760 nextcmd = p + 1;
761 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
762 nextcmd = line_arg;
763 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100764 && (vim9_function || p_verbose > 0))
765 {
766 if (eap->cmdidx == CMD_def)
767 semsg(_(e_text_found_after_enddef_str), p);
768 else
769 give_warning2((char_u *)
770 _("W22: Text found after :endfunction: %s"),
771 p, TRUE);
772 }
773 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100774 {
775 // Another command follows. If the line came from "eap"
776 // we can simply point into it, otherwise we need to
777 // change "eap->cmdlinep".
778 eap->nextcmd = nextcmd;
779 if (*line_to_free != NULL)
780 {
781 vim_free(*eap->cmdlinep);
782 *eap->cmdlinep = *line_to_free;
783 *line_to_free = NULL;
784 }
785 }
786 break;
787 }
788 }
789
790 // Check for mismatched "endfunc" or "enddef".
791 // We don't check for "def" inside "func" thus we also can't check
792 // for "enddef".
793 // We continue to find the end of the function, although we might
794 // not find it.
795 else if (nesting_def[nesting])
796 {
797 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
798 emsg(_(e_mismatched_endfunction));
799 }
800 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
801 emsg(_(e_mismatched_enddef));
802
803 // Increase indent inside "if", "while", "for" and "try", decrease
804 // at "end".
805 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
806 indent -= 2;
807 else if (STRNCMP(p, "if", 2) == 0
808 || STRNCMP(p, "wh", 2) == 0
809 || STRNCMP(p, "for", 3) == 0
810 || STRNCMP(p, "try", 3) == 0)
811 indent += 2;
812
813 // Check for defining a function inside this function.
814 // Only recognize "def" inside "def", not inside "function",
815 // For backwards compatibility, see Test_function_python().
816 c = *p;
817 if (is_function_cmd(&p)
818 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
819 {
820 if (*p == '!')
821 p = skipwhite(p + 1);
822 p += eval_fname_script(p);
823 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
824 NULL, NULL));
825 if (*skipwhite(p) == '(')
826 {
827 if (nesting == MAX_FUNC_NESTING - 1)
828 emsg(_(e_function_nesting_too_deep));
829 else
830 {
831 ++nesting;
832 nesting_def[nesting] = (c == 'd');
833 indent += 2;
834 }
835 }
836 }
837
838 // Check for ":append", ":change", ":insert". Not for :def.
839 p = skip_range(p, FALSE, NULL);
840 if (!vim9_function
841 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
842 || (p[0] == 'c'
843 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
844 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
845 && (STRNCMP(&p[3], "nge", 3) != 0
846 || !ASCII_ISALPHA(p[6])))))))
847 || (p[0] == 'i'
848 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
849 && (!ASCII_ISALPHA(p[2])
850 || (p[2] == 's'
851 && (!ASCII_ISALPHA(p[3])
852 || p[3] == 'e'))))))))
853 skip_until = vim_strsave((char_u *)".");
854
855 // Check for ":python <<EOF", ":tcl <<EOF", etc.
856 arg = skipwhite(skiptowhite(p));
857 if (arg[0] == '<' && arg[1] =='<'
858 && ((p[0] == 'p' && p[1] == 'y'
859 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
860 || ((p[2] == '3' || p[2] == 'x')
861 && !ASCII_ISALPHA(p[3]))))
862 || (p[0] == 'p' && p[1] == 'e'
863 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
864 || (p[0] == 't' && p[1] == 'c'
865 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
866 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
867 && !ASCII_ISALPHA(p[3]))
868 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
869 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
870 || (p[0] == 'm' && p[1] == 'z'
871 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
872 ))
873 {
874 // ":python <<" continues until a dot, like ":append"
875 p = skipwhite(arg + 2);
876 if (STRNCMP(p, "trim", 4) == 0)
877 {
878 // Ignore leading white space.
879 p = skipwhite(p + 4);
880 heredoc_trimmed = vim_strnsave(theline,
881 skipwhite(theline) - theline);
882 }
883 if (*p == NUL)
884 skip_until = vim_strsave((char_u *)".");
885 else
886 skip_until = vim_strnsave(p, skiptowhite(p) - p);
887 getline_options = GETLINE_NONE;
888 is_heredoc = TRUE;
889 }
890
891 // Check for ":cmd v =<< [trim] EOF"
892 // and ":cmd [a, b] =<< [trim] EOF"
893 // and "lines =<< [trim] EOF" for Vim9
894 // Where "cmd" can be "let", "var", "final" or "const".
895 arg = skipwhite(skiptowhite(p));
896 if (*arg == '[')
897 arg = vim_strchr(arg, ']');
898 if (arg != NULL)
899 {
900 int found = (eap->cmdidx == CMD_def && arg[0] == '='
901 && arg[1] == '<' && arg[2] =='<');
902
903 if (!found)
904 // skip over the argument after "cmd"
905 arg = skipwhite(skiptowhite(arg));
906 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
907 && (checkforcmd(&p, "let", 2)
908 || checkforcmd(&p, "var", 3)
909 || checkforcmd(&p, "final", 5)
910 || checkforcmd(&p, "const", 5))))
911 {
912 p = skipwhite(arg + 3);
913 if (STRNCMP(p, "trim", 4) == 0)
914 {
915 // Ignore leading white space.
916 p = skipwhite(p + 4);
917 heredoc_trimmed = vim_strnsave(theline,
918 skipwhite(theline) - theline);
919 }
920 skip_until = vim_strnsave(p, skiptowhite(p) - p);
921 getline_options = GETLINE_NONE;
922 is_heredoc = TRUE;
923 }
924 }
925 }
926
927 // Add the line to the function.
928 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
929 goto theend;
930
931 // Copy the line to newly allocated memory. get_one_sourceline()
932 // allocates 250 bytes per line, this saves 80% on average. The cost
933 // is an extra alloc/free.
934 p = vim_strsave(theline);
935 if (p == NULL)
936 goto theend;
937 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
938
939 // Add NULL lines for continuation lines, so that the line count is
940 // equal to the index in the growarray.
941 while (sourcing_lnum_off-- > 0)
942 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
943
944 // Check for end of eap->arg.
945 if (line_arg != NULL && *line_arg == NUL)
946 line_arg = NULL;
947 }
948
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200949 // Return OK when no error was detected.
950 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100951 ret = OK;
952
953theend:
954 vim_free(skip_until);
955 vim_free(heredoc_trimmed);
956 need_wait_return |= saved_wait_return;
957 return ret;
958}
959
960/*
961 * Handle the body of a lambda. *arg points to the "{", process statements
962 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200963 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100964 * When successful "rettv" is set to a funcref.
965 */
966 static int
967lambda_function_body(
968 char_u **arg,
969 typval_T *rettv,
970 evalarg_T *evalarg,
971 garray_T *newargs,
972 garray_T *argtypes,
973 int varargs,
974 garray_T *default_args,
975 char_u *ret_type)
976{
Bram Moolenaarfed9e832021-04-10 21:38:38 +0200977 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200978 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +0200979 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +0100980 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100981 exarg_T eap;
982 garray_T newlines;
983 char_u *cmdline = NULL;
984 int ret = FAIL;
985 char_u *line_to_free = NULL;
986 partial_T *pt;
987 char_u *name;
988 int lnum_save = -1;
989 linenr_T sourcing_lnum_top = SOURCING_LNUM;
990
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100991 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
992 {
993 semsg(_(e_trailing_arg), *arg + 1);
994 return FAIL;
995 }
996
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 CLEAR_FIELD(eap);
998 eap.cmdidx = CMD_block;
999 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001000 eap.cmdlinep = &cmdline;
1001 eap.skip = !evaluate;
1002 if (evalarg->eval_cctx != NULL)
1003 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1004 else
1005 {
1006 eap.getline = evalarg->eval_getline;
1007 eap.cookie = evalarg->eval_cookie;
1008 }
1009
1010 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1011 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001012 {
1013 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001014 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001015 }
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001016
1017 // When inside a lambda must add the function lines to evalarg.eval_ga.
1018 evalarg->eval_break_count += newlines.ga_len;
1019 if (gap->ga_itemsize > 0)
1020 {
1021 int idx;
1022 char_u *last;
1023 size_t plen;
1024 char_u *pnl;
1025
1026 for (idx = 0; idx < newlines.ga_len; ++idx)
1027 {
1028 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1029
Bram Moolenaarecb66452021-05-18 15:09:18 +02001030 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001031 goto erret;
1032
1033 // Going to concatenate the lines after parsing. For an empty or
1034 // comment line use an empty string.
1035 // Insert NL characters at the start of each line, the string will
1036 // be split again later in .get_lambda_tv().
1037 if (*p == NUL || vim9_comment_start(p))
1038 p = (char_u *)"";
1039 plen = STRLEN(p);
1040 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1041 if (pnl != NULL)
1042 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001043 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1044 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001045 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001046 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001047 goto erret;
1048 if (cmdline != NULL)
1049 // more is following after the "}", which was skipped
1050 last = cmdline;
1051 else
1052 // nothing is following the "}"
1053 last = (char_u *)"}";
1054 plen = STRLEN(last);
1055 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1056 if (pnl != NULL)
1057 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001058 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1059 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001060 }
1061
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001062 if (cmdline != NULL)
1063 {
1064 // Something comes after the "}".
1065 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001066
1067 // "arg" points into cmdline, need to keep the line and free it later.
1068 vim_free(evalarg->eval_tofree_cmdline);
1069 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001070 }
1071 else
1072 *arg = (char_u *)"";
1073
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001074 if (!evaluate)
1075 {
1076 ret = OK;
1077 goto erret;
1078 }
1079
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 name = get_lambda_name();
1081 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1082 if (ufunc == NULL)
1083 goto erret;
1084 set_ufunc_name(ufunc, name);
1085 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001086 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001087 ufunc->uf_refcount = 1;
1088 ufunc->uf_args = *newargs;
1089 newargs->ga_data = NULL;
1090 ufunc->uf_def_args = *default_args;
1091 default_args->ga_data = NULL;
1092 ufunc->uf_func_type = &t_func_any;
1093
1094 // error messages are for the first function line
1095 lnum_save = SOURCING_LNUM;
1096 SOURCING_LNUM = sourcing_lnum_top;
1097
1098 // parse argument types
1099 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1100 {
1101 SOURCING_LNUM = lnum_save;
1102 goto erret;
1103 }
1104
1105 // parse the return type, if any
1106 if (parse_return_type(ufunc, ret_type) == FAIL)
1107 goto erret;
1108
1109 pt = ALLOC_CLEAR_ONE(partial_T);
1110 if (pt == NULL)
1111 goto erret;
1112 pt->pt_func = ufunc;
1113 pt->pt_refcount = 1;
1114
1115 ufunc->uf_lines = newlines;
1116 newlines.ga_data = NULL;
1117 if (sandbox)
1118 ufunc->uf_flags |= FC_SANDBOX;
1119 if (!ASCII_ISUPPER(*ufunc->uf_name))
1120 ufunc->uf_flags |= FC_VIM9;
1121 ufunc->uf_script_ctx = current_sctx;
1122 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1123 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1124 set_function_type(ufunc);
1125
1126 rettv->vval.v_partial = pt;
1127 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001128 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001129 ret = OK;
1130
1131erret:
1132 if (lnum_save >= 0)
1133 SOURCING_LNUM = lnum_save;
1134 vim_free(line_to_free);
1135 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001136 if (newargs != NULL)
1137 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001138 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001139 if (ufunc != NULL)
1140 {
1141 func_clear(ufunc, TRUE);
1142 func_free(ufunc, TRUE);
1143 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001144 return ret;
1145}
1146
1147/*
1148 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001149 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001150 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001151 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1152 */
1153 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001154get_lambda_tv(
1155 char_u **arg,
1156 typval_T *rettv,
1157 int types_optional,
1158 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001159{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001160 int evaluate = evalarg != NULL
1161 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001162 garray_T newargs;
1163 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001164 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001165 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001166 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001167 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001168 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001169 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001170 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001171 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001172 char_u *s;
1173 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001174 int *old_eval_lavars = eval_lavars_used;
1175 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001176 char_u *tofree1 = NULL;
1177 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001178 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001179 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001180 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001181
1182 if (equal_arrow && !in_vim9script())
1183 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001184
1185 ga_init(&newargs);
1186 ga_init(&newlines);
1187
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001188 // First, check if this is really a lambda expression. "->" or "=>" must
1189 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001190 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001191 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001192 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001193 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001194 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001195 {
1196 if (types_optional)
1197 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001198 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001199 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001200
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001201 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001202 if (evaluate)
1203 pnewargs = &newargs;
1204 else
1205 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001206 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001207 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001208 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001209 &varargs, &default_args,
1210 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001211 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001212 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001213 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001214 {
1215 if (types_optional)
1216 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001217 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001218 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001219 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001220 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001221
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001222 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1223 if (ret_type != NULL)
1224 {
1225 ret_type = vim_strsave(ret_type);
1226 tofree2 = ret_type;
1227 }
1228
Bram Moolenaare38eab22019-12-05 21:50:01 +01001229 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001230 if (evaluate)
1231 eval_lavars_used = &eval_lavars;
1232
Bram Moolenaar65c44152020-12-24 15:14:01 +01001233 *arg = skipwhite_and_linebreak(*arg, evalarg);
1234
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001235 // Recognize "{" as the start of a function body.
1236 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001237 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001238 if (evalarg == NULL)
1239 // cannot happen?
1240 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001241 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1242 types_optional ? &argtypes : NULL, varargs,
1243 &default_args, ret_type) == FAIL)
1244 goto errret;
1245 goto theend;
1246 }
1247 if (default_args.ga_len > 0)
1248 {
1249 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001250 goto errret;
1251 }
1252
Bram Moolenaare38eab22019-12-05 21:50:01 +01001253 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001254 start = *arg;
1255 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001256 if (ret == FAIL)
1257 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001258 if (evalarg != NULL)
1259 {
1260 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001261 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001262 evalarg->eval_tofree = NULL;
1263 }
1264
Bram Moolenaar65c44152020-12-24 15:14:01 +01001265 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001266 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001267 *arg = skipwhite_and_linebreak(*arg, evalarg);
1268 if (**arg != '}')
1269 {
1270 semsg(_("E451: Expected }: %s"), *arg);
1271 goto errret;
1272 }
1273 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001274 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001275
1276 if (evaluate)
1277 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001278 int len;
1279 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001280 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001281 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001282 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001283
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001284 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 if (fp == NULL)
1286 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001287 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001288 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001289 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001290 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001292 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1293 if (ga_grow(&newlines, 1) == FAIL)
1294 goto errret;
1295
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001296 // If there are line breaks, we need to split up the string.
1297 line_end = vim_strchr(start, '\n');
1298 if (line_end == NULL)
1299 line_end = end;
1300
1301 // Add "return " before the expression (or the first line).
1302 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001303 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001304 if (p == NULL)
1305 goto errret;
1306 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1307 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001308 vim_strncpy(p + 7, start, line_end - start);
1309
1310 if (line_end != end)
1311 {
1312 // Add more lines, split by line breaks. Thus is used when a
1313 // lambda with { cmds } is encountered.
1314 while (*line_end == '\n')
1315 {
1316 if (ga_grow(&newlines, 1) == FAIL)
1317 goto errret;
1318 start = line_end + 1;
1319 line_end = vim_strchr(start, '\n');
1320 if (line_end == NULL)
1321 line_end = end;
1322 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1323 vim_strnsave(start, line_end - start);
1324 }
1325 }
1326
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001327 if (strstr((char *)p + 7, "a:") == NULL)
1328 // No a: variables are used for sure.
1329 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001330
1331 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001332 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001333 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001334 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 if (types_optional)
1336 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001337 if (parse_argument_types(fp, &argtypes,
1338 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001339 goto errret;
1340 if (ret_type != NULL)
1341 {
1342 fp->uf_ret_type = parse_type(&ret_type,
1343 &fp->uf_type_list, TRUE);
1344 if (fp->uf_ret_type == NULL)
1345 goto errret;
1346 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001347 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001348 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001349 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001350
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001351 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001352 if (current_funccal != NULL && eval_lavars)
1353 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001354 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001355 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001356 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001357 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001358
1359#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 if (prof_def_func())
1361 func_do_profile(fp);
1362#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001363 if (sandbox)
1364 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001365 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001366 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1367 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001368 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001370 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001371 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001373 pt->pt_func = fp;
1374 pt->pt_refcount = 1;
1375 rettv->vval.v_partial = pt;
1376 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001377
1378 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001381theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001382 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001383 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001384 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001385 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001386 vim_free(tofree1);
1387 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001388 if (types_optional)
1389 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001390 return OK;
1391
1392errret:
1393 ga_clear_strings(&newargs);
1394 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001395 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001396 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001397 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001398 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001399 if (fp != NULL)
1400 vim_free(fp->uf_arg_types);
1401 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001402 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001403 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001404 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001405 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001406 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001407 vim_free(tofree1);
1408 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001409 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001410 return FAIL;
1411}
1412
1413/*
1414 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1415 * name it contains, otherwise return "name".
1416 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1417 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001418 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1419 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001420 */
1421 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001422deref_func_name(
1423 char_u *name,
1424 int *lenp,
1425 partial_T **partialp,
1426 type_T **type,
1427 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001428{
1429 dictitem_T *v;
1430 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001431 char_u *s = NULL;
1432 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433
1434 if (partialp != NULL)
1435 *partialp = NULL;
1436
1437 cc = name[*lenp];
1438 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001439 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001441 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001442 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001443 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001445 if (v->di_tv.vval.v_string == NULL)
1446 {
1447 *lenp = 0;
1448 return (char_u *)""; // just in case
1449 }
1450 s = v->di_tv.vval.v_string;
1451 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001453
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001454 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001456 partial_T *pt = v->di_tv.vval.v_partial;
1457
1458 if (pt == NULL)
1459 {
1460 *lenp = 0;
1461 return (char_u *)""; // just in case
1462 }
1463 if (partialp != NULL)
1464 *partialp = pt;
1465 s = partial_name(pt);
1466 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001467 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001468
1469 if (s != NULL)
1470 {
1471 if (type != NULL && ht == get_script_local_ht())
1472 {
1473 svar_T *sv = find_typval_in_script(&v->di_tv);
1474
1475 if (sv != NULL)
1476 *type = sv->sv_type;
1477 }
1478 return s;
1479 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 }
1481
1482 return name;
1483}
1484
1485/*
1486 * Give an error message with a function name. Handle <SNR> things.
1487 * "ermsg" is to be passed without translation, use N_() instead of _().
1488 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001489 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001490emsg_funcname(char *ermsg, char_u *name)
1491{
1492 char_u *p;
1493
1494 if (*name == K_SPECIAL)
1495 p = concat_str((char_u *)"<SNR>", name + 3);
1496 else
1497 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001498 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499 if (p != name)
1500 vim_free(p);
1501}
1502
1503/*
1504 * Allocate a variable for the result of a function.
1505 * Return OK or FAIL.
1506 */
1507 int
1508get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001509 char_u *name, // name of the function
1510 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001512 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001513 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001514 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515{
1516 char_u *argp;
1517 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001518 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1519 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001520 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001521
1522 /*
1523 * Get the arguments.
1524 */
1525 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001526 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1527 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001529 // skip the '(' or ',' and possibly line breaks
1530 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1531
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 if (*argp == ')' || *argp == ',' || *argp == NUL)
1533 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001534 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001535 {
1536 ret = FAIL;
1537 break;
1538 }
1539 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001540 // The comma should come right after the argument, but this wasn't
1541 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001542 if (vim9script)
1543 {
1544 if (*argp != ',' && *skipwhite(argp) == ',')
1545 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001546 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001547 ret = FAIL;
1548 break;
1549 }
1550 }
1551 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001552 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 if (*argp != ',')
1554 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001555 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1556 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001557 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001558 ret = FAIL;
1559 break;
1560 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001562 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563 if (*argp == ')')
1564 ++argp;
1565 else
1566 ret = FAIL;
1567
1568 if (ret == OK)
1569 {
1570 int i = 0;
1571
1572 if (get_vim_var_nr(VV_TESTING))
1573 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001574 // Prepare for calling test_garbagecollect_now(), need to know
1575 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 if (funcargs.ga_itemsize == 0)
1577 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1578 for (i = 0; i < argcount; ++i)
1579 if (ga_grow(&funcargs, 1) == OK)
1580 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1581 &argvars[i];
1582 }
1583
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001584 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001585
1586 funcargs.ga_len -= i;
1587 }
1588 else if (!aborting())
1589 {
1590 if (argcount == MAX_FUNC_ARGS)
1591 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1592 else
1593 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1594 }
1595
1596 while (--argcount >= 0)
1597 clear_tv(&argvars[argcount]);
1598
Bram Moolenaar8294d492020-08-10 22:40:56 +02001599 if (in_vim9script())
1600 *arg = argp;
1601 else
1602 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603 return ret;
1604}
1605
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001606/*
1607 * Return TRUE if "p" starts with "<SID>" or "s:".
1608 * Only works if eval_fname_script() returned non-zero for "p"!
1609 */
1610 static int
1611eval_fname_sid(char_u *p)
1612{
1613 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1614}
1615
1616/*
1617 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1618 * Change <SNR>123_name() to K_SNR 123_name().
1619 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1620 * (slow).
1621 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001622 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1624{
1625 int llen;
1626 char_u *fname;
1627 int i;
1628
1629 llen = eval_fname_script(name);
1630 if (llen > 0)
1631 {
1632 fname_buf[0] = K_SPECIAL;
1633 fname_buf[1] = KS_EXTRA;
1634 fname_buf[2] = (int)KE_SNR;
1635 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001636 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001638 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001639 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 else
1641 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001642 sprintf((char *)fname_buf + 3, "%ld_",
1643 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644 i = (int)STRLEN(fname_buf);
1645 }
1646 }
1647 if (i + STRLEN(name + llen) < FLEN_FIXED)
1648 {
1649 STRCPY(fname_buf + i, name + llen);
1650 fname = fname_buf;
1651 }
1652 else
1653 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001654 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001655 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001656 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 else
1658 {
1659 *tofree = fname;
1660 mch_memmove(fname, fname_buf, (size_t)i);
1661 STRCPY(fname + i, name + llen);
1662 }
1663 }
1664 }
1665 else
1666 fname = name;
1667 return fname;
1668}
1669
1670/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001671 * Find a function "name" in script "sid".
1672 */
1673 static ufunc_T *
1674find_func_with_sid(char_u *name, int sid)
1675{
1676 hashitem_T *hi;
1677 char_u buffer[200];
1678
1679 buffer[0] = K_SPECIAL;
1680 buffer[1] = KS_EXTRA;
1681 buffer[2] = (int)KE_SNR;
1682 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1683 (long)sid, name);
1684 hi = hash_find(&func_hashtab, buffer);
1685 if (!HASHITEM_EMPTY(hi))
1686 return HI2UF(hi);
1687
1688 return NULL;
1689}
1690
1691/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001693 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694 * Return NULL for unknown function.
1695 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001696 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001697find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001698{
1699 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001700 ufunc_T *func;
1701 imported_T *imported;
1702
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001703 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001704 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001705 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001706 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001707 int find_script_local = in_vim9script()
1708 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001709
Bram Moolenaar95006e32020-08-29 17:47:08 +02001710 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001711 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001712 // Find script-local function before global one.
1713 func = find_func_with_sid(name, current_sctx.sc_sid);
1714 if (func != NULL)
1715 return func;
1716 }
1717
Bram Moolenaarefa94442020-08-08 22:16:00 +02001718 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001719 && name[1] == KS_EXTRA
1720 && name[2] == KE_SNR)
1721 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001722 // Caller changes s: to <SNR>99_name.
1723
1724 after_script = name + 3;
1725 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001726 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001727 ++after_script;
1728 else
1729 after_script = NULL;
1730 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001731 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001732 {
1733 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001734 if (after_script != NULL && sid != current_sctx.sc_sid)
1735 imported = find_imported_in_script(after_script, 0, sid);
1736 else
1737 imported = find_imported(after_script == NULL
1738 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001739 if (imported != NULL && imported->imp_funcname != NULL)
1740 {
1741 hi = hash_find(&func_hashtab, imported->imp_funcname);
1742 if (!HASHITEM_EMPTY(hi))
1743 return HI2UF(hi);
1744 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001745 }
1746 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001747
Bram Moolenaara26b9702020-04-18 19:53:28 +02001748 hi = hash_find(&func_hashtab,
1749 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750 if (!HASHITEM_EMPTY(hi))
1751 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001752
1753 return NULL;
1754}
1755
1756/*
1757 * Find a function by name, return pointer to it in ufuncs.
1758 * "cctx" is passed in a :def function to find imported functions.
1759 * Return NULL for unknown or dead function.
1760 */
1761 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001762find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001763{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001764 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001765
1766 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1767 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001768 return NULL;
1769}
1770
1771/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001772 * Return TRUE if "ufunc" is a global function.
1773 */
1774 int
1775func_is_global(ufunc_T *ufunc)
1776{
1777 return ufunc->uf_name[0] != K_SPECIAL;
1778}
1779
1780/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001781 * Copy the function name of "fp" to buffer "buf".
1782 * "buf" must be able to hold the function name plus three bytes.
1783 * Takes care of script-local function names.
1784 */
1785 static void
1786cat_func_name(char_u *buf, ufunc_T *fp)
1787{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001788 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789 {
1790 STRCPY(buf, "<SNR>");
1791 STRCAT(buf, fp->uf_name + 3);
1792 }
1793 else
1794 STRCPY(buf, fp->uf_name);
1795}
1796
1797/*
1798 * Add a number variable "name" to dict "dp" with value "nr".
1799 */
1800 static void
1801add_nr_var(
1802 dict_T *dp,
1803 dictitem_T *v,
1804 char *name,
1805 varnumber_T nr)
1806{
1807 STRCPY(v->di_key, name);
1808 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1809 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1810 v->di_tv.v_type = VAR_NUMBER;
1811 v->di_tv.v_lock = VAR_FIXED;
1812 v->di_tv.vval.v_number = nr;
1813}
1814
1815/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001816 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001817 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001818 static void
1819free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001821 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001822
1823 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1824 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001825 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001826
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001827 // When garbage collecting a funccall_T may be freed before the
1828 // function that references it, clear its uf_scoped field.
1829 // The function may have been redefined and point to another
1830 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001831 if (fp != NULL && fp->uf_scoped == fc)
1832 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001833 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001834 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001835
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001836 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837 vim_free(fc);
1838}
1839
1840/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001841 * Free "fc" and what it contains.
1842 * Can be called only when "fc" is kept beyond the period of it called,
1843 * i.e. after cleanup_function_call(fc).
1844 */
1845 static void
1846free_funccal_contents(funccall_T *fc)
1847{
1848 listitem_T *li;
1849
1850 // Free all l: variables.
1851 vars_clear(&fc->l_vars.dv_hashtab);
1852
1853 // Free all a: variables.
1854 vars_clear(&fc->l_avars.dv_hashtab);
1855
1856 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001857 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001858 clear_tv(&li->li_tv);
1859
1860 free_funccal(fc);
1861}
1862
1863/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001864 * Handle the last part of returning from a function: free the local hashtable.
1865 * Unless it is still in use by a closure.
1866 */
1867 static void
1868cleanup_function_call(funccall_T *fc)
1869{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001870 int may_free_fc = fc->fc_refcount <= 0;
1871 int free_fc = TRUE;
1872
Bram Moolenaar6914c642017-04-01 21:21:30 +02001873 current_funccal = fc->caller;
1874
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001875 // Free all l: variables if not referred.
1876 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1877 vars_clear(&fc->l_vars.dv_hashtab);
1878 else
1879 free_fc = FALSE;
1880
1881 // If the a:000 list and the l: and a: dicts are not referenced and
1882 // there is no closure using it, we can free the funccall_T and what's
1883 // in it.
1884 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1885 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001886 else
1887 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001888 int todo;
1889 hashitem_T *hi;
1890 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001891
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001892 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001893
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001894 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001895 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1896 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1897 {
1898 if (!HASHITEM_EMPTY(hi))
1899 {
1900 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001901 di = HI2DI(hi);
1902 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001903 }
1904 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001905 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001906
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001907 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1908 fc->l_varlist.lv_first = NULL;
1909 else
1910 {
1911 listitem_T *li;
1912
1913 free_fc = FALSE;
1914
1915 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001916 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001917 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001918 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001919
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001920 if (free_fc)
1921 free_funccal(fc);
1922 else
1923 {
1924 static int made_copy = 0;
1925
1926 // "fc" is still in use. This can happen when returning "a:000",
1927 // assigning "l:" to a global variable or defining a closure.
1928 // Link "fc" in the list for garbage collection later.
1929 fc->caller = previous_funccal;
1930 previous_funccal = fc;
1931
1932 if (want_garbage_collect)
1933 // If garbage collector is ready, clear count.
1934 made_copy = 0;
1935 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001936 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001937 // We have made a lot of copies, worth 4 Mbyte. This can happen
1938 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001939 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001940 // too much memory.
1941 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001942 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001943 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001944 }
1945}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001946
1947/*
1948 * There are two kinds of function names:
1949 * 1. ordinary names, function defined with :function or :def
1950 * 2. numbered functions and lambdas
1951 * For the first we only count the name stored in func_hashtab as a reference,
1952 * using function() does not count as a reference, because the function is
1953 * looked up by name.
1954 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001955 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001956func_name_refcount(char_u *name)
1957{
1958 return isdigit(*name) || *name == '<';
1959}
1960
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001961/*
1962 * Unreference "fc": decrement the reference count and free it when it
1963 * becomes zero. "fp" is detached from "fc".
1964 * When "force" is TRUE we are exiting.
1965 */
1966 static void
1967funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1968{
1969 funccall_T **pfc;
1970 int i;
1971
1972 if (fc == NULL)
1973 return;
1974
1975 if (--fc->fc_refcount <= 0 && (force || (
1976 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1977 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1978 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1979 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1980 {
1981 if (fc == *pfc)
1982 {
1983 *pfc = fc->caller;
1984 free_funccal_contents(fc);
1985 return;
1986 }
1987 }
1988 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1989 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1990 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1991}
1992
1993/*
1994 * Remove the function from the function hashtable. If the function was
1995 * deleted while it still has references this was already done.
1996 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1997 */
1998 static int
1999func_remove(ufunc_T *fp)
2000{
2001 hashitem_T *hi;
2002
2003 // Return if it was already virtually deleted.
2004 if (fp->uf_flags & FC_DEAD)
2005 return FALSE;
2006
2007 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2008 if (!HASHITEM_EMPTY(hi))
2009 {
2010 // When there is a def-function index do not actually remove the
2011 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002012 // Do remove it when it's a copy.
2013 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002014 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002015 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002016 return FALSE;
2017 }
2018 hash_remove(&func_hashtab, hi);
2019 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002020 return TRUE;
2021 }
2022 return FALSE;
2023}
2024
2025 static void
2026func_clear_items(ufunc_T *fp)
2027{
2028 ga_clear_strings(&(fp->uf_args));
2029 ga_clear_strings(&(fp->uf_def_args));
2030 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002032 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002033 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002034 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002035
2036 // Increment the refcount of this function to avoid it being freed
2037 // recursively when the partial is freed.
2038 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002039 partial_unref(fp->uf_partial);
2040 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002041 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002042
2043#ifdef FEAT_LUA
2044 if (fp->uf_cb_free != NULL)
2045 {
2046 fp->uf_cb_free(fp->uf_cb_state);
2047 fp->uf_cb_free = NULL;
2048 }
2049
2050 fp->uf_cb_state = NULL;
2051 fp->uf_cb = NULL;
2052#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002053#ifdef FEAT_PROFILE
2054 VIM_CLEAR(fp->uf_tml_count);
2055 VIM_CLEAR(fp->uf_tml_total);
2056 VIM_CLEAR(fp->uf_tml_self);
2057#endif
2058}
2059
2060/*
2061 * Free all things that a function contains. Does not free the function
2062 * itself, use func_free() for that.
2063 * When "force" is TRUE we are exiting.
2064 */
2065 static void
2066func_clear(ufunc_T *fp, int force)
2067{
2068 if (fp->uf_cleared)
2069 return;
2070 fp->uf_cleared = TRUE;
2071
2072 // clear this function
2073 func_clear_items(fp);
2074 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002075 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002076}
2077
2078/*
2079 * Free a function and remove it from the list of functions. Does not free
2080 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002081 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002082 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002083 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002084 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002085func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002086{
2087 // Only remove it when not done already, otherwise we would remove a newer
2088 // version of the function with the same name.
2089 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2090 func_remove(fp);
2091
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002092 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002093 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002094 if (fp->uf_dfunc_idx > 0)
2095 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002096 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002097 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002098 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002099 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002100 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002101}
2102
2103/*
2104 * Free all things that a function contains and free the function itself.
2105 * When "force" is TRUE we are exiting.
2106 */
2107 static void
2108func_clear_free(ufunc_T *fp, int force)
2109{
2110 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002111 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2112 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002113 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002114 else
2115 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002116}
2117
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002118/*
2119 * Copy already defined function "lambda" to a new function with name "global".
2120 * This is for when a compiled function defines a global function.
2121 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002122 int
2123copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002124{
2125 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002126 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002127
2128 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002129 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002130 semsg(_(e_lambda_function_not_found_str), lambda);
2131 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002132 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002133
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002134 fp = find_func(global, TRUE, NULL);
2135 if (fp != NULL)
2136 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002137 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002138 semsg(_(e_funcexts), global);
2139 return FAIL;
2140 }
2141
2142 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2143 if (fp == NULL)
2144 return FAIL;
2145
2146 fp->uf_varargs = ufunc->uf_varargs;
2147 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2148 fp->uf_def_status = ufunc->uf_def_status;
2149 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2150 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2151 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2152 == FAIL
2153 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2154 goto failed;
2155
2156 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2157 : vim_strsave(ufunc->uf_name_exp);
2158 if (ufunc->uf_arg_types != NULL)
2159 {
2160 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2161 if (fp->uf_arg_types == NULL)
2162 goto failed;
2163 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2164 sizeof(type_T *) * fp->uf_args.ga_len);
2165 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002166 if (ufunc->uf_va_name != NULL)
2167 {
2168 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2169 if (fp->uf_va_name == NULL)
2170 goto failed;
2171 }
2172 fp->uf_ret_type = ufunc->uf_ret_type;
2173
2174 fp->uf_refcount = 1;
2175 STRCPY(fp->uf_name, global);
2176 hash_add(&func_hashtab, UF2HIKEY(fp));
2177
2178 // the referenced dfunc_T is now used one more time
2179 link_def_function(fp);
2180
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002181 // Create a partial to store the context of the function where it was
2182 // instantiated. Only needs to be done once. Do this on the original
2183 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002184 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2185 {
2186 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2187
2188 if (pt == NULL)
2189 goto failed;
2190 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002191 {
2192 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002193 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002194 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002195 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002196 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002197 }
2198
2199 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002200
2201failed:
2202 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002203 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002204}
2205
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002206static int funcdepth = 0;
2207
2208/*
2209 * Increment the function call depth count.
2210 * Return FAIL when going over 'maxfuncdepth'.
2211 * Otherwise return OK, must call funcdepth_decrement() later!
2212 */
2213 int
2214funcdepth_increment(void)
2215{
2216 if (funcdepth >= p_mfd)
2217 {
2218 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2219 return FAIL;
2220 }
2221 ++funcdepth;
2222 return OK;
2223}
2224
2225 void
2226funcdepth_decrement(void)
2227{
2228 --funcdepth;
2229}
2230
2231/*
2232 * Get the current function call depth.
2233 */
2234 int
2235funcdepth_get(void)
2236{
2237 return funcdepth;
2238}
2239
2240/*
2241 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002242 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002243 * times as funcdepth_increment().
2244 */
2245 void
2246funcdepth_restore(int depth)
2247{
2248 funcdepth = depth;
2249}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002250
2251/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002252 * Call a user function.
2253 */
2254 static void
2255call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002256 ufunc_T *fp, // pointer to function
2257 int argcount, // nr of args
2258 typval_T *argvars, // arguments
2259 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002260 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002261 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002262{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002263 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002264 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265 funccall_T *fc;
2266 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002267 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002268 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002269 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002270 int i;
2271 int ai;
2272 int islambda = FALSE;
2273 char_u numbuf[NUMBUFLEN];
2274 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002275 typval_T *tv_to_free[MAX_FUNC_ARGS];
2276 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002278 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002279#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002280 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002281
Bram Moolenaarb2049902021-01-24 12:53:53 +01002282#ifdef FEAT_PROFILE
2283 CLEAR_FIELD(profile_info);
2284#endif
2285
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002286 // If depth of calling is getting too high, don't execute the function.
2287 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002288 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002289 rettv->v_type = VAR_NUMBER;
2290 rettv->vval.v_number = -1;
2291 return;
2292 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002293
Bram Moolenaare38eab22019-12-05 21:50:01 +01002294 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002296 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002297 if (fc == NULL)
2298 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002299 fc->caller = current_funccal;
2300 current_funccal = fc;
2301 fc->func = fp;
2302 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002303 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002304 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002305 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2306 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002307 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002308 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002309 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002310
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002311 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002312 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002313#ifdef FEAT_PROFILE
2314 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2315#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002316 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002317#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002318 if (do_profiling == PROF_YES)
2319 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002320#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002321 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002322 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002323#ifdef FEAT_PROFILE
2324 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002325 || (caller != NULL && caller->uf_profiling)))
2326 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002327#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002328 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002329 free_funccal(fc);
2330 return;
2331 }
2332
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2334 islambda = TRUE;
2335
2336 /*
2337 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2338 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2339 * each argument variable and saves a lot of time.
2340 */
2341 /*
2342 * Init l: variables.
2343 */
2344 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2345 if (selfdict != NULL)
2346 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002347 // Set l:self to "selfdict". Use "name" to avoid a warning from
2348 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349 v = &fc->fixvar[fixvar_idx++].var;
2350 name = v->di_key;
2351 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002352 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2354 v->di_tv.v_type = VAR_DICT;
2355 v->di_tv.v_lock = 0;
2356 v->di_tv.vval.v_dict = selfdict;
2357 ++selfdict->dv_refcount;
2358 }
2359
2360 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002361 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002362 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 * Set a:000 to a list with room for the "..." arguments.
2364 */
2365 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002366 if ((fp->uf_flags & FC_NOARGS) == 0)
2367 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002368 (varnumber_T)(argcount >= fp->uf_args.ga_len
2369 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002370 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002371 if ((fp->uf_flags & FC_NOARGS) == 0)
2372 {
2373 // Use "name" to avoid a warning from some compiler that checks the
2374 // destination size.
2375 v = &fc->fixvar[fixvar_idx++].var;
2376 name = v->di_key;
2377 STRCPY(name, "000");
2378 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2379 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2380 v->di_tv.v_type = VAR_LIST;
2381 v->di_tv.v_lock = VAR_FIXED;
2382 v->di_tv.vval.v_list = &fc->l_varlist;
2383 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002384 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2386 fc->l_varlist.lv_lock = VAR_FIXED;
2387
2388 /*
2389 * Set a:firstline to "firstline" and a:lastline to "lastline".
2390 * Set a:name to named arguments.
2391 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002392 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002394 if ((fp->uf_flags & FC_NOARGS) == 0)
2395 {
2396 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002397 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002398 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002399 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002400 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002401 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002402 {
2403 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002404 typval_T def_rettv;
2405 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406
2407 ai = i - fp->uf_args.ga_len;
2408 if (ai < 0)
2409 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002410 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002411 name = FUNCARG(fp, i);
2412 if (islambda)
2413 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002414
2415 // evaluate named argument default expression
2416 isdefault = ai + fp->uf_def_args.ga_len >= 0
2417 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2418 && argvars[i].vval.v_number == VVAL_NONE));
2419 if (isdefault)
2420 {
2421 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002422
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002423 def_rettv.v_type = VAR_NUMBER;
2424 def_rettv.vval.v_number = -1;
2425
2426 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2427 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002428 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002429 {
2430 default_arg_err = 1;
2431 break;
2432 }
2433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 }
2435 else
2436 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002437 if ((fp->uf_flags & FC_NOARGS) != 0)
2438 // Bail out if no a: arguments used (in lambda).
2439 break;
2440
Bram Moolenaare38eab22019-12-05 21:50:01 +01002441 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 sprintf((char *)numbuf, "%d", ai + 1);
2443 name = numbuf;
2444 }
2445 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2446 {
2447 v = &fc->fixvar[fixvar_idx++].var;
2448 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002449 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450 }
2451 else
2452 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002453 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 if (v == NULL)
2455 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002456 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002459 // Note: the values are copied directly to avoid alloc/free.
2460 // "argvars" must have VAR_FIXED for v_lock.
2461 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002462 v->di_tv.v_lock = VAR_FIXED;
2463
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002464 if (isdefault)
2465 // Need to free this later, no matter where it's stored.
2466 tv_to_free[tv_to_free_len++] = &v->di_tv;
2467
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468 if (addlocal)
2469 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002470 // Named arguments should be accessed without the "a:" prefix in
2471 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002472 copy_tv(&v->di_tv, &v->di_tv);
2473 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002475 else
2476 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002477
2478 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2479 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002480 listitem_T *li = &fc->l_listitems[ai];
2481
2482 li->li_tv = argvars[i];
2483 li->li_tv.v_lock = VAR_FIXED;
2484 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485 }
2486 }
2487
Bram Moolenaare38eab22019-12-05 21:50:01 +01002488 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002490
2491 if (fp->uf_flags & FC_SANDBOX)
2492 {
2493 using_sandbox = TRUE;
2494 ++sandbox;
2495 }
2496
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002497 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002498 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002499 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002501 ++no_wait_return;
2502 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002504 smsg(_("calling %s"), SOURCING_NAME);
2505 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002507 char_u buf[MSG_BUF_LEN];
2508 char_u numbuf2[NUMBUFLEN];
2509 char_u *tofree;
2510 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002512 msg_puts("(");
2513 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002515 if (i > 0)
2516 msg_puts(", ");
2517 if (argvars[i].v_type == VAR_NUMBER)
2518 msg_outnum((long)argvars[i].vval.v_number);
2519 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002521 // Do not want errors such as E724 here.
2522 ++emsg_off;
2523 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2524 --emsg_off;
2525 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002527 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002529 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2530 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002532 msg_puts((char *)s);
2533 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 }
2535 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002537 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002539 msg_puts("\n"); // don't overwrite this either
2540
2541 verbose_leave_scroll();
2542 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 }
2544#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002545 if (do_profiling == PROF_YES)
2546 profile_may_start_func(&profile_info, fp,
2547 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548#endif
2549
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002550 save_current_sctx = current_sctx;
2551 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552 save_did_emsg = did_emsg;
2553 did_emsg = FALSE;
2554
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002555 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2556 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002557 else if (islambda)
2558 {
2559 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2560
2561 // A Lambda always has the command "return {expr}". It is much faster
2562 // to evaluate {expr} directly.
2563 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002564 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002565 --ex_nesting_level;
2566 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002567 else
2568 // call do_cmdline() to execute the lines
2569 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2571
2572 --RedrawingDisabled;
2573
Bram Moolenaare38eab22019-12-05 21:50:01 +01002574 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2576 {
2577 clear_tv(rettv);
2578 rettv->v_type = VAR_NUMBER;
2579 rettv->vval.v_number = -1;
2580 }
2581
2582#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002583 if (do_profiling == PROF_YES)
2584 {
2585 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2586
2587 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2588 profile_may_end_func(&profile_info, fp, caller);
2589 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590#endif
2591
Bram Moolenaare38eab22019-12-05 21:50:01 +01002592 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002593 if (p_verbose >= 12)
2594 {
2595 ++no_wait_return;
2596 verbose_enter_scroll();
2597
2598 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002599 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002600 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002601 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002602 (long)fc->rettv->vval.v_number);
2603 else
2604 {
2605 char_u buf[MSG_BUF_LEN];
2606 char_u numbuf2[NUMBUFLEN];
2607 char_u *tofree;
2608 char_u *s;
2609
Bram Moolenaare38eab22019-12-05 21:50:01 +01002610 // The value may be very long. Skip the middle part, so that we
2611 // have some idea how it starts and ends. smsg() would always
2612 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 ++emsg_off;
2614 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2615 --emsg_off;
2616 if (s != NULL)
2617 {
2618 if (vim_strsize(s) > MSG_BUF_CLEN)
2619 {
2620 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2621 s = buf;
2622 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002623 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624 vim_free(tofree);
2625 }
2626 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002627 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628
2629 verbose_leave_scroll();
2630 --no_wait_return;
2631 }
2632
Bram Moolenaare31ee862020-01-07 20:59:34 +01002633 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002634 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002635 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636#ifdef FEAT_PROFILE
2637 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002638 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002640 if (using_sandbox)
2641 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002643 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 {
2645 ++no_wait_return;
2646 verbose_enter_scroll();
2647
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002648 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002649 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650
2651 verbose_leave_scroll();
2652 --no_wait_return;
2653 }
2654
2655 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002656 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002657 for (i = 0; i < tv_to_free_len; ++i)
2658 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002659 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660}
2661
2662/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002663 * Check the argument count for user function "fp".
2664 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2665 */
2666 int
2667check_user_func_argcount(ufunc_T *fp, int argcount)
2668{
2669 int regular_args = fp->uf_args.ga_len;
2670
2671 if (argcount < regular_args - fp->uf_def_args.ga_len)
2672 return FCERR_TOOFEW;
2673 else if (!has_varargs(fp) && argcount > regular_args)
2674 return FCERR_TOOMANY;
2675 return FCERR_UNKNOWN;
2676}
2677
2678/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002679 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002680 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002681 int
2682call_user_func_check(
2683 ufunc_T *fp,
2684 int argcount,
2685 typval_T *argvars,
2686 typval_T *rettv,
2687 funcexe_T *funcexe,
2688 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002689{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002690 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002691
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002692 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2693 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002694 error = check_user_func_argcount(fp, argcount);
2695 if (error != FCERR_UNKNOWN)
2696 return error;
2697 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002698 error = FCERR_DICT;
2699 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002700 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002701 int did_save_redo = FALSE;
2702 save_redo_T save_redo;
2703
2704 /*
2705 * Call the user function.
2706 * Save and restore search patterns, script variables and
2707 * redo buffer.
2708 */
2709 save_search_patterns();
2710 if (!ins_compl_active())
2711 {
2712 saveRedobuff(&save_redo);
2713 did_save_redo = TRUE;
2714 }
2715 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002716 call_user_func(fp, argcount, argvars, rettv, funcexe,
2717 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002718 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2719 // Function was unreferenced while being used, free it now.
2720 func_clear_free(fp, FALSE);
2721 if (did_save_redo)
2722 restoreRedobuff(&save_redo);
2723 restore_search_patterns();
2724 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002725 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002726 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002727}
2728
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002729static funccal_entry_T *funccal_stack = NULL;
2730
2731/*
2732 * Save the current function call pointer, and set it to NULL.
2733 * Used when executing autocommands and for ":source".
2734 */
2735 void
2736save_funccal(funccal_entry_T *entry)
2737{
2738 entry->top_funccal = current_funccal;
2739 entry->next = funccal_stack;
2740 funccal_stack = entry;
2741 current_funccal = NULL;
2742}
2743
2744 void
2745restore_funccal(void)
2746{
2747 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002748 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002749 else
2750 {
2751 current_funccal = funccal_stack->top_funccal;
2752 funccal_stack = funccal_stack->next;
2753 }
2754}
2755
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002756 funccall_T *
2757get_current_funccal(void)
2758{
2759 return current_funccal;
2760}
2761
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002762/*
2763 * Mark all functions of script "sid" as deleted.
2764 */
2765 void
2766delete_script_functions(int sid)
2767{
2768 hashitem_T *hi;
2769 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002770 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002771 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002772 size_t len;
2773
2774 buf[0] = K_SPECIAL;
2775 buf[1] = KS_EXTRA;
2776 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002777 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002778 len = STRLEN(buf);
2779
Bram Moolenaarce658352020-07-31 23:47:12 +02002780 while (todo > 0)
2781 {
2782 todo = func_hashtab.ht_used;
2783 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2784 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002785 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002786 fp = HI2UF(hi);
2787 if (STRNCMP(fp->uf_name, buf, len) == 0)
2788 {
2789 int changed = func_hashtab.ht_changed;
2790
2791 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002792
2793 if (fp->uf_calls > 0)
2794 {
2795 // Function is executing, don't free it but do remove
2796 // it from the hashtable.
2797 if (func_remove(fp))
2798 fp->uf_refcount--;
2799 }
2800 else
2801 {
2802 func_clear(fp, TRUE);
2803 // When clearing a function another function can be
2804 // cleared as a side effect. When that happens start
2805 // over.
2806 if (changed != func_hashtab.ht_changed)
2807 break;
2808 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002809 }
2810 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002811 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002812 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002813}
2814
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815#if defined(EXITFREE) || defined(PROTO)
2816 void
2817free_all_functions(void)
2818{
2819 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002820 ufunc_T *fp;
2821 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002822 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002823 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824
Bram Moolenaare38eab22019-12-05 21:50:01 +01002825 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002826 while (current_funccal != NULL)
2827 {
2828 clear_tv(current_funccal->rettv);
2829 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002830 if (current_funccal == NULL && funccal_stack != NULL)
2831 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002832 }
2833
Bram Moolenaare38eab22019-12-05 21:50:01 +01002834 // First clear what the functions contain. Since this may lower the
2835 // reference count of a function, it may also free a function and change
2836 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002837 while (todo > 0)
2838 {
2839 todo = func_hashtab.ht_used;
2840 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2841 if (!HASHITEM_EMPTY(hi))
2842 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002843 // clear the def function index now
2844 fp = HI2UF(hi);
2845 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002846 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002847
Bram Moolenaare38eab22019-12-05 21:50:01 +01002848 // Only free functions that are not refcounted, those are
2849 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002850 if (func_name_refcount(fp->uf_name))
2851 ++skipped;
2852 else
2853 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002854 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002855 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002856 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002857 {
2858 skipped = 0;
2859 break;
2860 }
2861 }
2862 --todo;
2863 }
2864 }
2865
Bram Moolenaare38eab22019-12-05 21:50:01 +01002866 // Now actually free the functions. Need to start all over every time,
2867 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002868 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002869 while (func_hashtab.ht_used > skipped)
2870 {
2871 todo = func_hashtab.ht_used;
2872 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 if (!HASHITEM_EMPTY(hi))
2874 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002875 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002876 // Only free functions that are not refcounted, those are
2877 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002878 fp = HI2UF(hi);
2879 if (func_name_refcount(fp->uf_name))
2880 ++skipped;
2881 else
2882 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002883 if (func_free(fp, FALSE) == OK)
2884 {
2885 skipped = 0;
2886 break;
2887 }
2888 // did not actually free it
2889 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002890 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002891 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002892 }
2893 if (skipped == 0)
2894 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002895
2896 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897}
2898#endif
2899
2900/*
2901 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002902 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903 * "len" is the length of "name", or -1 for NUL terminated.
2904 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002905 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906builtin_function(char_u *name, int len)
2907{
2908 char_u *p;
2909
Bram Moolenaara26b9702020-04-18 19:53:28 +02002910 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 return FALSE;
2912 p = vim_strchr(name, AUTOLOAD_CHAR);
2913 return p == NULL || (len > 0 && p > name + len);
2914}
2915
2916 int
2917func_call(
2918 char_u *name,
2919 typval_T *args,
2920 partial_T *partial,
2921 dict_T *selfdict,
2922 typval_T *rettv)
2923{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002924 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002925 listitem_T *item;
2926 typval_T argv[MAX_FUNC_ARGS + 1];
2927 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928 int r = 0;
2929
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002930 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002931 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932 {
2933 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2934 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002935 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936 break;
2937 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002938 // Make a copy of each argument. This is needed to be able to set
2939 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940 copy_tv(&item->li_tv, &argv[argc++]);
2941 }
2942
2943 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002944 {
2945 funcexe_T funcexe;
2946
Bram Moolenaara80faa82020-04-12 19:37:17 +02002947 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002948 funcexe.firstline = curwin->w_cursor.lnum;
2949 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002950 funcexe.evaluate = TRUE;
2951 funcexe.partial = partial;
2952 funcexe.selfdict = selfdict;
2953 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2954 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955
Bram Moolenaare38eab22019-12-05 21:50:01 +01002956 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002957 while (argc > 0)
2958 clear_tv(&argv[--argc]);
2959
2960 return r;
2961}
2962
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002963static int callback_depth = 0;
2964
2965 int
2966get_callback_depth(void)
2967{
2968 return callback_depth;
2969}
2970
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002972 * Invoke call_func() with a callback.
2973 */
2974 int
2975call_callback(
2976 callback_T *callback,
2977 int len, // length of "name" or -1 to use strlen()
2978 typval_T *rettv, // return value goes here
2979 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002980 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002981 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002982{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002983 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002984 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002985
Bram Moolenaara80faa82020-04-12 19:37:17 +02002986 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002987 funcexe.evaluate = TRUE;
2988 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002989 ++callback_depth;
2990 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2991 --callback_depth;
2992 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002993}
2994
2995/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002996 * Give an error message for the result of a function.
2997 * Nothing if "error" is FCERR_NONE.
2998 */
2999 void
3000user_func_error(int error, char_u *name)
3001{
3002 switch (error)
3003 {
3004 case FCERR_UNKNOWN:
3005 emsg_funcname(e_unknownfunc, name);
3006 break;
3007 case FCERR_NOTMETHOD:
3008 emsg_funcname(
3009 N_("E276: Cannot use function as a method: %s"), name);
3010 break;
3011 case FCERR_DELETED:
3012 emsg_funcname(N_(e_func_deleted), name);
3013 break;
3014 case FCERR_TOOMANY:
3015 emsg_funcname((char *)e_toomanyarg, name);
3016 break;
3017 case FCERR_TOOFEW:
3018 emsg_funcname((char *)e_toofewarg, name);
3019 break;
3020 case FCERR_SCRIPT:
3021 emsg_funcname(
3022 N_("E120: Using <SID> not in a script context: %s"), name);
3023 break;
3024 case FCERR_DICT:
3025 emsg_funcname(
3026 N_("E725: Calling dict function without Dictionary: %s"),
3027 name);
3028 break;
3029 }
3030}
3031
3032/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003034 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 * Return FAIL when the function can't be called, OK otherwise.
3036 * Also returns OK when an error was encountered while executing the function.
3037 */
3038 int
3039call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003040 char_u *funcname, // name of the function
3041 int len, // length of "name" or -1 to use strlen()
3042 typval_T *rettv, // return value goes here
3043 int argcount_in, // number of "argvars"
3044 typval_T *argvars_in, // vars for arguments, must have "argcount"
3045 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003046 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047{
3048 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003049 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003050 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003051 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003052 char_u fname_buf[FLEN_FIXED + 1];
3053 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003054 char_u *fname = NULL;
3055 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003056 int argcount = argcount_in;
3057 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003058 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003059 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3060 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003061 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003062 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003063 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003064
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003065 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3066 // even when call_func() returns FAIL.
3067 rettv->v_type = VAR_UNKNOWN;
3068
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003069 if (partial != NULL)
3070 fp = partial->pt_func;
3071 if (fp == NULL)
3072 {
3073 // Make a copy of the name, if it comes from a funcref variable it
3074 // could be changed or deleted in the called function.
3075 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3076 if (name == NULL)
3077 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003078
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003079 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3080 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003081
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003082 if (funcexe->doesrange != NULL)
3083 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003084
3085 if (partial != NULL)
3086 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003087 // When the function has a partial with a dict and there is a dict
3088 // argument, use the dict argument. That is backwards compatible.
3089 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003090 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003091 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003092 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003093 {
3094 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003095 {
3096 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3097 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003098 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003099 goto theend;
3100 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003102 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 for (i = 0; i < argcount_in; ++i)
3104 argv[i + argv_clear] = argvars_in[i];
3105 argvars = argv;
3106 argcount = partial->pt_argc + argcount_in;
3107 }
3108 }
3109
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003110 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3111 {
3112 // Check that the argument types are OK for the types of the funcref.
3113 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003114 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003115 error = FCERR_OTHER;
3116 }
3117
Bram Moolenaaref140542019-12-31 21:27:13 +01003118 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 {
3120 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003121 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122
Bram Moolenaar333894b2020-08-01 18:53:07 +02003123 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003124 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003125 {
3126 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003128 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129
Bram Moolenaare38eab22019-12-05 21:50:01 +01003130 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003132 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003134 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135 {
3136 /*
3137 * User defined function.
3138 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003139 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003140 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141
Bram Moolenaare38eab22019-12-05 21:50:01 +01003142 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 if (fp == NULL
3144 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003145 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003146 && !aborting())
3147 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003148 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003149 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003150 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003151 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3153 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003154 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003155 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003156 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003157 if (fp == NULL)
3158 {
3159 char_u *p = untrans_function_name(rfname);
3160
3161 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003162 // Don't do this if the name starts with "s:".
3163 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003164 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003165 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003166
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003167 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003168 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003169#ifdef FEAT_LUA
3170 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3171 {
3172 cfunc_T cb = fp->uf_cb;
3173
3174 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3175 }
3176#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003177 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003179 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003180 // postponed filling in the arguments, do it now
3181 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003182 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003183
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003184 if (funcexe->basetv != NULL)
3185 {
3186 // Method call: base->Method()
3187 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3188 argv[0] = *funcexe->basetv;
3189 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003190 argvars = argv;
3191 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003192 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003193
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003194 error = call_user_func_check(fp, argcount, argvars, rettv,
3195 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003196 }
3197 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003198 else if (funcexe->basetv != NULL)
3199 {
3200 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003201 * expr->method(): Find the method name in the table, call its
3202 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003203 */
3204 error = call_internal_method(fname, argcount, argvars, rettv,
3205 funcexe->basetv);
3206 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207 else
3208 {
3209 /*
3210 * Find the function name in the table, call its implementation.
3211 */
3212 error = call_internal_func(fname, argcount, argvars, rettv);
3213 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003214
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215 /*
3216 * The function call (or "FuncUndefined" autocommand sequence) might
3217 * have been aborted by an error, an interrupt, or an explicitly thrown
3218 * exception that has not been caught so far. This situation can be
3219 * tested for by calling aborting(). For an error in an internal
3220 * function or for the "E132" error in call_user_func(), however, the
3221 * throw point at which the "force_abort" flag (temporarily reset by
3222 * emsg()) is normally updated has not been reached yet. We need to
3223 * update that flag first to make aborting() reliable.
3224 */
3225 update_force_abort();
3226 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003227 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228 ret = OK;
3229
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003230theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 /*
3232 * Report an error unless the argument evaluation or function call has been
3233 * cancelled due to an aborting error, an interrupt, or an exception.
3234 */
3235 if (!aborting())
3236 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003237 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003238 }
3239
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003240 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003242 clear_tv(&argv[--argv_clear + argv_base]);
3243
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244 vim_free(tofree);
3245 vim_free(name);
3246
3247 return ret;
3248}
3249
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003250 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251printable_func_name(ufunc_T *fp)
3252{
3253 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3254}
3255
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003256/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003257 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258 */
3259 static void
3260list_func_head(ufunc_T *fp, int indent)
3261{
3262 int j;
3263
3264 msg_start();
3265 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003266 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003267 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003268 msg_puts("def ");
3269 else
3270 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003271 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003272 msg_putchar('(');
3273 for (j = 0; j < fp->uf_args.ga_len; ++j)
3274 {
3275 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003276 msg_puts(", ");
3277 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003278 if (fp->uf_arg_types != NULL)
3279 {
3280 char *tofree;
3281
3282 msg_puts(": ");
3283 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3284 vim_free(tofree);
3285 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003286 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3287 {
3288 msg_puts(" = ");
3289 msg_puts(((char **)(fp->uf_def_args.ga_data))
3290 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 }
3293 if (fp->uf_varargs)
3294 {
3295 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003296 msg_puts(", ");
3297 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003298 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299 if (fp->uf_va_name != NULL)
3300 {
3301 if (j)
3302 msg_puts(", ");
3303 msg_puts("...");
3304 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003305 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003306 {
3307 char *tofree;
3308
3309 msg_puts(": ");
3310 msg_puts(type_name(fp->uf_va_type, &tofree));
3311 vim_free(tofree);
3312 }
3313 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003314 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003315
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003316 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003317 {
3318 if (fp->uf_ret_type != &t_void)
3319 {
3320 char *tofree;
3321
3322 msg_puts(": ");
3323 msg_puts(type_name(fp->uf_ret_type, &tofree));
3324 vim_free(tofree);
3325 }
3326 }
3327 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003328 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003330 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003332 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003333 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003334 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 msg_clr_eos();
3336 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003337 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338}
3339
3340/*
3341 * Get a function name, translating "<SID>" and "<SNR>".
3342 * Also handles a Funcref in a List or Dictionary.
3343 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003344 * Set "*is_global" to TRUE when the function must be global, unless
3345 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 * flags:
3347 * TFN_INT: internal function name OK
3348 * TFN_QUIET: be quiet
3349 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003350 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 * Advances "pp" to just after the function name (if no error).
3352 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003353 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354trans_function_name(
3355 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003356 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003357 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003359 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003360 partial_T **partial, // return: partial of a FuncRef
3361 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362{
3363 char_u *name = NULL;
3364 char_u *start;
3365 char_u *end;
3366 int lead;
3367 char_u sid_buf[20];
3368 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003369 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003371 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003372 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373
3374 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003375 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376 start = *pp;
3377
Bram Moolenaare38eab22019-12-05 21:50:01 +01003378 // Check for hard coded <SNR>: already translated function ID (from a user
3379 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3381 && (*pp)[2] == (int)KE_SNR)
3382 {
3383 *pp += 3;
3384 len = get_id_len(pp) + 3;
3385 return vim_strnsave(start, len);
3386 }
3387
Bram Moolenaare38eab22019-12-05 21:50:01 +01003388 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3389 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 lead = eval_fname_script(start);
3391 if (lead > 2)
3392 start += lead;
3393
Bram Moolenaare38eab22019-12-05 21:50:01 +01003394 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003395 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396 lead > 2 ? 0 : FNE_CHECK_START);
3397 if (end == start)
3398 {
3399 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003400 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 goto theend;
3402 }
3403 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3404 {
3405 /*
3406 * Report an invalid expression in braces, unless the expression
3407 * evaluation has been cancelled due to an aborting error, an
3408 * interrupt, or an exception.
3409 */
3410 if (!aborting())
3411 {
3412 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003413 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 }
3415 else
3416 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3417 goto theend;
3418 }
3419
3420 if (lv.ll_tv != NULL)
3421 {
3422 if (fdp != NULL)
3423 {
3424 fdp->fd_dict = lv.ll_dict;
3425 fdp->fd_newkey = lv.ll_newkey;
3426 lv.ll_newkey = NULL;
3427 fdp->fd_di = lv.ll_di;
3428 }
3429 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3430 {
3431 name = vim_strsave(lv.ll_tv->vval.v_string);
3432 *pp = end;
3433 }
3434 else if (lv.ll_tv->v_type == VAR_PARTIAL
3435 && lv.ll_tv->vval.v_partial != NULL)
3436 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003437 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438 *pp = end;
3439 if (partial != NULL)
3440 *partial = lv.ll_tv->vval.v_partial;
3441 }
3442 else
3443 {
3444 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3445 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003446 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 else
3448 *pp = end;
3449 name = NULL;
3450 }
3451 goto theend;
3452 }
3453
3454 if (lv.ll_name == NULL)
3455 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003456 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 *pp = end;
3458 goto theend;
3459 }
3460
Bram Moolenaare38eab22019-12-05 21:50:01 +01003461 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 if (lv.ll_exp_name != NULL)
3463 {
3464 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003465 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 flags & TFN_NO_AUTOLOAD);
3467 if (name == lv.ll_exp_name)
3468 name = NULL;
3469 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003470 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 {
3472 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003473 name = deref_func_name(*pp, &len, partial, type,
3474 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003475 if (name == *pp)
3476 name = NULL;
3477 }
3478 if (name != NULL)
3479 {
3480 name = vim_strsave(name);
3481 *pp = end;
3482 if (STRNCMP(name, "<SNR>", 5) == 0)
3483 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003484 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 name[0] = K_SPECIAL;
3486 name[1] = KS_EXTRA;
3487 name[2] = (int)KE_SNR;
3488 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3489 }
3490 goto theend;
3491 }
3492
3493 if (lv.ll_exp_name != NULL)
3494 {
3495 len = (int)STRLEN(lv.ll_exp_name);
3496 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3497 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3498 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003499 // When there was "s:" already or the name expanded to get a
3500 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 lv.ll_name += 2;
3502 len -= 2;
3503 lead = 2;
3504 }
3505 }
3506 else
3507 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003508 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003510 {
3511 if (is_global != NULL && lv.ll_name[0] == 'g')
3512 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003514 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 len = (int)(end - lv.ll_name);
3516 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003517 if (len <= 0)
3518 {
3519 if (!skip)
3520 emsg(_(e_function_name));
3521 goto theend;
3522 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003524 // In Vim9 script a user function is script-local by default, unless it
3525 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003526 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003527 if (vim9script)
3528 {
3529 char_u *p;
3530
3531 // SomeScript#func() is a global function.
3532 for (p = start; *p != NUL && *p != '('; ++p)
3533 if (*p == AUTOLOAD_CHAR)
3534 vim9script = FALSE;
3535 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003536
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537 /*
3538 * Copy the function name to allocated memory.
3539 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3540 * Accept <SNR>123_name() outside a script.
3541 */
3542 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003543 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003544 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003546 if (!vim9script)
3547 lead = 3;
3548 if (vim9script || (lv.ll_exp_name != NULL
3549 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 || eval_fname_sid(*pp))
3551 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003552 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003553 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003555 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 goto theend;
3557 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003558 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003559 if (vim9script)
3560 extra = 3 + (int)STRLEN(sid_buf);
3561 else
3562 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 }
3564 }
3565 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3566 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003567 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 start);
3569 goto theend;
3570 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003571 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 {
3573 char_u *cp = vim_strchr(lv.ll_name, ':');
3574
3575 if (cp != NULL && cp < end)
3576 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003577 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 goto theend;
3579 }
3580 }
3581
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003582 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 if (name != NULL)
3584 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003585 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 {
3587 name[0] = K_SPECIAL;
3588 name[1] = KS_EXTRA;
3589 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003590 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 STRCPY(name + 3, sid_buf);
3592 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003593 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3594 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 }
3596 *pp = end;
3597
3598theend:
3599 clear_lval(&lv);
3600 return name;
3601}
3602
3603/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003604 * Assuming "name" is the result of trans_function_name() and it was prefixed
3605 * to use the script-local name, return the unmodified name (points into
3606 * "name"). Otherwise return NULL.
3607 * This can be used to first search for a script-local function and fall back
3608 * to the global function if not found.
3609 */
3610 char_u *
3611untrans_function_name(char_u *name)
3612{
3613 char_u *p;
3614
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003615 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003616 {
3617 p = vim_strchr(name, '_');
3618 if (p != NULL)
3619 return p + 1;
3620 }
3621 return NULL;
3622}
3623
3624/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003625 * List functions. When "regmatch" is NULL all of then.
3626 * Otherwise functions matching "regmatch".
3627 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003628 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003629list_functions(regmatch_T *regmatch)
3630{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003631 int changed = func_hashtab.ht_changed;
3632 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003633 hashitem_T *hi;
3634
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003635 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003636 {
3637 if (!HASHITEM_EMPTY(hi))
3638 {
3639 ufunc_T *fp = HI2UF(hi);
3640
3641 --todo;
3642 if ((fp->uf_flags & FC_DEAD) == 0
3643 && (regmatch == NULL
3644 ? !message_filtered(fp->uf_name)
3645 && !func_name_refcount(fp->uf_name)
3646 : !isdigit(*fp->uf_name)
3647 && vim_regexec(regmatch, fp->uf_name, 0)))
3648 {
3649 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003650 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003651 {
3652 emsg(_("E454: function list was modified"));
3653 return;
3654 }
3655 }
3656 }
3657 }
3658}
3659
3660/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003661 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003662 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3663 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003664 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003666 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003667define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003669 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 int j;
3671 int c;
3672 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003673 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003674 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675 char_u *p;
3676 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003677 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 char_u *line_arg = NULL;
3679 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003680 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003681 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003682 garray_T newlines;
3683 int varargs = FALSE;
3684 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003685 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003686 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003687 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 dictitem_T *v;
3689 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003690 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003691 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003693 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003694 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003695 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696
3697 /*
3698 * ":function" without argument: list functions.
3699 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003700 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 {
3702 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003703 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003705 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003706 }
3707
3708 /*
3709 * ":function /pat": list functions matching pattern.
3710 */
3711 if (*eap->arg == '/')
3712 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003713 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003714 if (!eap->skip)
3715 {
3716 regmatch_T regmatch;
3717
3718 c = *p;
3719 *p = NUL;
3720 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3721 *p = c;
3722 if (regmatch.regprog != NULL)
3723 {
3724 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003725 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 vim_regfree(regmatch.regprog);
3727 }
3728 }
3729 if (*p == '/')
3730 ++p;
3731 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003732 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 }
3734
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003735 ga_init(&newargs);
3736 ga_init(&argtypes);
3737 ga_init(&default_args);
3738
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 /*
3740 * Get the function name. There are these situations:
3741 * func normal function name
3742 * "name" == func, "fudi.fd_dict" == NULL
3743 * dict.func new dictionary entry
3744 * "name" == NULL, "fudi.fd_dict" set,
3745 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3746 * dict.func existing dict entry with a Funcref
3747 * "name" == func, "fudi.fd_dict" set,
3748 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3749 * dict.func existing dict entry that's not a Funcref
3750 * "name" == NULL, "fudi.fd_dict" set,
3751 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3752 * s:func script-local function name
3753 * g:func global function name, same as "func"
3754 */
3755 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003756 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003758 // nested function, argument is (args).
3759 paren = TRUE;
3760 CLEAR_FIELD(fudi);
3761 }
3762 else
3763 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003764 if (STRNCMP(p, "<lambda>", 8) == 0)
3765 {
3766 p += 8;
3767 (void)getdigits(&p);
3768 name = vim_strnsave(eap->arg, p - eap->arg);
3769 CLEAR_FIELD(fudi);
3770 }
3771 else
3772 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003773 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003774 paren = (vim_strchr(p, '(') != NULL);
3775 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003777 /*
3778 * Return on an invalid expression in braces, unless the expression
3779 * evaluation has been cancelled due to an aborting error, an
3780 * interrupt, or an exception.
3781 */
3782 if (!aborting())
3783 {
3784 if (!eap->skip && fudi.fd_newkey != NULL)
3785 semsg(_(e_dictkey), fudi.fd_newkey);
3786 vim_free(fudi.fd_newkey);
3787 return NULL;
3788 }
3789 else
3790 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 }
3793
Bram Moolenaare38eab22019-12-05 21:50:01 +01003794 // An error in a function call during evaluation of an expression in magic
3795 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 saved_did_emsg = did_emsg;
3797 did_emsg = FALSE;
3798
3799 /*
3800 * ":function func" with only function name: list function.
3801 */
3802 if (!paren)
3803 {
3804 if (!ends_excmd(*skipwhite(p)))
3805 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003806 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 goto ret_free;
3808 }
3809 eap->nextcmd = check_nextcmd(p);
3810 if (eap->nextcmd != NULL)
3811 *p = NUL;
3812 if (!eap->skip && !got_int)
3813 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003814 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003815 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3816 {
3817 char_u *up = untrans_function_name(name);
3818
3819 // With Vim9 script the name was made script-local, if not
3820 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003821 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003822 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003823 }
3824
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 if (fp != NULL)
3826 {
3827 list_func_head(fp, TRUE);
3828 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3829 {
3830 if (FUNCLINE(fp, j) == NULL)
3831 continue;
3832 msg_putchar('\n');
3833 msg_outnum((long)(j + 1));
3834 if (j < 9)
3835 msg_putchar(' ');
3836 if (j < 99)
3837 msg_putchar(' ');
3838 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003839 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 ui_breakcheck();
3841 }
3842 if (!got_int)
3843 {
3844 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003845 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003846 msg_puts(" enddef");
3847 else
3848 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 }
3850 }
3851 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003852 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853 }
3854 goto ret_free;
3855 }
3856
3857 /*
3858 * ":function name(arg1, arg2)" Define function.
3859 */
3860 p = skipwhite(p);
3861 if (*p != '(')
3862 {
3863 if (!eap->skip)
3864 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003865 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866 goto ret_free;
3867 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003868 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 if (vim_strchr(p, '(') != NULL)
3870 p = vim_strchr(p, '(');
3871 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003872
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003873 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3874 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003875 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003876 goto ret_free;
3877 }
3878
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003879 // In Vim9 script only global functions can be redefined.
3880 if (vim9script && eap->forceit && !is_global)
3881 {
3882 emsg(_(e_nobang));
3883 goto ret_free;
3884 }
3885
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003886 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887
Bram Moolenaar04b12692020-05-04 23:24:44 +02003888 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003889 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003890 // Check the name of the function. Unless it's a dictionary function
3891 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 if (name != NULL)
3893 arg = name;
3894 else
3895 arg = fudi.fd_newkey;
3896 if (arg != NULL && (fudi.fd_di == NULL
3897 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3898 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3899 {
3900 if (*arg == K_SPECIAL)
3901 j = 3;
3902 else
3903 j = 0;
3904 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3905 : eval_isnamec(arg[j])))
3906 ++j;
3907 if (arg[j] != NUL)
3908 emsg_funcname((char *)e_invarg2, arg);
3909 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003910 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003912 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913 }
3914
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003915 // This may get more lines and make the pointers into the first line
3916 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003917 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003918 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003919 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003920 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003921 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003922 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003923 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003925 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003927 // find the return type: :def Func(): type
3928 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003929 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003930 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003931 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003932 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003933 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003934 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003935 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003936 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003937 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003938 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003939 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003940 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003941 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003942 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003944 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003946 else
3947 // find extra arguments "range", "dict", "abort" and "closure"
3948 for (;;)
3949 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003950 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003951 p = skipwhite(p);
3952 if (STRNCMP(p, "range", 5) == 0)
3953 {
3954 flags |= FC_RANGE;
3955 p += 5;
3956 }
3957 else if (STRNCMP(p, "dict", 4) == 0)
3958 {
3959 flags |= FC_DICT;
3960 p += 4;
3961 }
3962 else if (STRNCMP(p, "abort", 5) == 0)
3963 {
3964 flags |= FC_ABORT;
3965 p += 5;
3966 }
3967 else if (STRNCMP(p, "closure", 7) == 0)
3968 {
3969 flags |= FC_CLOSURE;
3970 p += 7;
3971 if (current_funccal == NULL)
3972 {
3973 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3974 name == NULL ? (char_u *)"" : name);
3975 goto erret;
3976 }
3977 }
3978 else
3979 break;
3980 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981
Bram Moolenaare38eab22019-12-05 21:50:01 +01003982 // When there is a line break use what follows for the function body.
3983 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984 if (*p == '\n')
3985 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003986 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003987 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3988 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003989 && !(VIM_ISWHITE(*whitep) && *p == '#'
3990 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003991 && !eap->skip
3992 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003993 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994
3995 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003996 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3997 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 */
3999 if (KeyTyped)
4000 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004001 // Check if the function already exists, don't let the user type the
4002 // whole function before telling him it doesn't work! For a script we
4003 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 if (!eap->skip && !eap->forceit)
4005 {
4006 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004007 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004008 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004009 emsg_funcname(e_funcexts, name);
4010 }
4011
4012 if (!eap->skip && did_emsg)
4013 goto erret;
4014
Bram Moolenaare38eab22019-12-05 21:50:01 +01004015 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004016 cmdline_row = msg_row;
4017 }
4018
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004019 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004020 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004021
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004022 // Do not define the function when getting the body fails and when
4023 // skipping.
4024 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4025 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 goto erret;
4027
4028 /*
4029 * If there are no errors, add the function
4030 */
4031 if (fudi.fd_dict == NULL)
4032 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004033 hashtab_T *ht;
4034
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004035 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4037 {
4038 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4039 name);
4040 goto erret;
4041 }
4042
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004043 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004044 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004046 char_u *uname = untrans_function_name(name);
4047
4048 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4049 }
4050
4051 if (fp != NULL || import != NULL)
4052 {
4053 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004054
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004055 // Function can be replaced with "function!" and when sourcing the
4056 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004057 // A name that is used by an import can not be overruled.
4058 if (import != NULL
4059 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004060 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004061 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004063 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004064 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004065 else
4066 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 goto erret;
4068 }
4069 if (fp->uf_calls > 0)
4070 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004071 emsg_funcname(
4072 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 name);
4074 goto erret;
4075 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004076 if (fp->uf_refcount > 1)
4077 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004078 // This function is referenced somewhere, don't redefine it but
4079 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004080 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004081 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004082 fp = NULL;
4083 overwrite = TRUE;
4084 }
4085 else
4086 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004087 char_u *exp_name = fp->uf_name_exp;
4088
4089 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004090 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004091 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004092 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004093 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004094 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004095#ifdef FEAT_PROFILE
4096 fp->uf_profiling = FALSE;
4097 fp->uf_prof_initialized = FALSE;
4098#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004099 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004100 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 }
4102 }
4103 else
4104 {
4105 char numbuf[20];
4106
4107 fp = NULL;
4108 if (fudi.fd_newkey == NULL && !eap->forceit)
4109 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004110 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 goto erret;
4112 }
4113 if (fudi.fd_di == NULL)
4114 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004115 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004116 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 goto erret;
4118 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004119 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004120 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121 goto erret;
4122
Bram Moolenaare38eab22019-12-05 21:50:01 +01004123 // Give the function a sequential number. Can only be used with a
4124 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004125 vim_free(name);
4126 sprintf(numbuf, "%d", ++func_nr);
4127 name = vim_strsave((char_u *)numbuf);
4128 if (name == NULL)
4129 goto erret;
4130 }
4131
4132 if (fp == NULL)
4133 {
4134 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4135 {
4136 int slen, plen;
4137 char_u *scriptname;
4138
Bram Moolenaare38eab22019-12-05 21:50:01 +01004139 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004141 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004142 {
4143 scriptname = autoload_name(name);
4144 if (scriptname != NULL)
4145 {
4146 p = vim_strchr(scriptname, '/');
4147 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004148 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004149 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004150 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151 j = OK;
4152 vim_free(scriptname);
4153 }
4154 }
4155 if (j == FAIL)
4156 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004157 linenr_T save_lnum = SOURCING_LNUM;
4158
4159 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004160 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004161 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162 goto erret;
4163 }
4164 }
4165
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004166 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 if (fp == NULL)
4168 goto erret;
4169
4170 if (fudi.fd_dict != NULL)
4171 {
4172 if (fudi.fd_di == NULL)
4173 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004174 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4176 if (fudi.fd_di == NULL)
4177 {
4178 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004179 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004180 goto erret;
4181 }
4182 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4183 {
4184 vim_free(fudi.fd_di);
4185 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004186 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 goto erret;
4188 }
4189 }
4190 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004191 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 clear_tv(&fudi.fd_di->di_tv);
4193 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195
Bram Moolenaare38eab22019-12-05 21:50:01 +01004196 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 flags |= FC_DICT;
4198 }
4199
Bram Moolenaare38eab22019-12-05 21:50:01 +01004200 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004201 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004202 if (overwrite)
4203 {
4204 hi = hash_find(&func_hashtab, name);
4205 hi->hi_key = UF2HIKEY(fp);
4206 }
4207 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 {
4209 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004210 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 goto erret;
4212 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004213 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 }
4215 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004216 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004217 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004218 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004219
4220 if (eap->cmdidx == CMD_def)
4221 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004222 int lnum_save = SOURCING_LNUM;
4223 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004224
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004225 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004226
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004227 // error messages are for the first function line
4228 SOURCING_LNUM = sourcing_lnum_top;
4229
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004230 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004231 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004232 int count = cstack->cs_idx + 1;
4233 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004234
4235 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004236 // a block that is visible now but not when the function is called
4237 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004238 fp->uf_block_ids = ALLOC_MULT(int, count);
4239 if (fp->uf_block_ids != NULL)
4240 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004241 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004242 sizeof(int) * count);
4243 fp->uf_block_depth = count;
4244 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004245
4246 // Set flag in each block to indicate a function was defined. This
4247 // is used to keep the variable when leaving the block, see
4248 // hide_script_var().
4249 for (i = 0; i <= cstack->cs_idx; ++i)
4250 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004251 }
4252
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004253 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004254 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004255 SOURCING_LNUM = lnum_save;
4256 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004257 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004258 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004259
4260 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004261 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004262 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004263 SOURCING_LNUM = lnum_save;
4264 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004265 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004266 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004267 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004268 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004269 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004270
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004271 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004272 if ((flags & FC_CLOSURE) != 0)
4273 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004274 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004275 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004276 }
4277 else
4278 fp->uf_scoped = NULL;
4279
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281 if (prof_def_func())
4282 func_do_profile(fp);
4283#endif
4284 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004285 if (sandbox)
4286 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004287 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004288 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 fp->uf_flags = flags;
4290 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004291 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004292 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004293 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004294 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004295 if (is_export)
4296 {
4297 fp->uf_flags |= FC_EXPORT;
4298 // let ex_export() know the export worked.
4299 is_export = FALSE;
4300 }
4301
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004302 if (eap->cmdidx == CMD_def)
4303 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004304 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4305 // :func does not use Vim9 script syntax, even in a Vim9 script file
4306 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004307
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 goto ret_free;
4309
4310erret:
4311 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004312 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004313 if (fp != NULL)
4314 {
4315 ga_init(&fp->uf_args);
4316 ga_init(&fp->uf_def_args);
4317 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318errret_2:
4319 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004320 if (fp != NULL)
4321 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004323 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004324 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004326 if (name != name_arg)
4327 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004328 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004330
4331 return fp;
4332}
4333
4334/*
4335 * ":function"
4336 */
4337 void
4338ex_function(exarg_T *eap)
4339{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004340 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004341}
4342
4343/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004344 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004345 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004346 */
4347 void
4348ex_defcompile(exarg_T *eap UNUSED)
4349{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004350 long todo = (long)func_hashtab.ht_used;
4351 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004352 hashitem_T *hi;
4353 ufunc_T *ufunc;
4354
4355 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4356 {
4357 if (!HASHITEM_EMPTY(hi))
4358 {
4359 --todo;
4360 ufunc = HI2UF(hi);
4361 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004362 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4363 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004364 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004365 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004366
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004367 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004368 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004369 // a function has been added or removed, need to start over
4370 todo = (long)func_hashtab.ht_used;
4371 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004372 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004373 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004374 }
4375 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004376 }
4377 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378}
4379
4380/*
4381 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4382 * Return 2 if "p" starts with "s:".
4383 * Return 0 otherwise.
4384 */
4385 int
4386eval_fname_script(char_u *p)
4387{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004388 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4389 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4391 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4392 return 5;
4393 if (p[0] == 's' && p[1] == ':')
4394 return 2;
4395 return 0;
4396}
4397
4398 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004399translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400{
4401 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004402 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004403 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004404}
4405
4406/*
4407 * Return TRUE when "ufunc" has old-style "..." varargs
4408 * or named varargs "...name: type".
4409 */
4410 int
4411has_varargs(ufunc_T *ufunc)
4412{
4413 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414}
4415
4416/*
4417 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004418 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 */
4420 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004421function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004422{
4423 char_u *nm = name;
4424 char_u *p;
4425 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004426 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004427 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004429 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4430 if (no_deref)
4431 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004432 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 nm = skipwhite(nm);
4434
Bram Moolenaare38eab22019-12-05 21:50:01 +01004435 // Only accept "funcname", "funcname ", "funcname (..." and
4436 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004438 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 vim_free(p);
4440 return n;
4441}
4442
Bram Moolenaar113e1072019-01-20 15:30:40 +01004443#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004444 char_u *
4445get_expanded_name(char_u *name, int check)
4446{
4447 char_u *nm = name;
4448 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004449 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004451 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004452 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004454 if (p != NULL && *nm == NUL
4455 && (!check || translated_function_exists(p, is_global)))
4456 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457
4458 vim_free(p);
4459 return NULL;
4460}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004461#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004463/*
4464 * Function given to ExpandGeneric() to obtain the list of user defined
4465 * function names.
4466 */
4467 char_u *
4468get_user_func_name(expand_T *xp, int idx)
4469{
4470 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004471 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 static hashitem_T *hi;
4473 ufunc_T *fp;
4474
4475 if (idx == 0)
4476 {
4477 done = 0;
4478 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004479 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004480 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004481 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482 {
4483 if (done++ > 0)
4484 ++hi;
4485 while (HASHITEM_EMPTY(hi))
4486 ++hi;
4487 fp = HI2UF(hi);
4488
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004489 // don't show dead, dict and lambda functions
4490 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004491 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004492 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493
4494 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004495 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496
4497 cat_func_name(IObuff, fp);
4498 if (xp->xp_context != EXPAND_USER_FUNC)
4499 {
4500 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004501 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502 STRCAT(IObuff, ")");
4503 }
4504 return IObuff;
4505 }
4506 return NULL;
4507}
4508
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509/*
4510 * ":delfunction {name}"
4511 */
4512 void
4513ex_delfunction(exarg_T *eap)
4514{
4515 ufunc_T *fp = NULL;
4516 char_u *p;
4517 char_u *name;
4518 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004519 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004520
4521 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004522 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4523 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524 vim_free(fudi.fd_newkey);
4525 if (name == NULL)
4526 {
4527 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004528 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004529 return;
4530 }
4531 if (!ends_excmd(*skipwhite(p)))
4532 {
4533 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004534 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 return;
4536 }
4537 eap->nextcmd = check_nextcmd(p);
4538 if (eap->nextcmd != NULL)
4539 *p = NUL;
4540
4541 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004542 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543 vim_free(name);
4544
4545 if (!eap->skip)
4546 {
4547 if (fp == NULL)
4548 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004549 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004550 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004551 return;
4552 }
4553 if (fp->uf_calls > 0)
4554 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004555 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004556 return;
4557 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004558 if (fp->uf_flags & FC_VIM9)
4559 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004560 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004561 return;
4562 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563
4564 if (fudi.fd_dict != NULL)
4565 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004566 // Delete the dict item that refers to the function, it will
4567 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4569 }
4570 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004571 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004572 // A normal function (not a numbered function or lambda) has a
4573 // refcount of 1 for the entry in the hashtable. When deleting
4574 // it and the refcount is more than one, it should be kept.
4575 // A numbered function and lambda should be kept if the refcount is
4576 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004577 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004578 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004579 // Function is still referenced somewhere. Don't free it but
4580 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004581 if (func_remove(fp))
4582 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004583 }
4584 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004585 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004586 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 }
4588}
4589
4590/*
4591 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004592 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 */
4594 void
4595func_unref(char_u *name)
4596{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004597 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004599 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004601 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004602 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004605 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004606#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004607 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004608 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004609 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004610}
4611
4612/*
4613 * Unreference a Function: decrement the reference count and free it when it
4614 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004615 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004616 */
4617 void
4618func_ptr_unref(ufunc_T *fp)
4619{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004620 if (fp != NULL && (--fp->uf_refcount <= 0
4621 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4622 && fp->uf_partial->pt_refcount <= 1
4623 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004624 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004625 // Only delete it when it's not being used. Otherwise it's done
4626 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004627 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004628 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004629 }
4630}
4631
4632/*
4633 * Count a reference to a Function.
4634 */
4635 void
4636func_ref(char_u *name)
4637{
4638 ufunc_T *fp;
4639
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004640 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004641 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004642 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004643 if (fp != NULL)
4644 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004646 // Only give an error for a numbered function.
4647 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004648 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004649}
4650
4651/*
4652 * Count a reference to a Function.
4653 */
4654 void
4655func_ptr_ref(ufunc_T *fp)
4656{
4657 if (fp != NULL)
4658 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659}
4660
4661/*
4662 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4663 * referenced from anywhere that is in use.
4664 */
4665 static int
4666can_free_funccal(funccall_T *fc, int copyID)
4667{
4668 return (fc->l_varlist.lv_copyID != copyID
4669 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004670 && fc->l_avars.dv_copyID != copyID
4671 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672}
4673
4674/*
4675 * ":return [expr]"
4676 */
4677 void
4678ex_return(exarg_T *eap)
4679{
4680 char_u *arg = eap->arg;
4681 typval_T rettv;
4682 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004683 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684
4685 if (current_funccal == NULL)
4686 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004687 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688 return;
4689 }
4690
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004691 CLEAR_FIELD(evalarg);
4692 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4693
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 if (eap->skip)
4695 ++emsg_skip;
4696
4697 eap->nextcmd = NULL;
4698 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004699 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004700 {
4701 if (!eap->skip)
4702 returning = do_return(eap, FALSE, TRUE, &rettv);
4703 else
4704 clear_tv(&rettv);
4705 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004706 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 else if (!eap->skip)
4708 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004709 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004710 update_force_abort();
4711
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004712 /*
4713 * Return unless the expression evaluation has been cancelled due to an
4714 * aborting error, an interrupt, or an exception.
4715 */
4716 if (!aborting())
4717 returning = do_return(eap, FALSE, TRUE, NULL);
4718 }
4719
Bram Moolenaare38eab22019-12-05 21:50:01 +01004720 // When skipping or the return gets pending, advance to the next command
4721 // in this line (!returning). Otherwise, ignore the rest of the line.
4722 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 if (returning)
4724 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004725 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726 eap->nextcmd = check_nextcmd(arg);
4727
4728 if (eap->skip)
4729 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004730 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731}
4732
4733/*
4734 * ":1,25call func(arg1, arg2)" function call.
4735 */
4736 void
4737ex_call(exarg_T *eap)
4738{
4739 char_u *arg = eap->arg;
4740 char_u *startarg;
4741 char_u *name;
4742 char_u *tofree;
4743 int len;
4744 typval_T rettv;
4745 linenr_T lnum;
4746 int doesrange;
4747 int failed = FALSE;
4748 funcdict_T fudi;
4749 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004750 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004751 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752
Bram Moolenaare6b53242020-07-01 17:28:33 +02004753 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 if (eap->skip)
4755 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004756 // trans_function_name() doesn't work well when skipping, use eval0()
4757 // instead to skip to any following command, e.g. for:
4758 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004759 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004760 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761 clear_tv(&rettv);
4762 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004763 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004764 return;
4765 }
4766
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004767 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4768 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 if (fudi.fd_newkey != NULL)
4770 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004771 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004772 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773 vim_free(fudi.fd_newkey);
4774 }
4775 if (tofree == NULL)
4776 return;
4777
Bram Moolenaare38eab22019-12-05 21:50:01 +01004778 // Increase refcount on dictionary, it could get deleted when evaluating
4779 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780 if (fudi.fd_dict != NULL)
4781 ++fudi.fd_dict->dv_refcount;
4782
Bram Moolenaare38eab22019-12-05 21:50:01 +01004783 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4784 // contents. For VAR_PARTIAL get its partial, unless we already have one
4785 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004787 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4788 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789
Bram Moolenaare38eab22019-12-05 21:50:01 +01004790 // Skip white space to allow ":call func ()". Not good, but required for
4791 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004792 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004793 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004794
4795 if (*startarg != '(')
4796 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004797 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004798 goto end;
4799 }
4800
4801 /*
4802 * When skipping, evaluate the function once, to find the end of the
4803 * arguments.
4804 * When the function takes a range, this is discovered after the first
4805 * call, and the loop is broken.
4806 */
4807 if (eap->skip)
4808 {
4809 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004810 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 }
4812 else
4813 lnum = eap->line1;
4814 for ( ; lnum <= eap->line2; ++lnum)
4815 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004816 funcexe_T funcexe;
4817
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818 if (!eap->skip && eap->addr_count > 0)
4819 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004820 if (lnum > curbuf->b_ml.ml_line_count)
4821 {
4822 // If the function deleted lines or switched to another buffer
4823 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004824 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004825 break;
4826 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 curwin->w_cursor.lnum = lnum;
4828 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004830 }
4831 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004832
Bram Moolenaara80faa82020-04-12 19:37:17 +02004833 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004834 funcexe.firstline = eap->line1;
4835 funcexe.lastline = eap->line2;
4836 funcexe.doesrange = &doesrange;
4837 funcexe.evaluate = !eap->skip;
4838 funcexe.partial = partial;
4839 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004840 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004841 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004842 {
4843 failed = TRUE;
4844 break;
4845 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004846 if (has_watchexpr())
4847 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004849 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004850 if (handle_subscript(&arg, &rettv,
4851 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004852 {
4853 failed = TRUE;
4854 break;
4855 }
4856
4857 clear_tv(&rettv);
4858 if (doesrange || eap->skip)
4859 break;
4860
Bram Moolenaare38eab22019-12-05 21:50:01 +01004861 // Stop when immediately aborting on error, or when an interrupt
4862 // occurred or an exception was thrown but not caught.
4863 // get_func_tv() returned OK, so that the check for trailing
4864 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004865 if (aborting())
4866 break;
4867 }
4868 if (eap->skip)
4869 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004870 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004871
Bram Moolenaare51bb172020-02-16 19:42:23 +01004872 // When inside :try we need to check for following "| catch".
4873 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004875 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004876 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004877 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004878 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004879 if (!failed)
4880 {
4881 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004882 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004883 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004884 }
4885 else
4886 eap->nextcmd = check_nextcmd(arg);
4887 }
4888
4889end:
4890 dict_unref(fudi.fd_dict);
4891 vim_free(tofree);
4892}
4893
4894/*
4895 * Return from a function. Possibly makes the return pending. Also called
4896 * for a pending return at the ":endtry" or after returning from an extra
4897 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4898 * when called due to a ":return" command. "rettv" may point to a typval_T
4899 * with the return rettv. Returns TRUE when the return can be carried out,
4900 * FALSE when the return gets pending.
4901 */
4902 int
4903do_return(
4904 exarg_T *eap,
4905 int reanimate,
4906 int is_cmd,
4907 void *rettv)
4908{
4909 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004910 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911
4912 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004913 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914 current_funccal->returned = FALSE;
4915
4916 /*
4917 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4918 * not in its finally clause (which then is to be executed next) is found.
4919 * In this case, make the ":return" pending for execution at the ":endtry".
4920 * Otherwise, return normally.
4921 */
4922 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4923 if (idx >= 0)
4924 {
4925 cstack->cs_pending[idx] = CSTP_RETURN;
4926
4927 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004928 // A pending return again gets pending. "rettv" points to an
4929 // allocated variable with the rettv of the original ":return"'s
4930 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 cstack->cs_rettv[idx] = rettv;
4932 else
4933 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004934 // When undoing a return in order to make it pending, get the stored
4935 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936 if (reanimate)
4937 rettv = current_funccal->rettv;
4938
4939 if (rettv != NULL)
4940 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004941 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4943 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4944 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004945 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 }
4947 else
4948 cstack->cs_rettv[idx] = NULL;
4949
4950 if (reanimate)
4951 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004952 // The pending return value could be overwritten by a ":return"
4953 // without argument in a finally clause; reset the default
4954 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955 current_funccal->rettv->v_type = VAR_NUMBER;
4956 current_funccal->rettv->vval.v_number = 0;
4957 }
4958 }
4959 report_make_pending(CSTP_RETURN, rettv);
4960 }
4961 else
4962 {
4963 current_funccal->returned = TRUE;
4964
Bram Moolenaare38eab22019-12-05 21:50:01 +01004965 // If the return is carried out now, store the return value. For
4966 // a return immediately after reanimation, the value is already
4967 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004968 if (!reanimate && rettv != NULL)
4969 {
4970 clear_tv(current_funccal->rettv);
4971 *current_funccal->rettv = *(typval_T *)rettv;
4972 if (!is_cmd)
4973 vim_free(rettv);
4974 }
4975 }
4976
4977 return idx < 0;
4978}
4979
4980/*
4981 * Free the variable with a pending return value.
4982 */
4983 void
4984discard_pending_return(void *rettv)
4985{
4986 free_tv((typval_T *)rettv);
4987}
4988
4989/*
4990 * Generate a return command for producing the value of "rettv". The result
4991 * is an allocated string. Used by report_pending() for verbose messages.
4992 */
4993 char_u *
4994get_return_cmd(void *rettv)
4995{
4996 char_u *s = NULL;
4997 char_u *tofree = NULL;
4998 char_u numbuf[NUMBUFLEN];
4999
5000 if (rettv != NULL)
5001 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5002 if (s == NULL)
5003 s = (char_u *)"";
5004
5005 STRCPY(IObuff, ":return ");
5006 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5007 if (STRLEN(s) + 8 >= IOSIZE)
5008 STRCPY(IObuff + IOSIZE - 4, "...");
5009 vim_free(tofree);
5010 return vim_strsave(IObuff);
5011}
5012
5013/*
5014 * Get next function line.
5015 * Called by do_cmdline() to get the next line.
5016 * Returns allocated string, or NULL for end of function.
5017 */
5018 char_u *
5019get_func_line(
5020 int c UNUSED,
5021 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005022 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005023 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005024{
5025 funccall_T *fcp = (funccall_T *)cookie;
5026 ufunc_T *fp = fcp->func;
5027 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005028 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005029
Bram Moolenaare38eab22019-12-05 21:50:01 +01005030 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005031 if (fcp->dbg_tick != debug_tick)
5032 {
5033 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005034 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005035 fcp->dbg_tick = debug_tick;
5036 }
5037#ifdef FEAT_PROFILE
5038 if (do_profiling == PROF_YES)
5039 func_line_end(cookie);
5040#endif
5041
5042 gap = &fp->uf_lines;
5043 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5044 || fcp->returned)
5045 retval = NULL;
5046 else
5047 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005048 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005049 while (fcp->linenr < gap->ga_len
5050 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5051 ++fcp->linenr;
5052 if (fcp->linenr >= gap->ga_len)
5053 retval = NULL;
5054 else
5055 {
5056 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005057 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005058#ifdef FEAT_PROFILE
5059 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005060 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005061#endif
5062 }
5063 }
5064
Bram Moolenaare38eab22019-12-05 21:50:01 +01005065 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005066 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005068 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005069 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005070 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005071 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005072 fcp->dbg_tick = debug_tick;
5073 }
5074
5075 return retval;
5076}
5077
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005078/*
5079 * Return TRUE if the currently active function should be ended, because a
5080 * return was encountered or an error occurred. Used inside a ":while".
5081 */
5082 int
5083func_has_ended(void *cookie)
5084{
5085 funccall_T *fcp = (funccall_T *)cookie;
5086
Bram Moolenaare38eab22019-12-05 21:50:01 +01005087 // Ignore the "abort" flag if the abortion behavior has been changed due to
5088 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005089 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5090 || fcp->returned);
5091}
5092
5093/*
5094 * return TRUE if cookie indicates a function which "abort"s on errors.
5095 */
5096 int
5097func_has_abort(
5098 void *cookie)
5099{
5100 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5101}
5102
5103
5104/*
5105 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5106 * Don't do this when "Func" is already a partial that was bound
5107 * explicitly (pt_auto is FALSE).
5108 * Changes "rettv" in-place.
5109 * Returns the updated "selfdict_in".
5110 */
5111 dict_T *
5112make_partial(dict_T *selfdict_in, typval_T *rettv)
5113{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005114 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115 char_u *tofree = NULL;
5116 ufunc_T *fp;
5117 char_u fname_buf[FLEN_FIXED + 1];
5118 int error;
5119 dict_T *selfdict = selfdict_in;
5120
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005121 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5122 fp = rettv->vval.v_partial->pt_func;
5123 else
5124 {
5125 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5126 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005127 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005128 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005129 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005130 vim_free(tofree);
5131 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005132
5133 if (fp != NULL && (fp->uf_flags & FC_DICT))
5134 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005135 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005136
5137 if (pt != NULL)
5138 {
5139 pt->pt_refcount = 1;
5140 pt->pt_dict = selfdict;
5141 pt->pt_auto = TRUE;
5142 selfdict = NULL;
5143 if (rettv->v_type == VAR_FUNC)
5144 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005145 // Just a function: Take over the function name and use
5146 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147 pt->pt_name = rettv->vval.v_string;
5148 }
5149 else
5150 {
5151 partial_T *ret_pt = rettv->vval.v_partial;
5152 int i;
5153
Bram Moolenaare38eab22019-12-05 21:50:01 +01005154 // Partial: copy the function name, use selfdict and copy
5155 // args. Can't take over name or args, the partial might
5156 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005157 if (ret_pt->pt_name != NULL)
5158 {
5159 pt->pt_name = vim_strsave(ret_pt->pt_name);
5160 func_ref(pt->pt_name);
5161 }
5162 else
5163 {
5164 pt->pt_func = ret_pt->pt_func;
5165 func_ptr_ref(pt->pt_func);
5166 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005167 if (ret_pt->pt_argc > 0)
5168 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005169 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005170 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005171 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172 pt->pt_argc = 0;
5173 else
5174 {
5175 pt->pt_argc = ret_pt->pt_argc;
5176 for (i = 0; i < pt->pt_argc; i++)
5177 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5178 }
5179 }
5180 partial_unref(ret_pt);
5181 }
5182 rettv->v_type = VAR_PARTIAL;
5183 rettv->vval.v_partial = pt;
5184 }
5185 }
5186 return selfdict;
5187}
5188
5189/*
5190 * Return the name of the executed function.
5191 */
5192 char_u *
5193func_name(void *cookie)
5194{
5195 return ((funccall_T *)cookie)->func->uf_name;
5196}
5197
5198/*
5199 * Return the address holding the next breakpoint line for a funccall cookie.
5200 */
5201 linenr_T *
5202func_breakpoint(void *cookie)
5203{
5204 return &((funccall_T *)cookie)->breakpoint;
5205}
5206
5207/*
5208 * Return the address holding the debug tick for a funccall cookie.
5209 */
5210 int *
5211func_dbg_tick(void *cookie)
5212{
5213 return &((funccall_T *)cookie)->dbg_tick;
5214}
5215
5216/*
5217 * Return the nesting level for a funccall cookie.
5218 */
5219 int
5220func_level(void *cookie)
5221{
5222 return ((funccall_T *)cookie)->level;
5223}
5224
5225/*
5226 * Return TRUE when a function was ended by a ":return" command.
5227 */
5228 int
5229current_func_returned(void)
5230{
5231 return current_funccal->returned;
5232}
5233
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005234 int
5235free_unref_funccal(int copyID, int testing)
5236{
5237 int did_free = FALSE;
5238 int did_free_funccal = FALSE;
5239 funccall_T *fc, **pfc;
5240
5241 for (pfc = &previous_funccal; *pfc != NULL; )
5242 {
5243 if (can_free_funccal(*pfc, copyID))
5244 {
5245 fc = *pfc;
5246 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005247 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005248 did_free = TRUE;
5249 did_free_funccal = TRUE;
5250 }
5251 else
5252 pfc = &(*pfc)->caller;
5253 }
5254 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005255 // When a funccal was freed some more items might be garbage
5256 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257 (void)garbage_collect(testing);
5258
5259 return did_free;
5260}
5261
5262/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005263 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005264 */
5265 static funccall_T *
5266get_funccal(void)
5267{
5268 int i;
5269 funccall_T *funccal;
5270 funccall_T *temp_funccal;
5271
5272 funccal = current_funccal;
5273 if (debug_backtrace_level > 0)
5274 {
5275 for (i = 0; i < debug_backtrace_level; i++)
5276 {
5277 temp_funccal = funccal->caller;
5278 if (temp_funccal)
5279 funccal = temp_funccal;
5280 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005281 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005282 debug_backtrace_level = i;
5283 }
5284 }
5285 return funccal;
5286}
5287
5288/*
5289 * Return the hashtable used for local variables in the current funccal.
5290 * Return NULL if there is no current funccal.
5291 */
5292 hashtab_T *
5293get_funccal_local_ht()
5294{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005295 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005296 return NULL;
5297 return &get_funccal()->l_vars.dv_hashtab;
5298}
5299
5300/*
5301 * Return the l: scope variable.
5302 * Return NULL if there is no current funccal.
5303 */
5304 dictitem_T *
5305get_funccal_local_var()
5306{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005307 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005308 return NULL;
5309 return &get_funccal()->l_vars_var;
5310}
5311
5312/*
5313 * Return the hashtable used for argument in the current funccal.
5314 * Return NULL if there is no current funccal.
5315 */
5316 hashtab_T *
5317get_funccal_args_ht()
5318{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005319 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005320 return NULL;
5321 return &get_funccal()->l_avars.dv_hashtab;
5322}
5323
5324/*
5325 * Return the a: scope variable.
5326 * Return NULL if there is no current funccal.
5327 */
5328 dictitem_T *
5329get_funccal_args_var()
5330{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005331 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005332 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005333 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005334}
5335
5336/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337 * List function variables, if there is a function.
5338 */
5339 void
5340list_func_vars(int *first)
5341{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005342 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005343 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005344 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005345}
5346
5347/*
5348 * If "ht" is the hashtable for local variables in the current funccal, return
5349 * the dict that contains it.
5350 * Otherwise return NULL.
5351 */
5352 dict_T *
5353get_current_funccal_dict(hashtab_T *ht)
5354{
5355 if (current_funccal != NULL
5356 && ht == &current_funccal->l_vars.dv_hashtab)
5357 return &current_funccal->l_vars;
5358 return NULL;
5359}
5360
5361/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005362 * Search hashitem in parent scope.
5363 */
5364 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005365find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005366{
5367 funccall_T *old_current_funccal = current_funccal;
5368 hashtab_T *ht;
5369 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005370 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005371
5372 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5373 return NULL;
5374
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005375 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005376 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005377 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005378 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005379 ht = find_var_ht(name, &varname);
5380 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005381 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005382 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005383 if (!HASHITEM_EMPTY(hi))
5384 {
5385 *pht = ht;
5386 break;
5387 }
5388 }
5389 if (current_funccal == current_funccal->func->uf_scoped)
5390 break;
5391 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005392 }
5393 current_funccal = old_current_funccal;
5394
5395 return hi;
5396}
5397
5398/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005399 * Search variable in parent scope.
5400 */
5401 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005402find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005403{
5404 dictitem_T *v = NULL;
5405 funccall_T *old_current_funccal = current_funccal;
5406 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005407 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005408
5409 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5410 return NULL;
5411
Bram Moolenaare38eab22019-12-05 21:50:01 +01005412 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005413 current_funccal = current_funccal->func->uf_scoped;
5414 while (current_funccal)
5415 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005416 ht = find_var_ht(name, &varname);
5417 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005418 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005419 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005420 if (v != NULL)
5421 break;
5422 }
5423 if (current_funccal == current_funccal->func->uf_scoped)
5424 break;
5425 current_funccal = current_funccal->func->uf_scoped;
5426 }
5427 current_funccal = old_current_funccal;
5428
5429 return v;
5430}
5431
5432/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005433 * Set "copyID + 1" in previous_funccal and callers.
5434 */
5435 int
5436set_ref_in_previous_funccal(int copyID)
5437{
5438 int abort = FALSE;
5439 funccall_T *fc;
5440
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005441 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005443 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005444 abort = abort
5445 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5446 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005447 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005448 }
5449 return abort;
5450}
5451
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005452 static int
5453set_ref_in_funccal(funccall_T *fc, int copyID)
5454{
5455 int abort = FALSE;
5456
5457 if (fc->fc_copyID != copyID)
5458 {
5459 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005460 abort = abort
5461 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5462 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005463 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005464 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005465 }
5466 return abort;
5467}
5468
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005469/*
5470 * Set "copyID" in all local vars and arguments in the call stack.
5471 */
5472 int
5473set_ref_in_call_stack(int copyID)
5474{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005475 int abort = FALSE;
5476 funccall_T *fc;
5477 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005478
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005479 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005480 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005481
5482 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005483 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5484 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005485 abort = abort || set_ref_in_funccal(fc, copyID);
5486
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005487 return abort;
5488}
5489
5490/*
5491 * Set "copyID" in all functions available by name.
5492 */
5493 int
5494set_ref_in_functions(int copyID)
5495{
5496 int todo;
5497 hashitem_T *hi = NULL;
5498 int abort = FALSE;
5499 ufunc_T *fp;
5500
5501 todo = (int)func_hashtab.ht_used;
5502 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005503 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005504 if (!HASHITEM_EMPTY(hi))
5505 {
5506 --todo;
5507 fp = HI2UF(hi);
5508 if (!func_name_refcount(fp->uf_name))
5509 abort = abort || set_ref_in_func(NULL, fp, copyID);
5510 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005511 }
5512 return abort;
5513}
5514
5515/*
5516 * Set "copyID" in all function arguments.
5517 */
5518 int
5519set_ref_in_func_args(int copyID)
5520{
5521 int i;
5522 int abort = FALSE;
5523
5524 for (i = 0; i < funcargs.ga_len; ++i)
5525 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5526 copyID, NULL, NULL);
5527 return abort;
5528}
5529
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005530/*
5531 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005532 * Returns TRUE if setting references failed somehow.
5533 */
5534 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005535set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005536{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005537 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005538 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005539 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005540 char_u fname_buf[FLEN_FIXED + 1];
5541 char_u *tofree = NULL;
5542 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005543 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005544
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005545 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005546 return FALSE;
5547
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005548 if (fp_in == NULL)
5549 {
5550 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005551 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005552 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005553 if (fp != NULL)
5554 {
5555 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005556 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005557 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005558
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005559 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005560 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005561}
5562
Bram Moolenaare38eab22019-12-05 21:50:01 +01005563#endif // FEAT_EVAL