blob: 81a73e280314717dd06b23ca617317e3e94afde0 [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.
58 * If "argtypes" is not NULL also get the type: "arg: type".
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 Moolenaarb4d16cb2020-11-05 18:45:46 +010071 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072{
Bram Moolenaar6e949782020-04-13 17:21:00 +020073 char_u *p = arg;
74 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010075
76 while (ASCII_ISALNUM(*p) || *p == '_')
77 ++p;
78 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020079 || (argtypes == NULL
80 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
81 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010082 {
83 if (!skip)
84 semsg(_("E125: Illegal argument: %s"), arg);
85 return arg;
86 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010087
Bram Moolenaar057e84a2021-02-28 16:55:11 +010088 // Vim9 script: cannot use script var name for argument. In function: also
89 // check local vars and arguments.
90 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
91 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010092 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010093
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010094 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
95 return arg;
96 if (newargs != NULL)
97 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010098 int c;
99 int i;
100
101 c = *p;
102 *p = NUL;
103 arg_copy = vim_strsave(arg);
104 if (arg_copy == NULL)
105 {
106 *p = c;
107 return arg;
108 }
109
110 // Check for duplicate argument name.
111 for (i = 0; i < newargs->ga_len; ++i)
112 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
113 {
114 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
115 vim_free(arg_copy);
116 return arg;
117 }
118 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
119 newargs->ga_len++;
120
121 *p = c;
122 }
123
124 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100125 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100126 {
127 char_u *type = NULL;
128
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
130 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200131 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 arg_copy == NULL ? arg : arg_copy);
133 p = skipwhite(p);
134 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100135 if (*p == ':')
136 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200137 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100138 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200139 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100140 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200141 return arg;
142 }
143 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200144 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100145 if (!skip)
146 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100147 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200149 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200150 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200151 arg_copy == NULL ? arg : arg_copy);
152 return arg;
153 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100154 if (!skip)
155 {
156 if (type == NULL && types_optional)
157 // lambda arguments default to "any" type
158 type = vim_strsave((char_u *)"any");
159 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
160 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100161 }
162
163 return p;
164}
165
166/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200167 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100168 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100169 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200170 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100171 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200172get_function_args(
173 char_u **argp,
174 char_u endchar,
175 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100176 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100177 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100178 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200179 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200180 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200181 int skip,
182 exarg_T *eap,
183 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200184{
185 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100186 char_u *arg;
187 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200189 int any_default = FALSE;
190 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100191 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200192
193 if (newargs != NULL)
194 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100195 if (argtypes != NULL)
196 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200197 if (default_args != NULL)
198 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200199
200 if (varargs != NULL)
201 *varargs = FALSE;
202
203 /*
204 * Isolate the arguments: "arg1, arg2, ...)"
205 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100206 arg = skipwhite(*argp);
207 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200208 while (*p != endchar)
209 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200210 while (eap != NULL && eap->getline != NULL
211 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200212 {
213 char_u *theline;
214
215 // End of the line, get the next one.
216 theline = eap->getline(':', eap->cookie, 0, TRUE);
217 if (theline == NULL)
218 break;
219 vim_free(*line_to_free);
220 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200221 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200222 p = skipwhite(theline);
223 }
224
225 if (mustend && *p != endchar)
226 {
227 if (!skip)
228 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100229 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200230 }
231 if (*p == endchar)
232 break;
233
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200234 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
235 {
236 if (varargs != NULL)
237 *varargs = TRUE;
238 p += 3;
239 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100240
241 if (argtypes != NULL)
242 {
243 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200244 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100245 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100246 if (!skip)
247 emsg(_(e_missing_name_after_dots));
248 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100249 }
250
251 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100252 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100253 evalarg, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100254 if (p == arg)
255 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100256 if (*skipwhite(p) == '=')
257 {
258 emsg(_(e_cannot_use_default_for_variable_arguments));
259 break;
260 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100261 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200262 }
263 else
264 {
265 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100266 p = one_function_arg(p, newargs, argtypes, types_optional,
267 evalarg, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100268 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200269 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200270
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200271 if (*skipwhite(p) == '=' && default_args != NULL)
272 {
273 typval_T rettv;
274
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100275 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200276 any_default = TRUE;
277 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200278 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200279 p = skipwhite(p);
280 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200281 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200282 {
283 if (ga_grow(default_args, 1) == FAIL)
284 goto err_ret;
285
286 // trim trailing whitespace
287 while (p > expr && VIM_ISWHITE(p[-1]))
288 p--;
289 c = *p;
290 *p = NUL;
291 expr = vim_strsave(expr);
292 if (expr == NULL)
293 {
294 *p = c;
295 goto err_ret;
296 }
297 ((char_u **)(default_args->ga_data))
298 [default_args->ga_len] = expr;
299 default_args->ga_len++;
300 *p = c;
301 }
302 else
303 mustend = TRUE;
304 }
305 else if (any_default)
306 {
307 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200308 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200309 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200310
311 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
312 {
313 // Be tolerant when skipping
314 if (!skip)
315 {
316 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
317 goto err_ret;
318 }
319 p = skipwhite(p);
320 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200321 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200322 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200324 // Don't give this error when skipping, it makes the "->" not
325 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100326 // Allow missing space after comma in legacy functions.
327 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200328 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
329 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100330 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200331 goto err_ret;
332 }
333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200334 else
335 mustend = TRUE;
336 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200337 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200338 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200339 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200340
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200341 if (*p != endchar)
342 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100343 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200344
345 *argp = p;
346 return OK;
347
348err_ret:
349 if (newargs != NULL)
350 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200351 if (default_args != NULL)
352 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200353 return FAIL;
354}
355
356/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100357 * Parse the argument types, filling "fp->uf_arg_types".
358 * Return OK or FAIL.
359 */
360 static int
361parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
362{
363 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
364 if (argtypes->ga_len > 0)
365 {
366 // When "varargs" is set the last name/type goes into uf_va_name
367 // and uf_va_type.
368 int len = argtypes->ga_len - (varargs ? 1 : 0);
369
370 if (len > 0)
371 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
372 if (fp->uf_arg_types != NULL)
373 {
374 int i;
375 type_T *type;
376
377 for (i = 0; i < len; ++ i)
378 {
379 char_u *p = ((char_u **)argtypes->ga_data)[i];
380
381 if (p == NULL)
382 // will get the type from the default value
383 type = &t_unknown;
384 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100385 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100386 if (type == NULL)
387 return FAIL;
388 fp->uf_arg_types[i] = type;
389 }
390 }
391 if (varargs)
392 {
393 char_u *p;
394
395 // Move the last argument "...name: type" to uf_va_name and
396 // uf_va_type.
397 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
398 [fp->uf_args.ga_len - 1];
399 --fp->uf_args.ga_len;
400 p = ((char_u **)argtypes->ga_data)[len];
401 if (p == NULL)
402 // todo: get type from default value
403 fp->uf_va_type = &t_any;
404 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100405 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 if (fp->uf_va_type == NULL)
407 return FAIL;
408 }
409 }
410 return OK;
411}
412
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100413 static int
414parse_return_type(ufunc_T *fp, char_u *ret_type)
415{
416 if (ret_type == NULL)
417 fp->uf_ret_type = &t_void;
418 else
419 {
420 char_u *p = ret_type;
421
422 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
423 if (fp->uf_ret_type == NULL)
424 {
425 fp->uf_ret_type = &t_void;
426 return FAIL;
427 }
428 }
429 return OK;
430}
431
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100432/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200433 * Register function "fp" as using "current_funccal" as its scope.
434 */
435 static int
436register_closure(ufunc_T *fp)
437{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200438 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100439 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200440 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200441 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200442 fp->uf_scoped = current_funccal;
443 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200444
Bram Moolenaar58016442016-07-31 18:30:22 +0200445 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
446 return FAIL;
447 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
448 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200449 return OK;
450}
451
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100452 static void
453set_ufunc_name(ufunc_T *fp, char_u *name)
454{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100455 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
456 // actually extends beyond the struct.
457 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100458
459 if (name[0] == K_SPECIAL)
460 {
461 fp->uf_name_exp = alloc(STRLEN(name) + 3);
462 if (fp->uf_name_exp != NULL)
463 {
464 STRCPY(fp->uf_name_exp, "<SNR>");
465 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
466 }
467 }
468}
469
Bram Moolenaar58016442016-07-31 18:30:22 +0200470/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200471 * Get a name for a lambda. Returned in static memory.
472 */
473 char_u *
474get_lambda_name(void)
475{
476 static char_u name[30];
477 static int lambda_no = 0;
478
479 sprintf((char*)name, "<lambda>%d", ++lambda_no);
480 return name;
481}
482
Bram Moolenaar801ab062020-06-25 19:27:56 +0200483#if defined(FEAT_LUA) || defined(PROTO)
484/*
485 * Registers a native C callback which can be called from Vim script.
486 * Returns the name of the Vim script function.
487 */
488 char_u *
489register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
490{
491 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200492 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200493
494 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
495 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200496 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200497
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200498 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200499 fp->uf_refcount = 1;
500 fp->uf_varargs = TRUE;
501 fp->uf_flags = FC_CFUNC;
502 fp->uf_calls = 0;
503 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200504 fp->uf_cb = cb;
505 fp->uf_cb_free = cb_free;
506 fp->uf_cb_state = state;
507
508 set_ufunc_name(fp, name);
509 hash_add(&func_hashtab, UF2HIKEY(fp));
510
511 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200512}
513#endif
514
Bram Moolenaar04b12692020-05-04 23:24:44 +0200515/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100516 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100517 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100518 * If "white_error" is not NULL check for correct use of white space and set
519 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100520 * Return NULL if no valid arrow found.
521 */
522 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100523skip_arrow(
524 char_u *start,
525 int equal_arrow,
526 char_u **ret_type,
527 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100528{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100529 char_u *s = start;
530 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100531
532 if (equal_arrow)
533 {
534 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100535 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100536 if (white_error != NULL && !VIM_ISWHITE(s[1]))
537 {
538 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100539 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100540 return NULL;
541 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100542 s = skipwhite(s + 1);
543 *ret_type = s;
544 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100545 if (s == *ret_type)
546 {
547 emsg(_(e_missing_return_type));
548 return NULL;
549 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100550 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100551 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100552 s = skipwhite(s);
553 if (*s != '=')
554 return NULL;
555 ++s;
556 }
557 if (*s != '>')
558 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100559 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
560 || !IS_WHITE_OR_NUL(s[1])))
561 {
562 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100563 semsg(_(e_white_space_required_before_and_after_str_at_str),
564 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 return NULL;
566 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100567 return skipwhite(s + 1);
568}
569
570/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100571 * Check if "*cmd" points to a function command and if so advance "*cmd" and
572 * return TRUE.
573 * Otherwise return FALSE;
574 * Do not consider "function(" to be a command.
575 */
576 static int
577is_function_cmd(char_u **cmd)
578{
579 char_u *p = *cmd;
580
581 if (checkforcmd(&p, "function", 2))
582 {
583 if (*p == '(')
584 return FALSE;
585 *cmd = p;
586 return TRUE;
587 }
588 return FALSE;
589}
590
591/*
592 * Read the body of a function, put every line in "newlines".
593 * "newlines" must already have been initialized.
594 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
595 */
596 static int
597get_function_body(
598 exarg_T *eap,
599 garray_T *newlines,
600 char_u *line_arg_in,
601 char_u **line_to_free)
602{
603 linenr_T sourcing_lnum_top = SOURCING_LNUM;
604 linenr_T sourcing_lnum_off;
605 int saved_wait_return = need_wait_return;
606 char_u *line_arg = line_arg_in;
607 int vim9_function = eap->cmdidx == CMD_def
608 || eap->cmdidx == CMD_block;
609#define MAX_FUNC_NESTING 50
610 char nesting_def[MAX_FUNC_NESTING];
611 int nesting = 0;
612 getline_opt_T getline_options;
613 int indent = 2;
614 char_u *skip_until = NULL;
615 int ret = FAIL;
616 int is_heredoc = FALSE;
617 char_u *heredoc_trimmed = NULL;
618
619 // Detect having skipped over comment lines to find the return
620 // type. Add NULL lines to keep the line count correct.
621 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
622 if (SOURCING_LNUM < sourcing_lnum_off)
623 {
624 sourcing_lnum_off -= SOURCING_LNUM;
625 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
626 goto theend;
627 while (sourcing_lnum_off-- > 0)
628 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
629 }
630
631 nesting_def[nesting] = vim9_function;
632 getline_options = vim9_function
633 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
634 for (;;)
635 {
636 char_u *theline;
637 char_u *p;
638 char_u *arg;
639
640 if (KeyTyped)
641 {
642 msg_scroll = TRUE;
643 saved_wait_return = FALSE;
644 }
645 need_wait_return = FALSE;
646
647 if (line_arg != NULL)
648 {
649 // Use eap->arg, split up in parts by line breaks.
650 theline = line_arg;
651 p = vim_strchr(theline, '\n');
652 if (p == NULL)
653 line_arg += STRLEN(line_arg);
654 else
655 {
656 *p = NUL;
657 line_arg = p + 1;
658 }
659 }
660 else
661 {
662 vim_free(*line_to_free);
663 if (eap->getline == NULL)
664 theline = getcmdline(':', 0L, indent, getline_options);
665 else
666 theline = eap->getline(':', eap->cookie, indent,
667 getline_options);
668 *line_to_free = theline;
669 }
670 if (KeyTyped)
671 lines_left = Rows - 1;
672 if (theline == NULL)
673 {
674 // Use the start of the function for the line number.
675 SOURCING_LNUM = sourcing_lnum_top;
676 if (skip_until != NULL)
677 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
678 else if (eap->cmdidx == CMD_def)
679 emsg(_(e_missing_enddef));
680 else if (eap->cmdidx == CMD_block)
681 emsg(_(e_missing_end_block));
682 else
683 emsg(_("E126: Missing :endfunction"));
684 goto theend;
685 }
686
687 // Detect line continuation: SOURCING_LNUM increased more than one.
688 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
689 if (SOURCING_LNUM < sourcing_lnum_off)
690 sourcing_lnum_off -= SOURCING_LNUM;
691 else
692 sourcing_lnum_off = 0;
693
694 if (skip_until != NULL)
695 {
696 // Don't check for ":endfunc"/":enddef" between
697 // * ":append" and "."
698 // * ":python <<EOF" and "EOF"
699 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
700 if (heredoc_trimmed == NULL
701 || (is_heredoc && skipwhite(theline) == theline)
702 || STRNCMP(theline, heredoc_trimmed,
703 STRLEN(heredoc_trimmed)) == 0)
704 {
705 if (heredoc_trimmed == NULL)
706 p = theline;
707 else if (is_heredoc)
708 p = skipwhite(theline) == theline
709 ? theline : theline + STRLEN(heredoc_trimmed);
710 else
711 p = theline + STRLEN(heredoc_trimmed);
712 if (STRCMP(p, skip_until) == 0)
713 {
714 VIM_CLEAR(skip_until);
715 VIM_CLEAR(heredoc_trimmed);
716 getline_options = vim9_function
717 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
718 is_heredoc = FALSE;
719 }
720 }
721 }
722 else
723 {
724 int c;
725
726 // skip ':' and blanks
727 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
728 ;
729
730 // Check for "endfunction", "enddef" or "}".
731 // When a ":" follows it must be a dict key; "enddef: value,"
732 if ((nesting == 0 && eap->cmdidx == CMD_block)
733 ? *p == '}'
734 : (checkforcmd(&p, nesting_def[nesting]
735 ? "enddef" : "endfunction", 4)
736 && *p != ':'))
737 {
738 if (nesting-- == 0)
739 {
740 char_u *nextcmd = NULL;
741
742 if (*p == '|' || *p == '}')
743 nextcmd = p + 1;
744 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
745 nextcmd = line_arg;
746 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100747 && (vim9_function || p_verbose > 0))
748 {
749 if (eap->cmdidx == CMD_def)
750 semsg(_(e_text_found_after_enddef_str), p);
751 else
752 give_warning2((char_u *)
753 _("W22: Text found after :endfunction: %s"),
754 p, TRUE);
755 }
756 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100757 {
758 // Another command follows. If the line came from "eap"
759 // we can simply point into it, otherwise we need to
760 // change "eap->cmdlinep".
761 eap->nextcmd = nextcmd;
762 if (*line_to_free != NULL)
763 {
764 vim_free(*eap->cmdlinep);
765 *eap->cmdlinep = *line_to_free;
766 *line_to_free = NULL;
767 }
768 }
769 break;
770 }
771 }
772
773 // Check for mismatched "endfunc" or "enddef".
774 // We don't check for "def" inside "func" thus we also can't check
775 // for "enddef".
776 // We continue to find the end of the function, although we might
777 // not find it.
778 else if (nesting_def[nesting])
779 {
780 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
781 emsg(_(e_mismatched_endfunction));
782 }
783 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
784 emsg(_(e_mismatched_enddef));
785
786 // Increase indent inside "if", "while", "for" and "try", decrease
787 // at "end".
788 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
789 indent -= 2;
790 else if (STRNCMP(p, "if", 2) == 0
791 || STRNCMP(p, "wh", 2) == 0
792 || STRNCMP(p, "for", 3) == 0
793 || STRNCMP(p, "try", 3) == 0)
794 indent += 2;
795
796 // Check for defining a function inside this function.
797 // Only recognize "def" inside "def", not inside "function",
798 // For backwards compatibility, see Test_function_python().
799 c = *p;
800 if (is_function_cmd(&p)
801 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
802 {
803 if (*p == '!')
804 p = skipwhite(p + 1);
805 p += eval_fname_script(p);
806 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
807 NULL, NULL));
808 if (*skipwhite(p) == '(')
809 {
810 if (nesting == MAX_FUNC_NESTING - 1)
811 emsg(_(e_function_nesting_too_deep));
812 else
813 {
814 ++nesting;
815 nesting_def[nesting] = (c == 'd');
816 indent += 2;
817 }
818 }
819 }
820
821 // Check for ":append", ":change", ":insert". Not for :def.
822 p = skip_range(p, FALSE, NULL);
823 if (!vim9_function
824 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
825 || (p[0] == 'c'
826 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
827 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
828 && (STRNCMP(&p[3], "nge", 3) != 0
829 || !ASCII_ISALPHA(p[6])))))))
830 || (p[0] == 'i'
831 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
832 && (!ASCII_ISALPHA(p[2])
833 || (p[2] == 's'
834 && (!ASCII_ISALPHA(p[3])
835 || p[3] == 'e'))))))))
836 skip_until = vim_strsave((char_u *)".");
837
838 // Check for ":python <<EOF", ":tcl <<EOF", etc.
839 arg = skipwhite(skiptowhite(p));
840 if (arg[0] == '<' && arg[1] =='<'
841 && ((p[0] == 'p' && p[1] == 'y'
842 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
843 || ((p[2] == '3' || p[2] == 'x')
844 && !ASCII_ISALPHA(p[3]))))
845 || (p[0] == 'p' && p[1] == 'e'
846 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
847 || (p[0] == 't' && p[1] == 'c'
848 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
849 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
850 && !ASCII_ISALPHA(p[3]))
851 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
852 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
853 || (p[0] == 'm' && p[1] == 'z'
854 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
855 ))
856 {
857 // ":python <<" continues until a dot, like ":append"
858 p = skipwhite(arg + 2);
859 if (STRNCMP(p, "trim", 4) == 0)
860 {
861 // Ignore leading white space.
862 p = skipwhite(p + 4);
863 heredoc_trimmed = vim_strnsave(theline,
864 skipwhite(theline) - theline);
865 }
866 if (*p == NUL)
867 skip_until = vim_strsave((char_u *)".");
868 else
869 skip_until = vim_strnsave(p, skiptowhite(p) - p);
870 getline_options = GETLINE_NONE;
871 is_heredoc = TRUE;
872 }
873
874 // Check for ":cmd v =<< [trim] EOF"
875 // and ":cmd [a, b] =<< [trim] EOF"
876 // and "lines =<< [trim] EOF" for Vim9
877 // Where "cmd" can be "let", "var", "final" or "const".
878 arg = skipwhite(skiptowhite(p));
879 if (*arg == '[')
880 arg = vim_strchr(arg, ']');
881 if (arg != NULL)
882 {
883 int found = (eap->cmdidx == CMD_def && arg[0] == '='
884 && arg[1] == '<' && arg[2] =='<');
885
886 if (!found)
887 // skip over the argument after "cmd"
888 arg = skipwhite(skiptowhite(arg));
889 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
890 && (checkforcmd(&p, "let", 2)
891 || checkforcmd(&p, "var", 3)
892 || checkforcmd(&p, "final", 5)
893 || checkforcmd(&p, "const", 5))))
894 {
895 p = skipwhite(arg + 3);
896 if (STRNCMP(p, "trim", 4) == 0)
897 {
898 // Ignore leading white space.
899 p = skipwhite(p + 4);
900 heredoc_trimmed = vim_strnsave(theline,
901 skipwhite(theline) - theline);
902 }
903 skip_until = vim_strnsave(p, skiptowhite(p) - p);
904 getline_options = GETLINE_NONE;
905 is_heredoc = TRUE;
906 }
907 }
908 }
909
910 // Add the line to the function.
911 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
912 goto theend;
913
914 // Copy the line to newly allocated memory. get_one_sourceline()
915 // allocates 250 bytes per line, this saves 80% on average. The cost
916 // is an extra alloc/free.
917 p = vim_strsave(theline);
918 if (p == NULL)
919 goto theend;
920 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
921
922 // Add NULL lines for continuation lines, so that the line count is
923 // equal to the index in the growarray.
924 while (sourcing_lnum_off-- > 0)
925 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
926
927 // Check for end of eap->arg.
928 if (line_arg != NULL && *line_arg == NUL)
929 line_arg = NULL;
930 }
931
932 // Don't define the function when skipping commands or when an error was
933 // detected.
934 if (!eap->skip && !did_emsg)
935 ret = OK;
936
937theend:
938 vim_free(skip_until);
939 vim_free(heredoc_trimmed);
940 need_wait_return |= saved_wait_return;
941 return ret;
942}
943
944/*
945 * Handle the body of a lambda. *arg points to the "{", process statements
946 * until the matching "}".
947 * When successful "rettv" is set to a funcref.
948 */
949 static int
950lambda_function_body(
951 char_u **arg,
952 typval_T *rettv,
953 evalarg_T *evalarg,
954 garray_T *newargs,
955 garray_T *argtypes,
956 int varargs,
957 garray_T *default_args,
958 char_u *ret_type)
959{
960 int evaluate = evalarg != NULL
961 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +0100962 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100963 exarg_T eap;
964 garray_T newlines;
965 char_u *cmdline = NULL;
966 int ret = FAIL;
967 char_u *line_to_free = NULL;
968 partial_T *pt;
969 char_u *name;
970 int lnum_save = -1;
971 linenr_T sourcing_lnum_top = SOURCING_LNUM;
972
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100973 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
974 {
975 semsg(_(e_trailing_arg), *arg + 1);
976 return FAIL;
977 }
978
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100979 CLEAR_FIELD(eap);
980 eap.cmdidx = CMD_block;
981 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100982 eap.cmdlinep = &cmdline;
983 eap.skip = !evaluate;
984 if (evalarg->eval_cctx != NULL)
985 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
986 else
987 {
988 eap.getline = evalarg->eval_getline;
989 eap.cookie = evalarg->eval_cookie;
990 }
991
992 ga_init2(&newlines, (int)sizeof(char_u *), 10);
993 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100994 {
995 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100996 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100997 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100998 if (cmdline != NULL)
999 {
1000 // Something comes after the "}".
1001 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001002
1003 // "arg" points into cmdline, need to keep the line and free it later.
1004 vim_free(evalarg->eval_tofree_cmdline);
1005 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001006 }
1007 else
1008 *arg = (char_u *)"";
1009
1010 name = get_lambda_name();
1011 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1012 if (ufunc == NULL)
1013 goto erret;
1014 set_ufunc_name(ufunc, name);
1015 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001016 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001017 ufunc->uf_refcount = 1;
1018 ufunc->uf_args = *newargs;
1019 newargs->ga_data = NULL;
1020 ufunc->uf_def_args = *default_args;
1021 default_args->ga_data = NULL;
1022 ufunc->uf_func_type = &t_func_any;
1023
1024 // error messages are for the first function line
1025 lnum_save = SOURCING_LNUM;
1026 SOURCING_LNUM = sourcing_lnum_top;
1027
1028 // parse argument types
1029 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1030 {
1031 SOURCING_LNUM = lnum_save;
1032 goto erret;
1033 }
1034
1035 // parse the return type, if any
1036 if (parse_return_type(ufunc, ret_type) == FAIL)
1037 goto erret;
1038
1039 pt = ALLOC_CLEAR_ONE(partial_T);
1040 if (pt == NULL)
1041 goto erret;
1042 pt->pt_func = ufunc;
1043 pt->pt_refcount = 1;
1044
1045 ufunc->uf_lines = newlines;
1046 newlines.ga_data = NULL;
1047 if (sandbox)
1048 ufunc->uf_flags |= FC_SANDBOX;
1049 if (!ASCII_ISUPPER(*ufunc->uf_name))
1050 ufunc->uf_flags |= FC_VIM9;
1051 ufunc->uf_script_ctx = current_sctx;
1052 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1053 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1054 set_function_type(ufunc);
1055
1056 rettv->vval.v_partial = pt;
1057 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001058 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001059 ret = OK;
1060
1061erret:
1062 if (lnum_save >= 0)
1063 SOURCING_LNUM = lnum_save;
1064 vim_free(line_to_free);
1065 ga_clear_strings(&newlines);
1066 ga_clear_strings(newargs);
1067 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001068 if (ufunc != NULL)
1069 {
1070 func_clear(ufunc, TRUE);
1071 func_free(ufunc, TRUE);
1072 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001073 return ret;
1074}
1075
1076/*
1077 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001078 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001079 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001080 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1081 */
1082 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001083get_lambda_tv(
1084 char_u **arg,
1085 typval_T *rettv,
1086 int types_optional,
1087 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001088{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001089 int evaluate = evalarg != NULL
1090 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001091 garray_T newargs;
1092 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001093 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001094 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001095 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001096 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001097 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001098 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001099 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001100 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001101 char_u *s;
1102 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001103 int *old_eval_lavars = eval_lavars_used;
1104 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001105 char_u *tofree1 = NULL;
1106 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001107 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001108 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001109 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001110
1111 if (equal_arrow && !in_vim9script())
1112 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001113
1114 ga_init(&newargs);
1115 ga_init(&newlines);
1116
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001117 // First, check if this is really a lambda expression. "->" or "=>" must
1118 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001119 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001120 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001121 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001122 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001123 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001124 {
1125 if (types_optional)
1126 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001127 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001128 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001129
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001130 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001131 if (evaluate)
1132 pnewargs = &newargs;
1133 else
1134 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001135 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001136 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001137 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001138 &varargs, &default_args,
1139 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001140 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001141 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001142 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001143 {
1144 if (types_optional)
1145 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001146 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001147 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001148 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001149 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001150
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001151 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1152 if (ret_type != NULL)
1153 {
1154 ret_type = vim_strsave(ret_type);
1155 tofree2 = ret_type;
1156 }
1157
Bram Moolenaare38eab22019-12-05 21:50:01 +01001158 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001159 if (evaluate)
1160 eval_lavars_used = &eval_lavars;
1161
Bram Moolenaar65c44152020-12-24 15:14:01 +01001162 *arg = skipwhite_and_linebreak(*arg, evalarg);
1163
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001164 // Recognize "{" as the start of a function body.
1165 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001166 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001167 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1168 types_optional ? &argtypes : NULL, varargs,
1169 &default_args, ret_type) == FAIL)
1170 goto errret;
1171 goto theend;
1172 }
1173 if (default_args.ga_len > 0)
1174 {
1175 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001176 goto errret;
1177 }
1178
Bram Moolenaare38eab22019-12-05 21:50:01 +01001179 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001180 start = *arg;
1181 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001182 if (ret == FAIL)
1183 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001184 if (evalarg != NULL)
1185 {
1186 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001187 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001188 evalarg->eval_tofree = NULL;
1189 }
1190
Bram Moolenaar65c44152020-12-24 15:14:01 +01001191 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001192 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001193 *arg = skipwhite_and_linebreak(*arg, evalarg);
1194 if (**arg != '}')
1195 {
1196 semsg(_("E451: Expected }: %s"), *arg);
1197 goto errret;
1198 }
1199 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001200 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001201
1202 if (evaluate)
1203 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001204 int len;
1205 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001206 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001207 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001208
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001209 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001210 if (fp == NULL)
1211 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001212 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001213 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001214 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001215 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001216
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001217 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1218 if (ga_grow(&newlines, 1) == FAIL)
1219 goto errret;
1220
Bram Moolenaare38eab22019-12-05 21:50:01 +01001221 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001222 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001223 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001224 if (p == NULL)
1225 goto errret;
1226 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1227 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001228 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001229 if (strstr((char *)p + 7, "a:") == NULL)
1230 // No a: variables are used for sure.
1231 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001232
1233 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001234 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001235 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001236 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001237 if (types_optional)
1238 {
1239 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
1240 goto errret;
1241 if (ret_type != NULL)
1242 {
1243 fp->uf_ret_type = parse_type(&ret_type,
1244 &fp->uf_type_list, TRUE);
1245 if (fp->uf_ret_type == NULL)
1246 goto errret;
1247 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001248 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001249 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001250 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001251
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001252 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001253 if (current_funccal != NULL && eval_lavars)
1254 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001255 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001256 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001257 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001258 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001259
1260#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001261 if (prof_def_func())
1262 func_do_profile(fp);
1263#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001264 if (sandbox)
1265 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001266 // In legacy script a lambda can be called with more args than
1267 // uf_args.ga_len.
1268 fp->uf_varargs = !in_vim9script();
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001269 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001270 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001271 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001272 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001273
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001274 pt->pt_func = fp;
1275 pt->pt_refcount = 1;
1276 rettv->vval.v_partial = pt;
1277 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001278
1279 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001280 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001281
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001283 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001284 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001285 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001286 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001287 vim_free(tofree1);
1288 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001289 if (types_optional)
1290 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 return OK;
1292
1293errret:
1294 ga_clear_strings(&newargs);
1295 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001296 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001297 if (types_optional)
1298 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001299 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001300 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001301 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001302 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001303 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001304 vim_free(tofree1);
1305 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001306 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001307 return FAIL;
1308}
1309
1310/*
1311 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1312 * name it contains, otherwise return "name".
1313 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1314 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001315 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1316 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 */
1318 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001319deref_func_name(
1320 char_u *name,
1321 int *lenp,
1322 partial_T **partialp,
1323 type_T **type,
1324 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001325{
1326 dictitem_T *v;
1327 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001328 char_u *s = NULL;
1329 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001330
1331 if (partialp != NULL)
1332 *partialp = NULL;
1333
1334 cc = name[*lenp];
1335 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001336 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001337 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001338 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001339 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001340 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001341 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001342 if (v->di_tv.vval.v_string == NULL)
1343 {
1344 *lenp = 0;
1345 return (char_u *)""; // just in case
1346 }
1347 s = v->di_tv.vval.v_string;
1348 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001349 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001350
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001351 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001352 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001353 partial_T *pt = v->di_tv.vval.v_partial;
1354
1355 if (pt == NULL)
1356 {
1357 *lenp = 0;
1358 return (char_u *)""; // just in case
1359 }
1360 if (partialp != NULL)
1361 *partialp = pt;
1362 s = partial_name(pt);
1363 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001364 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001365
1366 if (s != NULL)
1367 {
1368 if (type != NULL && ht == get_script_local_ht())
1369 {
1370 svar_T *sv = find_typval_in_script(&v->di_tv);
1371
1372 if (sv != NULL)
1373 *type = sv->sv_type;
1374 }
1375 return s;
1376 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001377 }
1378
1379 return name;
1380}
1381
1382/*
1383 * Give an error message with a function name. Handle <SNR> things.
1384 * "ermsg" is to be passed without translation, use N_() instead of _().
1385 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001386 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001387emsg_funcname(char *ermsg, char_u *name)
1388{
1389 char_u *p;
1390
1391 if (*name == K_SPECIAL)
1392 p = concat_str((char_u *)"<SNR>", name + 3);
1393 else
1394 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001395 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001396 if (p != name)
1397 vim_free(p);
1398}
1399
1400/*
1401 * Allocate a variable for the result of a function.
1402 * Return OK or FAIL.
1403 */
1404 int
1405get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001406 char_u *name, // name of the function
1407 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001408 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001409 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001410 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001411 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001412{
1413 char_u *argp;
1414 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001415 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1416 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001417 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418
1419 /*
1420 * Get the arguments.
1421 */
1422 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001423 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1424 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001425 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001426 // skip the '(' or ',' and possibly line breaks
1427 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1428
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001429 if (*argp == ')' || *argp == ',' || *argp == NUL)
1430 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001431 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 {
1433 ret = FAIL;
1434 break;
1435 }
1436 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001437 // The comma should come right after the argument, but this wasn't
1438 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001439 if (vim9script)
1440 {
1441 if (*argp != ',' && *skipwhite(argp) == ',')
1442 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001443 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001444 ret = FAIL;
1445 break;
1446 }
1447 }
1448 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001449 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001450 if (*argp != ',')
1451 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001452 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1453 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001454 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001455 ret = FAIL;
1456 break;
1457 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001458 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001459 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460 if (*argp == ')')
1461 ++argp;
1462 else
1463 ret = FAIL;
1464
1465 if (ret == OK)
1466 {
1467 int i = 0;
1468
1469 if (get_vim_var_nr(VV_TESTING))
1470 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001471 // Prepare for calling test_garbagecollect_now(), need to know
1472 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001473 if (funcargs.ga_itemsize == 0)
1474 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1475 for (i = 0; i < argcount; ++i)
1476 if (ga_grow(&funcargs, 1) == OK)
1477 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1478 &argvars[i];
1479 }
1480
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001481 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482
1483 funcargs.ga_len -= i;
1484 }
1485 else if (!aborting())
1486 {
1487 if (argcount == MAX_FUNC_ARGS)
1488 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1489 else
1490 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1491 }
1492
1493 while (--argcount >= 0)
1494 clear_tv(&argvars[argcount]);
1495
Bram Moolenaar8294d492020-08-10 22:40:56 +02001496 if (in_vim9script())
1497 *arg = argp;
1498 else
1499 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500 return ret;
1501}
1502
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001503/*
1504 * Return TRUE if "p" starts with "<SID>" or "s:".
1505 * Only works if eval_fname_script() returned non-zero for "p"!
1506 */
1507 static int
1508eval_fname_sid(char_u *p)
1509{
1510 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1511}
1512
1513/*
1514 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1515 * Change <SNR>123_name() to K_SNR 123_name().
1516 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1517 * (slow).
1518 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001519 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1521{
1522 int llen;
1523 char_u *fname;
1524 int i;
1525
1526 llen = eval_fname_script(name);
1527 if (llen > 0)
1528 {
1529 fname_buf[0] = K_SPECIAL;
1530 fname_buf[1] = KS_EXTRA;
1531 fname_buf[2] = (int)KE_SNR;
1532 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001533 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001534 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001535 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001536 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 else
1538 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001539 sprintf((char *)fname_buf + 3, "%ld_",
1540 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001541 i = (int)STRLEN(fname_buf);
1542 }
1543 }
1544 if (i + STRLEN(name + llen) < FLEN_FIXED)
1545 {
1546 STRCPY(fname_buf + i, name + llen);
1547 fname = fname_buf;
1548 }
1549 else
1550 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001551 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001553 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554 else
1555 {
1556 *tofree = fname;
1557 mch_memmove(fname, fname_buf, (size_t)i);
1558 STRCPY(fname + i, name + llen);
1559 }
1560 }
1561 }
1562 else
1563 fname = name;
1564 return fname;
1565}
1566
1567/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001568 * Find a function "name" in script "sid".
1569 */
1570 static ufunc_T *
1571find_func_with_sid(char_u *name, int sid)
1572{
1573 hashitem_T *hi;
1574 char_u buffer[200];
1575
1576 buffer[0] = K_SPECIAL;
1577 buffer[1] = KS_EXTRA;
1578 buffer[2] = (int)KE_SNR;
1579 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1580 (long)sid, name);
1581 hi = hash_find(&func_hashtab, buffer);
1582 if (!HASHITEM_EMPTY(hi))
1583 return HI2UF(hi);
1584
1585 return NULL;
1586}
1587
1588/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001590 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001591 * Return NULL for unknown function.
1592 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001593 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001594find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595{
1596 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001597 ufunc_T *func;
1598 imported_T *imported;
1599
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001600 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001601 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001602 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001603 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001604 int find_script_local = in_vim9script()
1605 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001606
Bram Moolenaar95006e32020-08-29 17:47:08 +02001607 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001608 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001609 // Find script-local function before global one.
1610 func = find_func_with_sid(name, current_sctx.sc_sid);
1611 if (func != NULL)
1612 return func;
1613 }
1614
Bram Moolenaarefa94442020-08-08 22:16:00 +02001615 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001616 && name[1] == KS_EXTRA
1617 && name[2] == KE_SNR)
1618 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001619 // Caller changes s: to <SNR>99_name.
1620
1621 after_script = name + 3;
1622 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001623 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001624 ++after_script;
1625 else
1626 after_script = NULL;
1627 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001628 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001629 {
1630 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001631 if (after_script != NULL && sid != current_sctx.sc_sid)
1632 imported = find_imported_in_script(after_script, 0, sid);
1633 else
1634 imported = find_imported(after_script == NULL
1635 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001636 if (imported != NULL && imported->imp_funcname != NULL)
1637 {
1638 hi = hash_find(&func_hashtab, imported->imp_funcname);
1639 if (!HASHITEM_EMPTY(hi))
1640 return HI2UF(hi);
1641 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001642 }
1643 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644
Bram Moolenaara26b9702020-04-18 19:53:28 +02001645 hi = hash_find(&func_hashtab,
1646 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647 if (!HASHITEM_EMPTY(hi))
1648 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001649
1650 return NULL;
1651}
1652
1653/*
1654 * Find a function by name, return pointer to it in ufuncs.
1655 * "cctx" is passed in a :def function to find imported functions.
1656 * Return NULL for unknown or dead function.
1657 */
1658 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001659find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001660{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001661 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001662
1663 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1664 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001665 return NULL;
1666}
1667
1668/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001669 * Return TRUE if "ufunc" is a global function.
1670 */
1671 int
1672func_is_global(ufunc_T *ufunc)
1673{
1674 return ufunc->uf_name[0] != K_SPECIAL;
1675}
1676
1677/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001678 * Copy the function name of "fp" to buffer "buf".
1679 * "buf" must be able to hold the function name plus three bytes.
1680 * Takes care of script-local function names.
1681 */
1682 static void
1683cat_func_name(char_u *buf, ufunc_T *fp)
1684{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001685 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001686 {
1687 STRCPY(buf, "<SNR>");
1688 STRCAT(buf, fp->uf_name + 3);
1689 }
1690 else
1691 STRCPY(buf, fp->uf_name);
1692}
1693
1694/*
1695 * Add a number variable "name" to dict "dp" with value "nr".
1696 */
1697 static void
1698add_nr_var(
1699 dict_T *dp,
1700 dictitem_T *v,
1701 char *name,
1702 varnumber_T nr)
1703{
1704 STRCPY(v->di_key, name);
1705 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1706 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1707 v->di_tv.v_type = VAR_NUMBER;
1708 v->di_tv.v_lock = VAR_FIXED;
1709 v->di_tv.vval.v_number = nr;
1710}
1711
1712/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001713 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001715 static void
1716free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001718 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001719
1720 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1721 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001722 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001723
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001724 // When garbage collecting a funccall_T may be freed before the
1725 // function that references it, clear its uf_scoped field.
1726 // The function may have been redefined and point to another
1727 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001728 if (fp != NULL && fp->uf_scoped == fc)
1729 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001730 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001731 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001733 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734 vim_free(fc);
1735}
1736
1737/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001738 * Free "fc" and what it contains.
1739 * Can be called only when "fc" is kept beyond the period of it called,
1740 * i.e. after cleanup_function_call(fc).
1741 */
1742 static void
1743free_funccal_contents(funccall_T *fc)
1744{
1745 listitem_T *li;
1746
1747 // Free all l: variables.
1748 vars_clear(&fc->l_vars.dv_hashtab);
1749
1750 // Free all a: variables.
1751 vars_clear(&fc->l_avars.dv_hashtab);
1752
1753 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001754 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001755 clear_tv(&li->li_tv);
1756
1757 free_funccal(fc);
1758}
1759
1760/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001761 * Handle the last part of returning from a function: free the local hashtable.
1762 * Unless it is still in use by a closure.
1763 */
1764 static void
1765cleanup_function_call(funccall_T *fc)
1766{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001767 int may_free_fc = fc->fc_refcount <= 0;
1768 int free_fc = TRUE;
1769
Bram Moolenaar6914c642017-04-01 21:21:30 +02001770 current_funccal = fc->caller;
1771
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001772 // Free all l: variables if not referred.
1773 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1774 vars_clear(&fc->l_vars.dv_hashtab);
1775 else
1776 free_fc = FALSE;
1777
1778 // If the a:000 list and the l: and a: dicts are not referenced and
1779 // there is no closure using it, we can free the funccall_T and what's
1780 // in it.
1781 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1782 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001783 else
1784 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001785 int todo;
1786 hashitem_T *hi;
1787 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001788
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001789 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001790
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001791 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001792 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1793 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1794 {
1795 if (!HASHITEM_EMPTY(hi))
1796 {
1797 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001798 di = HI2DI(hi);
1799 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001800 }
1801 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001802 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001803
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001804 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1805 fc->l_varlist.lv_first = NULL;
1806 else
1807 {
1808 listitem_T *li;
1809
1810 free_fc = FALSE;
1811
1812 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001813 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001814 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001815 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001816
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001817 if (free_fc)
1818 free_funccal(fc);
1819 else
1820 {
1821 static int made_copy = 0;
1822
1823 // "fc" is still in use. This can happen when returning "a:000",
1824 // assigning "l:" to a global variable or defining a closure.
1825 // Link "fc" in the list for garbage collection later.
1826 fc->caller = previous_funccal;
1827 previous_funccal = fc;
1828
1829 if (want_garbage_collect)
1830 // If garbage collector is ready, clear count.
1831 made_copy = 0;
1832 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001833 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001834 // We have made a lot of copies, worth 4 Mbyte. This can happen
1835 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001836 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001837 // too much memory.
1838 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001839 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001840 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001841 }
1842}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001843
1844/*
1845 * There are two kinds of function names:
1846 * 1. ordinary names, function defined with :function or :def
1847 * 2. numbered functions and lambdas
1848 * For the first we only count the name stored in func_hashtab as a reference,
1849 * using function() does not count as a reference, because the function is
1850 * looked up by name.
1851 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001852 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001853func_name_refcount(char_u *name)
1854{
1855 return isdigit(*name) || *name == '<';
1856}
1857
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001858/*
1859 * Unreference "fc": decrement the reference count and free it when it
1860 * becomes zero. "fp" is detached from "fc".
1861 * When "force" is TRUE we are exiting.
1862 */
1863 static void
1864funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1865{
1866 funccall_T **pfc;
1867 int i;
1868
1869 if (fc == NULL)
1870 return;
1871
1872 if (--fc->fc_refcount <= 0 && (force || (
1873 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1874 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1875 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1876 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1877 {
1878 if (fc == *pfc)
1879 {
1880 *pfc = fc->caller;
1881 free_funccal_contents(fc);
1882 return;
1883 }
1884 }
1885 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1886 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1887 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1888}
1889
1890/*
1891 * Remove the function from the function hashtable. If the function was
1892 * deleted while it still has references this was already done.
1893 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1894 */
1895 static int
1896func_remove(ufunc_T *fp)
1897{
1898 hashitem_T *hi;
1899
1900 // Return if it was already virtually deleted.
1901 if (fp->uf_flags & FC_DEAD)
1902 return FALSE;
1903
1904 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1905 if (!HASHITEM_EMPTY(hi))
1906 {
1907 // When there is a def-function index do not actually remove the
1908 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001909 // Do remove it when it's a copy.
1910 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001911 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001912 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001913 return FALSE;
1914 }
1915 hash_remove(&func_hashtab, hi);
1916 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001917 return TRUE;
1918 }
1919 return FALSE;
1920}
1921
1922 static void
1923func_clear_items(ufunc_T *fp)
1924{
1925 ga_clear_strings(&(fp->uf_args));
1926 ga_clear_strings(&(fp->uf_def_args));
1927 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001928 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001929 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001930 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001931 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001932
1933 // Increment the refcount of this function to avoid it being freed
1934 // recursively when the partial is freed.
1935 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001936 partial_unref(fp->uf_partial);
1937 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001938 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001939
1940#ifdef FEAT_LUA
1941 if (fp->uf_cb_free != NULL)
1942 {
1943 fp->uf_cb_free(fp->uf_cb_state);
1944 fp->uf_cb_free = NULL;
1945 }
1946
1947 fp->uf_cb_state = NULL;
1948 fp->uf_cb = NULL;
1949#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001950#ifdef FEAT_PROFILE
1951 VIM_CLEAR(fp->uf_tml_count);
1952 VIM_CLEAR(fp->uf_tml_total);
1953 VIM_CLEAR(fp->uf_tml_self);
1954#endif
1955}
1956
1957/*
1958 * Free all things that a function contains. Does not free the function
1959 * itself, use func_free() for that.
1960 * When "force" is TRUE we are exiting.
1961 */
1962 static void
1963func_clear(ufunc_T *fp, int force)
1964{
1965 if (fp->uf_cleared)
1966 return;
1967 fp->uf_cleared = TRUE;
1968
1969 // clear this function
1970 func_clear_items(fp);
1971 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001972 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001973}
1974
1975/*
1976 * Free a function and remove it from the list of functions. Does not free
1977 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001978 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001979 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001980 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001981 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001982func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001983{
1984 // Only remove it when not done already, otherwise we would remove a newer
1985 // version of the function with the same name.
1986 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1987 func_remove(fp);
1988
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001989 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001990 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001991 if (fp->uf_dfunc_idx > 0)
1992 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001993 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001994 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001995 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001996 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001997 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998}
1999
2000/*
2001 * Free all things that a function contains and free the function itself.
2002 * When "force" is TRUE we are exiting.
2003 */
2004 static void
2005func_clear_free(ufunc_T *fp, int force)
2006{
2007 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002008 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2009 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002010 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002011 else
2012 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002013}
2014
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002015/*
2016 * Copy already defined function "lambda" to a new function with name "global".
2017 * This is for when a compiled function defines a global function.
2018 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002019 int
2020copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002021{
2022 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002023 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002024
2025 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002026 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002027 semsg(_(e_lambda_function_not_found_str), lambda);
2028 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002029 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002030
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002031 fp = find_func(global, TRUE, NULL);
2032 if (fp != NULL)
2033 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002034 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002035 semsg(_(e_funcexts), global);
2036 return FAIL;
2037 }
2038
2039 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2040 if (fp == NULL)
2041 return FAIL;
2042
2043 fp->uf_varargs = ufunc->uf_varargs;
2044 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2045 fp->uf_def_status = ufunc->uf_def_status;
2046 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2047 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2048 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2049 == FAIL
2050 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2051 goto failed;
2052
2053 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2054 : vim_strsave(ufunc->uf_name_exp);
2055 if (ufunc->uf_arg_types != NULL)
2056 {
2057 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2058 if (fp->uf_arg_types == NULL)
2059 goto failed;
2060 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2061 sizeof(type_T *) * fp->uf_args.ga_len);
2062 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002063 if (ufunc->uf_va_name != NULL)
2064 {
2065 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2066 if (fp->uf_va_name == NULL)
2067 goto failed;
2068 }
2069 fp->uf_ret_type = ufunc->uf_ret_type;
2070
2071 fp->uf_refcount = 1;
2072 STRCPY(fp->uf_name, global);
2073 hash_add(&func_hashtab, UF2HIKEY(fp));
2074
2075 // the referenced dfunc_T is now used one more time
2076 link_def_function(fp);
2077
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002078 // Create a partial to store the context of the function where it was
2079 // instantiated. Only needs to be done once. Do this on the original
2080 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002081 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2082 {
2083 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2084
2085 if (pt == NULL)
2086 goto failed;
2087 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002088 {
2089 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002090 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002091 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002092 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002093 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002094 }
2095
2096 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002097
2098failed:
2099 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002100 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002101}
2102
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002103static int funcdepth = 0;
2104
2105/*
2106 * Increment the function call depth count.
2107 * Return FAIL when going over 'maxfuncdepth'.
2108 * Otherwise return OK, must call funcdepth_decrement() later!
2109 */
2110 int
2111funcdepth_increment(void)
2112{
2113 if (funcdepth >= p_mfd)
2114 {
2115 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2116 return FAIL;
2117 }
2118 ++funcdepth;
2119 return OK;
2120}
2121
2122 void
2123funcdepth_decrement(void)
2124{
2125 --funcdepth;
2126}
2127
2128/*
2129 * Get the current function call depth.
2130 */
2131 int
2132funcdepth_get(void)
2133{
2134 return funcdepth;
2135}
2136
2137/*
2138 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002139 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002140 * times as funcdepth_increment().
2141 */
2142 void
2143funcdepth_restore(int depth)
2144{
2145 funcdepth = depth;
2146}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002147
2148/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002149 * Call a user function.
2150 */
2151 static void
2152call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002153 ufunc_T *fp, // pointer to function
2154 int argcount, // nr of args
2155 typval_T *argvars, // arguments
2156 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002157 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002158 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002160 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002161 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002162 funccall_T *fc;
2163 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002164 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002165 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002166 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002167 int i;
2168 int ai;
2169 int islambda = FALSE;
2170 char_u numbuf[NUMBUFLEN];
2171 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002172#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002173 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002174#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002175 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176
Bram Moolenaarb2049902021-01-24 12:53:53 +01002177#ifdef FEAT_PROFILE
2178 CLEAR_FIELD(profile_info);
2179#endif
2180
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002181 // If depth of calling is getting too high, don't execute the function.
2182 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002183 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002184 rettv->v_type = VAR_NUMBER;
2185 rettv->vval.v_number = -1;
2186 return;
2187 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002188
Bram Moolenaare38eab22019-12-05 21:50:01 +01002189 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002190
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002191 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002192 if (fc == NULL)
2193 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002194 fc->caller = current_funccal;
2195 current_funccal = fc;
2196 fc->func = fp;
2197 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002198 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002199 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002200 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2201 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002202 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002203 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002204 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002205
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002206 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002207 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002208#ifdef FEAT_PROFILE
2209 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2210#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002211 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002212#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002213 if (do_profiling == PROF_YES)
2214 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002215#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002216 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002217 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002218#ifdef FEAT_PROFILE
2219 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002220 || (caller != NULL && caller->uf_profiling)))
2221 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002222#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002223 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002224 free_funccal(fc);
2225 return;
2226 }
2227
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002228 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2229 islambda = TRUE;
2230
2231 /*
2232 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2233 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2234 * each argument variable and saves a lot of time.
2235 */
2236 /*
2237 * Init l: variables.
2238 */
2239 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2240 if (selfdict != NULL)
2241 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002242 // Set l:self to "selfdict". Use "name" to avoid a warning from
2243 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002244 v = &fc->fixvar[fixvar_idx++].var;
2245 name = v->di_key;
2246 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002247 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002248 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2249 v->di_tv.v_type = VAR_DICT;
2250 v->di_tv.v_lock = 0;
2251 v->di_tv.vval.v_dict = selfdict;
2252 ++selfdict->dv_refcount;
2253 }
2254
2255 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002256 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002257 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002258 * Set a:000 to a list with room for the "..." arguments.
2259 */
2260 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002261 if ((fp->uf_flags & FC_NOARGS) == 0)
2262 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002263 (varnumber_T)(argcount >= fp->uf_args.ga_len
2264 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002265 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002266 if ((fp->uf_flags & FC_NOARGS) == 0)
2267 {
2268 // Use "name" to avoid a warning from some compiler that checks the
2269 // destination size.
2270 v = &fc->fixvar[fixvar_idx++].var;
2271 name = v->di_key;
2272 STRCPY(name, "000");
2273 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2274 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2275 v->di_tv.v_type = VAR_LIST;
2276 v->di_tv.v_lock = VAR_FIXED;
2277 v->di_tv.vval.v_list = &fc->l_varlist;
2278 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002279 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002280 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2281 fc->l_varlist.lv_lock = VAR_FIXED;
2282
2283 /*
2284 * Set a:firstline to "firstline" and a:lastline to "lastline".
2285 * Set a:name to named arguments.
2286 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002287 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002288 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002289 if ((fp->uf_flags & FC_NOARGS) == 0)
2290 {
2291 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002292 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002293 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002294 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002295 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002296 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002297 {
2298 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002299 typval_T def_rettv;
2300 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301
2302 ai = i - fp->uf_args.ga_len;
2303 if (ai < 0)
2304 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002305 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002306 name = FUNCARG(fp, i);
2307 if (islambda)
2308 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002309
2310 // evaluate named argument default expression
2311 isdefault = ai + fp->uf_def_args.ga_len >= 0
2312 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2313 && argvars[i].vval.v_number == VVAL_NONE));
2314 if (isdefault)
2315 {
2316 char_u *default_expr = NULL;
2317 def_rettv.v_type = VAR_NUMBER;
2318 def_rettv.vval.v_number = -1;
2319
2320 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2321 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002322 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002323 {
2324 default_arg_err = 1;
2325 break;
2326 }
2327 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002328 }
2329 else
2330 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002331 if ((fp->uf_flags & FC_NOARGS) != 0)
2332 // Bail out if no a: arguments used (in lambda).
2333 break;
2334
Bram Moolenaare38eab22019-12-05 21:50:01 +01002335 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 sprintf((char *)numbuf, "%d", ai + 1);
2337 name = numbuf;
2338 }
2339 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2340 {
2341 v = &fc->fixvar[fixvar_idx++].var;
2342 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002343 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344 }
2345 else
2346 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002347 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 if (v == NULL)
2349 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002350 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002351 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002352
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002353 // Note: the values are copied directly to avoid alloc/free.
2354 // "argvars" must have VAR_FIXED for v_lock.
2355 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002356 v->di_tv.v_lock = VAR_FIXED;
2357
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358 if (addlocal)
2359 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002360 // Named arguments should be accessed without the "a:" prefix in
2361 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002362 copy_tv(&v->di_tv, &v->di_tv);
2363 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002364 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002365 else
2366 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367
2368 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2369 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002370 listitem_T *li = &fc->l_listitems[ai];
2371
2372 li->li_tv = argvars[i];
2373 li->li_tv.v_lock = VAR_FIXED;
2374 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002375 }
2376 }
2377
Bram Moolenaare38eab22019-12-05 21:50:01 +01002378 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002380
2381 if (fp->uf_flags & FC_SANDBOX)
2382 {
2383 using_sandbox = TRUE;
2384 ++sandbox;
2385 }
2386
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002387 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002388 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002389 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002391 ++no_wait_return;
2392 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002394 smsg(_("calling %s"), SOURCING_NAME);
2395 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002397 char_u buf[MSG_BUF_LEN];
2398 char_u numbuf2[NUMBUFLEN];
2399 char_u *tofree;
2400 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002402 msg_puts("(");
2403 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002405 if (i > 0)
2406 msg_puts(", ");
2407 if (argvars[i].v_type == VAR_NUMBER)
2408 msg_outnum((long)argvars[i].vval.v_number);
2409 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002410 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002411 // Do not want errors such as E724 here.
2412 ++emsg_off;
2413 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2414 --emsg_off;
2415 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002417 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002419 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2420 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002422 msg_puts((char *)s);
2423 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002424 }
2425 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002427 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002428 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002429 msg_puts("\n"); // don't overwrite this either
2430
2431 verbose_leave_scroll();
2432 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 }
2434#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002435 if (do_profiling == PROF_YES)
2436 profile_may_start_func(&profile_info, fp,
2437 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438#endif
2439
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002440 save_current_sctx = current_sctx;
2441 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 save_did_emsg = did_emsg;
2443 did_emsg = FALSE;
2444
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002445 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2446 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002447 else if (islambda)
2448 {
2449 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2450
2451 // A Lambda always has the command "return {expr}". It is much faster
2452 // to evaluate {expr} directly.
2453 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002454 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002455 --ex_nesting_level;
2456 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002457 else
2458 // call do_cmdline() to execute the lines
2459 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002460 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2461
2462 --RedrawingDisabled;
2463
Bram Moolenaare38eab22019-12-05 21:50:01 +01002464 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002465 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2466 {
2467 clear_tv(rettv);
2468 rettv->v_type = VAR_NUMBER;
2469 rettv->vval.v_number = -1;
2470 }
2471
2472#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002473 if (do_profiling == PROF_YES)
2474 {
2475 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2476
2477 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2478 profile_may_end_func(&profile_info, fp, caller);
2479 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480#endif
2481
Bram Moolenaare38eab22019-12-05 21:50:01 +01002482 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483 if (p_verbose >= 12)
2484 {
2485 ++no_wait_return;
2486 verbose_enter_scroll();
2487
2488 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002489 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002490 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002491 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002492 (long)fc->rettv->vval.v_number);
2493 else
2494 {
2495 char_u buf[MSG_BUF_LEN];
2496 char_u numbuf2[NUMBUFLEN];
2497 char_u *tofree;
2498 char_u *s;
2499
Bram Moolenaare38eab22019-12-05 21:50:01 +01002500 // The value may be very long. Skip the middle part, so that we
2501 // have some idea how it starts and ends. smsg() would always
2502 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503 ++emsg_off;
2504 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2505 --emsg_off;
2506 if (s != NULL)
2507 {
2508 if (vim_strsize(s) > MSG_BUF_CLEN)
2509 {
2510 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2511 s = buf;
2512 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002513 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514 vim_free(tofree);
2515 }
2516 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002517 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518
2519 verbose_leave_scroll();
2520 --no_wait_return;
2521 }
2522
Bram Moolenaare31ee862020-01-07 20:59:34 +01002523 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002524 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002525 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526#ifdef FEAT_PROFILE
2527 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002528 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002530 if (using_sandbox)
2531 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002533 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 {
2535 ++no_wait_return;
2536 verbose_enter_scroll();
2537
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002538 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002539 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540
2541 verbose_leave_scroll();
2542 --no_wait_return;
2543 }
2544
2545 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002546 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002547 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548}
2549
2550/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002551 * Check the argument count for user function "fp".
2552 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2553 */
2554 int
2555check_user_func_argcount(ufunc_T *fp, int argcount)
2556{
2557 int regular_args = fp->uf_args.ga_len;
2558
2559 if (argcount < regular_args - fp->uf_def_args.ga_len)
2560 return FCERR_TOOFEW;
2561 else if (!has_varargs(fp) && argcount > regular_args)
2562 return FCERR_TOOMANY;
2563 return FCERR_UNKNOWN;
2564}
2565
2566/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002567 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002568 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002569 int
2570call_user_func_check(
2571 ufunc_T *fp,
2572 int argcount,
2573 typval_T *argvars,
2574 typval_T *rettv,
2575 funcexe_T *funcexe,
2576 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002577{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002578 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002579
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002580 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2581 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002582 error = check_user_func_argcount(fp, argcount);
2583 if (error != FCERR_UNKNOWN)
2584 return error;
2585 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002586 error = FCERR_DICT;
2587 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002588 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002589 int did_save_redo = FALSE;
2590 save_redo_T save_redo;
2591
2592 /*
2593 * Call the user function.
2594 * Save and restore search patterns, script variables and
2595 * redo buffer.
2596 */
2597 save_search_patterns();
2598 if (!ins_compl_active())
2599 {
2600 saveRedobuff(&save_redo);
2601 did_save_redo = TRUE;
2602 }
2603 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002604 call_user_func(fp, argcount, argvars, rettv, funcexe,
2605 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002606 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2607 // Function was unreferenced while being used, free it now.
2608 func_clear_free(fp, FALSE);
2609 if (did_save_redo)
2610 restoreRedobuff(&save_redo);
2611 restore_search_patterns();
2612 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002613 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002614 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002615}
2616
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002617static funccal_entry_T *funccal_stack = NULL;
2618
2619/*
2620 * Save the current function call pointer, and set it to NULL.
2621 * Used when executing autocommands and for ":source".
2622 */
2623 void
2624save_funccal(funccal_entry_T *entry)
2625{
2626 entry->top_funccal = current_funccal;
2627 entry->next = funccal_stack;
2628 funccal_stack = entry;
2629 current_funccal = NULL;
2630}
2631
2632 void
2633restore_funccal(void)
2634{
2635 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002636 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002637 else
2638 {
2639 current_funccal = funccal_stack->top_funccal;
2640 funccal_stack = funccal_stack->next;
2641 }
2642}
2643
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002644 funccall_T *
2645get_current_funccal(void)
2646{
2647 return current_funccal;
2648}
2649
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002650/*
2651 * Mark all functions of script "sid" as deleted.
2652 */
2653 void
2654delete_script_functions(int sid)
2655{
2656 hashitem_T *hi;
2657 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002658 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002659 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002660 size_t len;
2661
2662 buf[0] = K_SPECIAL;
2663 buf[1] = KS_EXTRA;
2664 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002665 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002666 len = STRLEN(buf);
2667
Bram Moolenaarce658352020-07-31 23:47:12 +02002668 while (todo > 0)
2669 {
2670 todo = func_hashtab.ht_used;
2671 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2672 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002673 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002674 fp = HI2UF(hi);
2675 if (STRNCMP(fp->uf_name, buf, len) == 0)
2676 {
2677 int changed = func_hashtab.ht_changed;
2678
2679 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002680
2681 if (fp->uf_calls > 0)
2682 {
2683 // Function is executing, don't free it but do remove
2684 // it from the hashtable.
2685 if (func_remove(fp))
2686 fp->uf_refcount--;
2687 }
2688 else
2689 {
2690 func_clear(fp, TRUE);
2691 // When clearing a function another function can be
2692 // cleared as a side effect. When that happens start
2693 // over.
2694 if (changed != func_hashtab.ht_changed)
2695 break;
2696 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002697 }
2698 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002699 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002700 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002701}
2702
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002703#if defined(EXITFREE) || defined(PROTO)
2704 void
2705free_all_functions(void)
2706{
2707 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002708 ufunc_T *fp;
2709 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002710 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002711 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712
Bram Moolenaare38eab22019-12-05 21:50:01 +01002713 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002714 while (current_funccal != NULL)
2715 {
2716 clear_tv(current_funccal->rettv);
2717 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002718 if (current_funccal == NULL && funccal_stack != NULL)
2719 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002720 }
2721
Bram Moolenaare38eab22019-12-05 21:50:01 +01002722 // First clear what the functions contain. Since this may lower the
2723 // reference count of a function, it may also free a function and change
2724 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002725 while (todo > 0)
2726 {
2727 todo = func_hashtab.ht_used;
2728 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2729 if (!HASHITEM_EMPTY(hi))
2730 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002731 // clear the def function index now
2732 fp = HI2UF(hi);
2733 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002734 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002735
Bram Moolenaare38eab22019-12-05 21:50:01 +01002736 // Only free functions that are not refcounted, those are
2737 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002738 if (func_name_refcount(fp->uf_name))
2739 ++skipped;
2740 else
2741 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002742 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002743 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002744 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002745 {
2746 skipped = 0;
2747 break;
2748 }
2749 }
2750 --todo;
2751 }
2752 }
2753
Bram Moolenaare38eab22019-12-05 21:50:01 +01002754 // Now actually free the functions. Need to start all over every time,
2755 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002756 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002757 while (func_hashtab.ht_used > skipped)
2758 {
2759 todo = func_hashtab.ht_used;
2760 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761 if (!HASHITEM_EMPTY(hi))
2762 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002763 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002764 // Only free functions that are not refcounted, those are
2765 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002766 fp = HI2UF(hi);
2767 if (func_name_refcount(fp->uf_name))
2768 ++skipped;
2769 else
2770 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002771 if (func_free(fp, FALSE) == OK)
2772 {
2773 skipped = 0;
2774 break;
2775 }
2776 // did not actually free it
2777 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002778 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002779 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002780 }
2781 if (skipped == 0)
2782 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002783
2784 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785}
2786#endif
2787
2788/*
2789 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002790 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791 * "len" is the length of "name", or -1 for NUL terminated.
2792 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002793 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794builtin_function(char_u *name, int len)
2795{
2796 char_u *p;
2797
Bram Moolenaara26b9702020-04-18 19:53:28 +02002798 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799 return FALSE;
2800 p = vim_strchr(name, AUTOLOAD_CHAR);
2801 return p == NULL || (len > 0 && p > name + len);
2802}
2803
2804 int
2805func_call(
2806 char_u *name,
2807 typval_T *args,
2808 partial_T *partial,
2809 dict_T *selfdict,
2810 typval_T *rettv)
2811{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002812 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 listitem_T *item;
2814 typval_T argv[MAX_FUNC_ARGS + 1];
2815 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 int r = 0;
2817
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002818 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002819 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 {
2821 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2822 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002823 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 break;
2825 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002826 // Make a copy of each argument. This is needed to be able to set
2827 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828 copy_tv(&item->li_tv, &argv[argc++]);
2829 }
2830
2831 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002832 {
2833 funcexe_T funcexe;
2834
Bram Moolenaara80faa82020-04-12 19:37:17 +02002835 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002836 funcexe.firstline = curwin->w_cursor.lnum;
2837 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002838 funcexe.evaluate = TRUE;
2839 funcexe.partial = partial;
2840 funcexe.selfdict = selfdict;
2841 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2842 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843
Bram Moolenaare38eab22019-12-05 21:50:01 +01002844 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002845 while (argc > 0)
2846 clear_tv(&argv[--argc]);
2847
2848 return r;
2849}
2850
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002851static int callback_depth = 0;
2852
2853 int
2854get_callback_depth(void)
2855{
2856 return callback_depth;
2857}
2858
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002860 * Invoke call_func() with a callback.
2861 */
2862 int
2863call_callback(
2864 callback_T *callback,
2865 int len, // length of "name" or -1 to use strlen()
2866 typval_T *rettv, // return value goes here
2867 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002868 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002869 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002870{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002871 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002872 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002873
Bram Moolenaara80faa82020-04-12 19:37:17 +02002874 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002875 funcexe.evaluate = TRUE;
2876 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002877 ++callback_depth;
2878 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2879 --callback_depth;
2880 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002881}
2882
2883/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002884 * Give an error message for the result of a function.
2885 * Nothing if "error" is FCERR_NONE.
2886 */
2887 void
2888user_func_error(int error, char_u *name)
2889{
2890 switch (error)
2891 {
2892 case FCERR_UNKNOWN:
2893 emsg_funcname(e_unknownfunc, name);
2894 break;
2895 case FCERR_NOTMETHOD:
2896 emsg_funcname(
2897 N_("E276: Cannot use function as a method: %s"), name);
2898 break;
2899 case FCERR_DELETED:
2900 emsg_funcname(N_(e_func_deleted), name);
2901 break;
2902 case FCERR_TOOMANY:
2903 emsg_funcname((char *)e_toomanyarg, name);
2904 break;
2905 case FCERR_TOOFEW:
2906 emsg_funcname((char *)e_toofewarg, name);
2907 break;
2908 case FCERR_SCRIPT:
2909 emsg_funcname(
2910 N_("E120: Using <SID> not in a script context: %s"), name);
2911 break;
2912 case FCERR_DICT:
2913 emsg_funcname(
2914 N_("E725: Calling dict function without Dictionary: %s"),
2915 name);
2916 break;
2917 }
2918}
2919
2920/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002921 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002922 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923 * Return FAIL when the function can't be called, OK otherwise.
2924 * Also returns OK when an error was encountered while executing the function.
2925 */
2926 int
2927call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002928 char_u *funcname, // name of the function
2929 int len, // length of "name" or -1 to use strlen()
2930 typval_T *rettv, // return value goes here
2931 int argcount_in, // number of "argvars"
2932 typval_T *argvars_in, // vars for arguments, must have "argcount"
2933 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002934 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002935{
2936 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002937 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002938 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002939 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940 char_u fname_buf[FLEN_FIXED + 1];
2941 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002942 char_u *fname = NULL;
2943 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002944 int argcount = argcount_in;
2945 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002946 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002947 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2948 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002950 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002951 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002953 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2954 // even when call_func() returns FAIL.
2955 rettv->v_type = VAR_UNKNOWN;
2956
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002957 if (partial != NULL)
2958 fp = partial->pt_func;
2959 if (fp == NULL)
2960 {
2961 // Make a copy of the name, if it comes from a funcref variable it
2962 // could be changed or deleted in the called function.
2963 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2964 if (name == NULL)
2965 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002967 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2968 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002970 if (funcexe->doesrange != NULL)
2971 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972
2973 if (partial != NULL)
2974 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002975 // When the function has a partial with a dict and there is a dict
2976 // argument, use the dict argument. That is backwards compatible.
2977 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002978 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002979 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002980 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002981 {
2982 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002983 {
2984 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2985 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002986 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002987 goto theend;
2988 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002989 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002990 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 for (i = 0; i < argcount_in; ++i)
2992 argv[i + argv_clear] = argvars_in[i];
2993 argvars = argv;
2994 argcount = partial->pt_argc + argcount_in;
2995 }
2996 }
2997
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002998 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2999 {
3000 // Check that the argument types are OK for the types of the funcref.
3001 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003002 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003003 error = FCERR_OTHER;
3004 }
3005
Bram Moolenaaref140542019-12-31 21:27:13 +01003006 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 {
3008 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003009 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003010
Bram Moolenaar333894b2020-08-01 18:53:07 +02003011 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003012 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003013 {
3014 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003015 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003016 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017
Bram Moolenaare38eab22019-12-05 21:50:01 +01003018 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003020 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003022 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023 {
3024 /*
3025 * User defined function.
3026 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003027 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003028 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029
Bram Moolenaare38eab22019-12-05 21:50:01 +01003030 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031 if (fp == NULL
3032 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003033 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034 && !aborting())
3035 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003036 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003037 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003039 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003040 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3041 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003042 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003043 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003045 if (fp == NULL)
3046 {
3047 char_u *p = untrans_function_name(rfname);
3048
3049 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003050 // Don't do this if the name starts with "s:".
3051 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003052 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003053 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003054
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003055 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003056 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003057#ifdef FEAT_LUA
3058 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3059 {
3060 cfunc_T cb = fp->uf_cb;
3061
3062 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3063 }
3064#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003065 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003067 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003068 // postponed filling in the arguments, do it now
3069 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003070 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003071
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003072 if (funcexe->basetv != NULL)
3073 {
3074 // Method call: base->Method()
3075 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3076 argv[0] = *funcexe->basetv;
3077 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003078 argvars = argv;
3079 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003080 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003081
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003082 error = call_user_func_check(fp, argcount, argvars, rettv,
3083 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003084 }
3085 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003086 else if (funcexe->basetv != NULL)
3087 {
3088 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003089 * expr->method(): Find the method name in the table, call its
3090 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003091 */
3092 error = call_internal_method(fname, argcount, argvars, rettv,
3093 funcexe->basetv);
3094 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003095 else
3096 {
3097 /*
3098 * Find the function name in the table, call its implementation.
3099 */
3100 error = call_internal_func(fname, argcount, argvars, rettv);
3101 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003102
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 /*
3104 * The function call (or "FuncUndefined" autocommand sequence) might
3105 * have been aborted by an error, an interrupt, or an explicitly thrown
3106 * exception that has not been caught so far. This situation can be
3107 * tested for by calling aborting(). For an error in an internal
3108 * function or for the "E132" error in call_user_func(), however, the
3109 * throw point at which the "force_abort" flag (temporarily reset by
3110 * emsg()) is normally updated has not been reached yet. We need to
3111 * update that flag first to make aborting() reliable.
3112 */
3113 update_force_abort();
3114 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003115 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 ret = OK;
3117
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003118theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 /*
3120 * Report an error unless the argument evaluation or function call has been
3121 * cancelled due to an aborting error, an interrupt, or an exception.
3122 */
3123 if (!aborting())
3124 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003125 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126 }
3127
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003128 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003130 clear_tv(&argv[--argv_clear + argv_base]);
3131
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003132 vim_free(tofree);
3133 vim_free(name);
3134
3135 return ret;
3136}
3137
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003138 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003139printable_func_name(ufunc_T *fp)
3140{
3141 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3142}
3143
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003145 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003146 */
3147 static void
3148list_func_head(ufunc_T *fp, int indent)
3149{
3150 int j;
3151
3152 msg_start();
3153 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003154 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003155 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003156 msg_puts("def ");
3157 else
3158 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003159 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 msg_putchar('(');
3161 for (j = 0; j < fp->uf_args.ga_len; ++j)
3162 {
3163 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003164 msg_puts(", ");
3165 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003166 if (fp->uf_arg_types != NULL)
3167 {
3168 char *tofree;
3169
3170 msg_puts(": ");
3171 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3172 vim_free(tofree);
3173 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003174 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3175 {
3176 msg_puts(" = ");
3177 msg_puts(((char **)(fp->uf_def_args.ga_data))
3178 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3179 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 }
3181 if (fp->uf_varargs)
3182 {
3183 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003184 msg_puts(", ");
3185 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003186 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003187 if (fp->uf_va_name != NULL)
3188 {
3189 if (j)
3190 msg_puts(", ");
3191 msg_puts("...");
3192 msg_puts((char *)fp->uf_va_name);
3193 if (fp->uf_va_type)
3194 {
3195 char *tofree;
3196
3197 msg_puts(": ");
3198 msg_puts(type_name(fp->uf_va_type, &tofree));
3199 vim_free(tofree);
3200 }
3201 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003202 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003203
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003204 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003205 {
3206 if (fp->uf_ret_type != &t_void)
3207 {
3208 char *tofree;
3209
3210 msg_puts(": ");
3211 msg_puts(type_name(fp->uf_ret_type, &tofree));
3212 vim_free(tofree);
3213 }
3214 }
3215 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003216 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003218 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003219 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003220 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003221 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003222 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 msg_clr_eos();
3224 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003225 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226}
3227
3228/*
3229 * Get a function name, translating "<SID>" and "<SNR>".
3230 * Also handles a Funcref in a List or Dictionary.
3231 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003232 * Set "*is_global" to TRUE when the function must be global, unless
3233 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 * flags:
3235 * TFN_INT: internal function name OK
3236 * TFN_QUIET: be quiet
3237 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003238 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239 * Advances "pp" to just after the function name (if no error).
3240 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003241 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242trans_function_name(
3243 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003244 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003245 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003246 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003247 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003248 partial_T **partial, // return: partial of a FuncRef
3249 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250{
3251 char_u *name = NULL;
3252 char_u *start;
3253 char_u *end;
3254 int lead;
3255 char_u sid_buf[20];
3256 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003257 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003259 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003260 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261
3262 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003263 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264 start = *pp;
3265
Bram Moolenaare38eab22019-12-05 21:50:01 +01003266 // Check for hard coded <SNR>: already translated function ID (from a user
3267 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3269 && (*pp)[2] == (int)KE_SNR)
3270 {
3271 *pp += 3;
3272 len = get_id_len(pp) + 3;
3273 return vim_strnsave(start, len);
3274 }
3275
Bram Moolenaare38eab22019-12-05 21:50:01 +01003276 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3277 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 lead = eval_fname_script(start);
3279 if (lead > 2)
3280 start += lead;
3281
Bram Moolenaare38eab22019-12-05 21:50:01 +01003282 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003283 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 lead > 2 ? 0 : FNE_CHECK_START);
3285 if (end == start)
3286 {
3287 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003288 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289 goto theend;
3290 }
3291 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3292 {
3293 /*
3294 * Report an invalid expression in braces, unless the expression
3295 * evaluation has been cancelled due to an aborting error, an
3296 * interrupt, or an exception.
3297 */
3298 if (!aborting())
3299 {
3300 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003301 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003302 }
3303 else
3304 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3305 goto theend;
3306 }
3307
3308 if (lv.ll_tv != NULL)
3309 {
3310 if (fdp != NULL)
3311 {
3312 fdp->fd_dict = lv.ll_dict;
3313 fdp->fd_newkey = lv.ll_newkey;
3314 lv.ll_newkey = NULL;
3315 fdp->fd_di = lv.ll_di;
3316 }
3317 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3318 {
3319 name = vim_strsave(lv.ll_tv->vval.v_string);
3320 *pp = end;
3321 }
3322 else if (lv.ll_tv->v_type == VAR_PARTIAL
3323 && lv.ll_tv->vval.v_partial != NULL)
3324 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003325 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003326 *pp = end;
3327 if (partial != NULL)
3328 *partial = lv.ll_tv->vval.v_partial;
3329 }
3330 else
3331 {
3332 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3333 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003334 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 else
3336 *pp = end;
3337 name = NULL;
3338 }
3339 goto theend;
3340 }
3341
3342 if (lv.ll_name == NULL)
3343 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003344 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 *pp = end;
3346 goto theend;
3347 }
3348
Bram Moolenaare38eab22019-12-05 21:50:01 +01003349 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 if (lv.ll_exp_name != NULL)
3351 {
3352 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003353 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 flags & TFN_NO_AUTOLOAD);
3355 if (name == lv.ll_exp_name)
3356 name = NULL;
3357 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003358 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359 {
3360 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003361 name = deref_func_name(*pp, &len, partial, type,
3362 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363 if (name == *pp)
3364 name = NULL;
3365 }
3366 if (name != NULL)
3367 {
3368 name = vim_strsave(name);
3369 *pp = end;
3370 if (STRNCMP(name, "<SNR>", 5) == 0)
3371 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003372 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 name[0] = K_SPECIAL;
3374 name[1] = KS_EXTRA;
3375 name[2] = (int)KE_SNR;
3376 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3377 }
3378 goto theend;
3379 }
3380
3381 if (lv.ll_exp_name != NULL)
3382 {
3383 len = (int)STRLEN(lv.ll_exp_name);
3384 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3385 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3386 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003387 // When there was "s:" already or the name expanded to get a
3388 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 lv.ll_name += 2;
3390 len -= 2;
3391 lead = 2;
3392 }
3393 }
3394 else
3395 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003396 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003398 {
3399 if (is_global != NULL && lv.ll_name[0] == 'g')
3400 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003402 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 len = (int)(end - lv.ll_name);
3404 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003405 if (len <= 0)
3406 {
3407 if (!skip)
3408 emsg(_(e_function_name));
3409 goto theend;
3410 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003412 // In Vim9 script a user function is script-local by default, unless it
3413 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003414 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003415 if (vim9script)
3416 {
3417 char_u *p;
3418
3419 // SomeScript#func() is a global function.
3420 for (p = start; *p != NUL && *p != '('; ++p)
3421 if (*p == AUTOLOAD_CHAR)
3422 vim9script = FALSE;
3423 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003424
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 /*
3426 * Copy the function name to allocated memory.
3427 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3428 * Accept <SNR>123_name() outside a script.
3429 */
3430 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003431 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003432 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003434 if (!vim9script)
3435 lead = 3;
3436 if (vim9script || (lv.ll_exp_name != NULL
3437 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438 || eval_fname_sid(*pp))
3439 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003440 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003441 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003443 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 goto theend;
3445 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003446 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003447 if (vim9script)
3448 extra = 3 + (int)STRLEN(sid_buf);
3449 else
3450 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003451 }
3452 }
3453 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3454 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003455 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 start);
3457 goto theend;
3458 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003459 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 {
3461 char_u *cp = vim_strchr(lv.ll_name, ':');
3462
3463 if (cp != NULL && cp < end)
3464 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003465 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 goto theend;
3467 }
3468 }
3469
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 if (name != NULL)
3472 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003473 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003474 {
3475 name[0] = K_SPECIAL;
3476 name[1] = KS_EXTRA;
3477 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003478 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 STRCPY(name + 3, sid_buf);
3480 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003481 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3482 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003483 }
3484 *pp = end;
3485
3486theend:
3487 clear_lval(&lv);
3488 return name;
3489}
3490
3491/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003492 * Assuming "name" is the result of trans_function_name() and it was prefixed
3493 * to use the script-local name, return the unmodified name (points into
3494 * "name"). Otherwise return NULL.
3495 * This can be used to first search for a script-local function and fall back
3496 * to the global function if not found.
3497 */
3498 char_u *
3499untrans_function_name(char_u *name)
3500{
3501 char_u *p;
3502
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003503 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003504 {
3505 p = vim_strchr(name, '_');
3506 if (p != NULL)
3507 return p + 1;
3508 }
3509 return NULL;
3510}
3511
3512/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003513 * List functions. When "regmatch" is NULL all of then.
3514 * Otherwise functions matching "regmatch".
3515 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003516 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003517list_functions(regmatch_T *regmatch)
3518{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003519 int changed = func_hashtab.ht_changed;
3520 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003521 hashitem_T *hi;
3522
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003523 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003524 {
3525 if (!HASHITEM_EMPTY(hi))
3526 {
3527 ufunc_T *fp = HI2UF(hi);
3528
3529 --todo;
3530 if ((fp->uf_flags & FC_DEAD) == 0
3531 && (regmatch == NULL
3532 ? !message_filtered(fp->uf_name)
3533 && !func_name_refcount(fp->uf_name)
3534 : !isdigit(*fp->uf_name)
3535 && vim_regexec(regmatch, fp->uf_name, 0)))
3536 {
3537 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003538 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003539 {
3540 emsg(_("E454: function list was modified"));
3541 return;
3542 }
3543 }
3544 }
3545 }
3546}
3547
3548/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003549 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003550 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3551 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003552 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003554 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003555define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003557 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 int j;
3559 int c;
3560 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003561 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003562 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 char_u *p;
3564 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003565 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566 char_u *line_arg = NULL;
3567 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003568 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003569 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 garray_T newlines;
3571 int varargs = FALSE;
3572 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003573 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003574 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003575 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 dictitem_T *v;
3577 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003578 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003580 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003581 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003582 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003583 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584
3585 /*
3586 * ":function" without argument: list functions.
3587 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003588 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 {
3590 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003591 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003593 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594 }
3595
3596 /*
3597 * ":function /pat": list functions matching pattern.
3598 */
3599 if (*eap->arg == '/')
3600 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003601 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 if (!eap->skip)
3603 {
3604 regmatch_T regmatch;
3605
3606 c = *p;
3607 *p = NUL;
3608 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3609 *p = c;
3610 if (regmatch.regprog != NULL)
3611 {
3612 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003613 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 vim_regfree(regmatch.regprog);
3615 }
3616 }
3617 if (*p == '/')
3618 ++p;
3619 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003620 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 }
3622
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003623 ga_init(&newargs);
3624 ga_init(&argtypes);
3625 ga_init(&default_args);
3626
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 /*
3628 * Get the function name. There are these situations:
3629 * func normal function name
3630 * "name" == func, "fudi.fd_dict" == NULL
3631 * dict.func new dictionary entry
3632 * "name" == NULL, "fudi.fd_dict" set,
3633 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3634 * dict.func existing dict entry with a Funcref
3635 * "name" == func, "fudi.fd_dict" set,
3636 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3637 * dict.func existing dict entry that's not a Funcref
3638 * "name" == NULL, "fudi.fd_dict" set,
3639 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3640 * s:func script-local function name
3641 * g:func global function name, same as "func"
3642 */
3643 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003644 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003646 // nested function, argument is (args).
3647 paren = TRUE;
3648 CLEAR_FIELD(fudi);
3649 }
3650 else
3651 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003652 if (STRNCMP(p, "<lambda>", 8) == 0)
3653 {
3654 p += 8;
3655 (void)getdigits(&p);
3656 name = vim_strnsave(eap->arg, p - eap->arg);
3657 CLEAR_FIELD(fudi);
3658 }
3659 else
3660 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003661 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003662 paren = (vim_strchr(p, '(') != NULL);
3663 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003665 /*
3666 * Return on an invalid expression in braces, unless the expression
3667 * evaluation has been cancelled due to an aborting error, an
3668 * interrupt, or an exception.
3669 */
3670 if (!aborting())
3671 {
3672 if (!eap->skip && fudi.fd_newkey != NULL)
3673 semsg(_(e_dictkey), fudi.fd_newkey);
3674 vim_free(fudi.fd_newkey);
3675 return NULL;
3676 }
3677 else
3678 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680 }
3681
Bram Moolenaare38eab22019-12-05 21:50:01 +01003682 // An error in a function call during evaluation of an expression in magic
3683 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 saved_did_emsg = did_emsg;
3685 did_emsg = FALSE;
3686
3687 /*
3688 * ":function func" with only function name: list function.
3689 */
3690 if (!paren)
3691 {
3692 if (!ends_excmd(*skipwhite(p)))
3693 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003694 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 goto ret_free;
3696 }
3697 eap->nextcmd = check_nextcmd(p);
3698 if (eap->nextcmd != NULL)
3699 *p = NUL;
3700 if (!eap->skip && !got_int)
3701 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003702 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003703 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3704 {
3705 char_u *up = untrans_function_name(name);
3706
3707 // With Vim9 script the name was made script-local, if not
3708 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003709 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003710 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003711 }
3712
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 if (fp != NULL)
3714 {
3715 list_func_head(fp, TRUE);
3716 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3717 {
3718 if (FUNCLINE(fp, j) == NULL)
3719 continue;
3720 msg_putchar('\n');
3721 msg_outnum((long)(j + 1));
3722 if (j < 9)
3723 msg_putchar(' ');
3724 if (j < 99)
3725 msg_putchar(' ');
3726 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003727 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003728 ui_breakcheck();
3729 }
3730 if (!got_int)
3731 {
3732 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003733 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003734 msg_puts(" enddef");
3735 else
3736 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 }
3738 }
3739 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003740 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 }
3742 goto ret_free;
3743 }
3744
3745 /*
3746 * ":function name(arg1, arg2)" Define function.
3747 */
3748 p = skipwhite(p);
3749 if (*p != '(')
3750 {
3751 if (!eap->skip)
3752 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003753 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754 goto ret_free;
3755 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003756 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 if (vim_strchr(p, '(') != NULL)
3758 p = vim_strchr(p, '(');
3759 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003761 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3762 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003763 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003764 goto ret_free;
3765 }
3766
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003767 // In Vim9 script only global functions can be redefined.
3768 if (vim9script && eap->forceit && !is_global)
3769 {
3770 emsg(_(e_nobang));
3771 goto ret_free;
3772 }
3773
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003774 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775
Bram Moolenaar04b12692020-05-04 23:24:44 +02003776 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003778 // Check the name of the function. Unless it's a dictionary function
3779 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 if (name != NULL)
3781 arg = name;
3782 else
3783 arg = fudi.fd_newkey;
3784 if (arg != NULL && (fudi.fd_di == NULL
3785 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3786 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3787 {
3788 if (*arg == K_SPECIAL)
3789 j = 3;
3790 else
3791 j = 0;
3792 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3793 : eval_isnamec(arg[j])))
3794 ++j;
3795 if (arg[j] != NUL)
3796 emsg_funcname((char *)e_invarg2, arg);
3797 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003798 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003800 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 }
3802
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003803 // This may get more lines and make the pointers into the first line
3804 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003805 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003806 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003807 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003808 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003809 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003811 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003813 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003815 // find the return type: :def Func(): type
3816 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003818 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003819 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003820 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003821 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003822 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003823 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003824 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003825 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003826 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003827 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003828 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003829 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003830 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003832 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003834 else
3835 // find extra arguments "range", "dict", "abort" and "closure"
3836 for (;;)
3837 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003838 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003839 p = skipwhite(p);
3840 if (STRNCMP(p, "range", 5) == 0)
3841 {
3842 flags |= FC_RANGE;
3843 p += 5;
3844 }
3845 else if (STRNCMP(p, "dict", 4) == 0)
3846 {
3847 flags |= FC_DICT;
3848 p += 4;
3849 }
3850 else if (STRNCMP(p, "abort", 5) == 0)
3851 {
3852 flags |= FC_ABORT;
3853 p += 5;
3854 }
3855 else if (STRNCMP(p, "closure", 7) == 0)
3856 {
3857 flags |= FC_CLOSURE;
3858 p += 7;
3859 if (current_funccal == NULL)
3860 {
3861 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3862 name == NULL ? (char_u *)"" : name);
3863 goto erret;
3864 }
3865 }
3866 else
3867 break;
3868 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869
Bram Moolenaare38eab22019-12-05 21:50:01 +01003870 // When there is a line break use what follows for the function body.
3871 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003872 if (*p == '\n')
3873 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003874 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003875 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3876 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003877 && !(VIM_ISWHITE(*whitep) && *p == '#'
3878 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003879 && !eap->skip
3880 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003881 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882
3883 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003884 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3885 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003886 */
3887 if (KeyTyped)
3888 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003889 // Check if the function already exists, don't let the user type the
3890 // whole function before telling him it doesn't work! For a script we
3891 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 if (!eap->skip && !eap->forceit)
3893 {
3894 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003895 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003896 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897 emsg_funcname(e_funcexts, name);
3898 }
3899
3900 if (!eap->skip && did_emsg)
3901 goto erret;
3902
Bram Moolenaare38eab22019-12-05 21:50:01 +01003903 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003904 cmdline_row = msg_row;
3905 }
3906
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003907 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003908 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003909
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003910 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 goto erret;
3912
3913 /*
3914 * If there are no errors, add the function
3915 */
3916 if (fudi.fd_dict == NULL)
3917 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003918 hashtab_T *ht;
3919
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003920 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003921 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3922 {
3923 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3924 name);
3925 goto erret;
3926 }
3927
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003928 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003929 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003931 char_u *uname = untrans_function_name(name);
3932
3933 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3934 }
3935
3936 if (fp != NULL || import != NULL)
3937 {
3938 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003939
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003940 // Function can be replaced with "function!" and when sourcing the
3941 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003942 // A name that is used by an import can not be overruled.
3943 if (import != NULL
3944 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003945 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003946 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003948 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003949 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003950 else
3951 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 goto erret;
3953 }
3954 if (fp->uf_calls > 0)
3955 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003956 emsg_funcname(
3957 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958 name);
3959 goto erret;
3960 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003961 if (fp->uf_refcount > 1)
3962 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003963 // This function is referenced somewhere, don't redefine it but
3964 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003965 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003966 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003967 fp = NULL;
3968 overwrite = TRUE;
3969 }
3970 else
3971 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003972 char_u *exp_name = fp->uf_name_exp;
3973
3974 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003975 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003976 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003977 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003978 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003979 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003980#ifdef FEAT_PROFILE
3981 fp->uf_profiling = FALSE;
3982 fp->uf_prof_initialized = FALSE;
3983#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003984 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003985 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 }
3987 }
3988 else
3989 {
3990 char numbuf[20];
3991
3992 fp = NULL;
3993 if (fudi.fd_newkey == NULL && !eap->forceit)
3994 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003995 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996 goto erret;
3997 }
3998 if (fudi.fd_di == NULL)
3999 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004000 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004001 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004002 goto erret;
4003 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004004 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004005 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006 goto erret;
4007
Bram Moolenaare38eab22019-12-05 21:50:01 +01004008 // Give the function a sequential number. Can only be used with a
4009 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 vim_free(name);
4011 sprintf(numbuf, "%d", ++func_nr);
4012 name = vim_strsave((char_u *)numbuf);
4013 if (name == NULL)
4014 goto erret;
4015 }
4016
4017 if (fp == NULL)
4018 {
4019 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4020 {
4021 int slen, plen;
4022 char_u *scriptname;
4023
Bram Moolenaare38eab22019-12-05 21:50:01 +01004024 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004026 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027 {
4028 scriptname = autoload_name(name);
4029 if (scriptname != NULL)
4030 {
4031 p = vim_strchr(scriptname, '/');
4032 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004033 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004035 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 j = OK;
4037 vim_free(scriptname);
4038 }
4039 }
4040 if (j == FAIL)
4041 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004042 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 goto erret;
4044 }
4045 }
4046
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004047 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048 if (fp == NULL)
4049 goto erret;
4050
4051 if (fudi.fd_dict != NULL)
4052 {
4053 if (fudi.fd_di == NULL)
4054 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004055 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4057 if (fudi.fd_di == NULL)
4058 {
4059 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004060 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061 goto erret;
4062 }
4063 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4064 {
4065 vim_free(fudi.fd_di);
4066 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004067 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068 goto erret;
4069 }
4070 }
4071 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004072 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 clear_tv(&fudi.fd_di->di_tv);
4074 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076
Bram Moolenaare38eab22019-12-05 21:50:01 +01004077 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078 flags |= FC_DICT;
4079 }
4080
Bram Moolenaare38eab22019-12-05 21:50:01 +01004081 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004082 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004083 if (overwrite)
4084 {
4085 hi = hash_find(&func_hashtab, name);
4086 hi->hi_key = UF2HIKEY(fp);
4087 }
4088 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089 {
4090 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004091 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 goto erret;
4093 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004094 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 }
4096 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004097 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004098 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004099 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004100
4101 if (eap->cmdidx == CMD_def)
4102 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004103 int lnum_save = SOURCING_LNUM;
4104 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004105
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004106 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004107
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004108 // error messages are for the first function line
4109 SOURCING_LNUM = sourcing_lnum_top;
4110
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004111 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004112 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004113 int count = cstack->cs_idx + 1;
4114 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004115
4116 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004117 // a block that is visible now but not when the function is called
4118 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004119 fp->uf_block_ids = ALLOC_MULT(int, count);
4120 if (fp->uf_block_ids != NULL)
4121 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004122 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004123 sizeof(int) * count);
4124 fp->uf_block_depth = count;
4125 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004126
4127 // Set flag in each block to indicate a function was defined. This
4128 // is used to keep the variable when leaving the block, see
4129 // hide_script_var().
4130 for (i = 0; i <= cstack->cs_idx; ++i)
4131 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004132 }
4133
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004134 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004136 SOURCING_LNUM = lnum_save;
4137 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004138 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004139 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004140
4141 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004142 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004143 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004144 SOURCING_LNUM = lnum_save;
4145 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004146 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004147 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004148 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004149 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004150 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004151
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004152 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004153 if ((flags & FC_CLOSURE) != 0)
4154 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004155 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004156 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004157 }
4158 else
4159 fp->uf_scoped = NULL;
4160
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004161#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162 if (prof_def_func())
4163 func_do_profile(fp);
4164#endif
4165 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004166 if (sandbox)
4167 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004168 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004169 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 fp->uf_flags = flags;
4171 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004172 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004173 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004174 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004175 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004176 if (is_export)
4177 {
4178 fp->uf_flags |= FC_EXPORT;
4179 // let ex_export() know the export worked.
4180 is_export = FALSE;
4181 }
4182
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004183 if (eap->cmdidx == CMD_def)
4184 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004185 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4186 // :func does not use Vim9 script syntax, even in a Vim9 script file
4187 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004188
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 goto ret_free;
4190
4191erret:
4192 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004193 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004194 if (fp != NULL)
4195 {
4196 ga_init(&fp->uf_args);
4197 ga_init(&fp->uf_def_args);
4198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199errret_2:
4200 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004201 if (fp != NULL)
4202 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004204 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004205 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004206 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004207 if (name != name_arg)
4208 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004209 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004210 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004211
4212 return fp;
4213}
4214
4215/*
4216 * ":function"
4217 */
4218 void
4219ex_function(exarg_T *eap)
4220{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004221 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004222}
4223
4224/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004225 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004226 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004227 */
4228 void
4229ex_defcompile(exarg_T *eap UNUSED)
4230{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004231 long todo = (long)func_hashtab.ht_used;
4232 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004233 hashitem_T *hi;
4234 ufunc_T *ufunc;
4235
4236 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4237 {
4238 if (!HASHITEM_EMPTY(hi))
4239 {
4240 --todo;
4241 ufunc = HI2UF(hi);
4242 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004243 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4244 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004245 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004246 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004247
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004248 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004249 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004250 // a function has been added or removed, need to start over
4251 todo = (long)func_hashtab.ht_used;
4252 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004253 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004254 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004255 }
4256 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004257 }
4258 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259}
4260
4261/*
4262 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4263 * Return 2 if "p" starts with "s:".
4264 * Return 0 otherwise.
4265 */
4266 int
4267eval_fname_script(char_u *p)
4268{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004269 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4270 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004271 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4272 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4273 return 5;
4274 if (p[0] == 's' && p[1] == ':')
4275 return 2;
4276 return 0;
4277}
4278
4279 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004280translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281{
4282 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004283 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004284 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004285}
4286
4287/*
4288 * Return TRUE when "ufunc" has old-style "..." varargs
4289 * or named varargs "...name: type".
4290 */
4291 int
4292has_varargs(ufunc_T *ufunc)
4293{
4294 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004295}
4296
4297/*
4298 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004299 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 */
4301 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004302function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303{
4304 char_u *nm = name;
4305 char_u *p;
4306 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004307 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004308 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004310 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4311 if (no_deref)
4312 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004313 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 nm = skipwhite(nm);
4315
Bram Moolenaare38eab22019-12-05 21:50:01 +01004316 // Only accept "funcname", "funcname ", "funcname (..." and
4317 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004319 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320 vim_free(p);
4321 return n;
4322}
4323
Bram Moolenaar113e1072019-01-20 15:30:40 +01004324#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 char_u *
4326get_expanded_name(char_u *name, int check)
4327{
4328 char_u *nm = name;
4329 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004330 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004332 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004333 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004334
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004335 if (p != NULL && *nm == NUL
4336 && (!check || translated_function_exists(p, is_global)))
4337 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004338
4339 vim_free(p);
4340 return NULL;
4341}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004342#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004344/*
4345 * Function given to ExpandGeneric() to obtain the list of user defined
4346 * function names.
4347 */
4348 char_u *
4349get_user_func_name(expand_T *xp, int idx)
4350{
4351 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004352 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353 static hashitem_T *hi;
4354 ufunc_T *fp;
4355
4356 if (idx == 0)
4357 {
4358 done = 0;
4359 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004360 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004362 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363 {
4364 if (done++ > 0)
4365 ++hi;
4366 while (HASHITEM_EMPTY(hi))
4367 ++hi;
4368 fp = HI2UF(hi);
4369
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004370 // don't show dead, dict and lambda functions
4371 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004372 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004373 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374
4375 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004376 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377
4378 cat_func_name(IObuff, fp);
4379 if (xp->xp_context != EXPAND_USER_FUNC)
4380 {
4381 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004382 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383 STRCAT(IObuff, ")");
4384 }
4385 return IObuff;
4386 }
4387 return NULL;
4388}
4389
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390/*
4391 * ":delfunction {name}"
4392 */
4393 void
4394ex_delfunction(exarg_T *eap)
4395{
4396 ufunc_T *fp = NULL;
4397 char_u *p;
4398 char_u *name;
4399 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004400 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004401
4402 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004403 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4404 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 vim_free(fudi.fd_newkey);
4406 if (name == NULL)
4407 {
4408 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004409 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 return;
4411 }
4412 if (!ends_excmd(*skipwhite(p)))
4413 {
4414 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004415 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 return;
4417 }
4418 eap->nextcmd = check_nextcmd(p);
4419 if (eap->nextcmd != NULL)
4420 *p = NUL;
4421
4422 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004423 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424 vim_free(name);
4425
4426 if (!eap->skip)
4427 {
4428 if (fp == NULL)
4429 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004430 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004431 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004432 return;
4433 }
4434 if (fp->uf_calls > 0)
4435 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004436 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 return;
4438 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004439 if (fp->uf_flags & FC_VIM9)
4440 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004441 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004442 return;
4443 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004444
4445 if (fudi.fd_dict != NULL)
4446 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004447 // Delete the dict item that refers to the function, it will
4448 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4450 }
4451 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004452 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004453 // A normal function (not a numbered function or lambda) has a
4454 // refcount of 1 for the entry in the hashtable. When deleting
4455 // it and the refcount is more than one, it should be kept.
4456 // A numbered function and lambda should be kept if the refcount is
4457 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004458 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004459 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004460 // Function is still referenced somewhere. Don't free it but
4461 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004462 if (func_remove(fp))
4463 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004464 }
4465 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004466 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004467 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 }
4469}
4470
4471/*
4472 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004473 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474 */
4475 void
4476func_unref(char_u *name)
4477{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004478 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004480 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004482 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004483 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004484 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004486 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004488 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004490 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004491}
4492
4493/*
4494 * Unreference a Function: decrement the reference count and free it when it
4495 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004496 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004497 */
4498 void
4499func_ptr_unref(ufunc_T *fp)
4500{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004501 if (fp != NULL && (--fp->uf_refcount <= 0
4502 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4503 && fp->uf_partial->pt_refcount <= 1
4504 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004505 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004506 // Only delete it when it's not being used. Otherwise it's done
4507 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004508 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004509 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 }
4511}
4512
4513/*
4514 * Count a reference to a Function.
4515 */
4516 void
4517func_ref(char_u *name)
4518{
4519 ufunc_T *fp;
4520
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004521 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004522 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004523 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004524 if (fp != NULL)
4525 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004526 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004527 // Only give an error for a numbered function.
4528 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004529 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004530}
4531
4532/*
4533 * Count a reference to a Function.
4534 */
4535 void
4536func_ptr_ref(ufunc_T *fp)
4537{
4538 if (fp != NULL)
4539 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004540}
4541
4542/*
4543 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4544 * referenced from anywhere that is in use.
4545 */
4546 static int
4547can_free_funccal(funccall_T *fc, int copyID)
4548{
4549 return (fc->l_varlist.lv_copyID != copyID
4550 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004551 && fc->l_avars.dv_copyID != copyID
4552 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004553}
4554
4555/*
4556 * ":return [expr]"
4557 */
4558 void
4559ex_return(exarg_T *eap)
4560{
4561 char_u *arg = eap->arg;
4562 typval_T rettv;
4563 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004564 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565
4566 if (current_funccal == NULL)
4567 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004568 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 return;
4570 }
4571
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004572 CLEAR_FIELD(evalarg);
4573 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4574
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 if (eap->skip)
4576 ++emsg_skip;
4577
4578 eap->nextcmd = NULL;
4579 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004580 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 {
4582 if (!eap->skip)
4583 returning = do_return(eap, FALSE, TRUE, &rettv);
4584 else
4585 clear_tv(&rettv);
4586 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004587 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004588 else if (!eap->skip)
4589 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004590 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004591 update_force_abort();
4592
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 /*
4594 * Return unless the expression evaluation has been cancelled due to an
4595 * aborting error, an interrupt, or an exception.
4596 */
4597 if (!aborting())
4598 returning = do_return(eap, FALSE, TRUE, NULL);
4599 }
4600
Bram Moolenaare38eab22019-12-05 21:50:01 +01004601 // When skipping or the return gets pending, advance to the next command
4602 // in this line (!returning). Otherwise, ignore the rest of the line.
4603 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 if (returning)
4605 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004606 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607 eap->nextcmd = check_nextcmd(arg);
4608
4609 if (eap->skip)
4610 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004611 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004612}
4613
4614/*
4615 * ":1,25call func(arg1, arg2)" function call.
4616 */
4617 void
4618ex_call(exarg_T *eap)
4619{
4620 char_u *arg = eap->arg;
4621 char_u *startarg;
4622 char_u *name;
4623 char_u *tofree;
4624 int len;
4625 typval_T rettv;
4626 linenr_T lnum;
4627 int doesrange;
4628 int failed = FALSE;
4629 funcdict_T fudi;
4630 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004631 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004632 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633
Bram Moolenaare6b53242020-07-01 17:28:33 +02004634 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004635 if (eap->skip)
4636 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004637 // trans_function_name() doesn't work well when skipping, use eval0()
4638 // instead to skip to any following command, e.g. for:
4639 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004640 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004641 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 clear_tv(&rettv);
4643 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004644 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 return;
4646 }
4647
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004648 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4649 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004650 if (fudi.fd_newkey != NULL)
4651 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004652 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004653 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004654 vim_free(fudi.fd_newkey);
4655 }
4656 if (tofree == NULL)
4657 return;
4658
Bram Moolenaare38eab22019-12-05 21:50:01 +01004659 // Increase refcount on dictionary, it could get deleted when evaluating
4660 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661 if (fudi.fd_dict != NULL)
4662 ++fudi.fd_dict->dv_refcount;
4663
Bram Moolenaare38eab22019-12-05 21:50:01 +01004664 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4665 // contents. For VAR_PARTIAL get its partial, unless we already have one
4666 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004668 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4669 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670
Bram Moolenaare38eab22019-12-05 21:50:01 +01004671 // Skip white space to allow ":call func ()". Not good, but required for
4672 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004673 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004674 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675
4676 if (*startarg != '(')
4677 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004678 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679 goto end;
4680 }
4681
4682 /*
4683 * When skipping, evaluate the function once, to find the end of the
4684 * arguments.
4685 * When the function takes a range, this is discovered after the first
4686 * call, and the loop is broken.
4687 */
4688 if (eap->skip)
4689 {
4690 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004691 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692 }
4693 else
4694 lnum = eap->line1;
4695 for ( ; lnum <= eap->line2; ++lnum)
4696 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004697 funcexe_T funcexe;
4698
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 if (!eap->skip && eap->addr_count > 0)
4700 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004701 if (lnum > curbuf->b_ml.ml_line_count)
4702 {
4703 // If the function deleted lines or switched to another buffer
4704 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004705 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004706 break;
4707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 curwin->w_cursor.lnum = lnum;
4709 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004710 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 }
4712 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004713
Bram Moolenaara80faa82020-04-12 19:37:17 +02004714 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004715 funcexe.firstline = eap->line1;
4716 funcexe.lastline = eap->line2;
4717 funcexe.doesrange = &doesrange;
4718 funcexe.evaluate = !eap->skip;
4719 funcexe.partial = partial;
4720 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004721 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004722 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 {
4724 failed = TRUE;
4725 break;
4726 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004727 if (has_watchexpr())
4728 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004730 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004731 if (handle_subscript(&arg, &rettv,
4732 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 {
4734 failed = TRUE;
4735 break;
4736 }
4737
4738 clear_tv(&rettv);
4739 if (doesrange || eap->skip)
4740 break;
4741
Bram Moolenaare38eab22019-12-05 21:50:01 +01004742 // Stop when immediately aborting on error, or when an interrupt
4743 // occurred or an exception was thrown but not caught.
4744 // get_func_tv() returned OK, so that the check for trailing
4745 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 if (aborting())
4747 break;
4748 }
4749 if (eap->skip)
4750 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004751 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752
Bram Moolenaare51bb172020-02-16 19:42:23 +01004753 // When inside :try we need to check for following "| catch".
4754 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004755 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004756 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004757 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004758 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004759 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004760 if (!failed)
4761 {
4762 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004763 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004764 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004765 }
4766 else
4767 eap->nextcmd = check_nextcmd(arg);
4768 }
4769
4770end:
4771 dict_unref(fudi.fd_dict);
4772 vim_free(tofree);
4773}
4774
4775/*
4776 * Return from a function. Possibly makes the return pending. Also called
4777 * for a pending return at the ":endtry" or after returning from an extra
4778 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4779 * when called due to a ":return" command. "rettv" may point to a typval_T
4780 * with the return rettv. Returns TRUE when the return can be carried out,
4781 * FALSE when the return gets pending.
4782 */
4783 int
4784do_return(
4785 exarg_T *eap,
4786 int reanimate,
4787 int is_cmd,
4788 void *rettv)
4789{
4790 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004791 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004792
4793 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004794 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 current_funccal->returned = FALSE;
4796
4797 /*
4798 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4799 * not in its finally clause (which then is to be executed next) is found.
4800 * In this case, make the ":return" pending for execution at the ":endtry".
4801 * Otherwise, return normally.
4802 */
4803 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4804 if (idx >= 0)
4805 {
4806 cstack->cs_pending[idx] = CSTP_RETURN;
4807
4808 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004809 // A pending return again gets pending. "rettv" points to an
4810 // allocated variable with the rettv of the original ":return"'s
4811 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 cstack->cs_rettv[idx] = rettv;
4813 else
4814 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004815 // When undoing a return in order to make it pending, get the stored
4816 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004817 if (reanimate)
4818 rettv = current_funccal->rettv;
4819
4820 if (rettv != NULL)
4821 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004822 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4824 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4825 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004826 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 }
4828 else
4829 cstack->cs_rettv[idx] = NULL;
4830
4831 if (reanimate)
4832 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004833 // The pending return value could be overwritten by a ":return"
4834 // without argument in a finally clause; reset the default
4835 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836 current_funccal->rettv->v_type = VAR_NUMBER;
4837 current_funccal->rettv->vval.v_number = 0;
4838 }
4839 }
4840 report_make_pending(CSTP_RETURN, rettv);
4841 }
4842 else
4843 {
4844 current_funccal->returned = TRUE;
4845
Bram Moolenaare38eab22019-12-05 21:50:01 +01004846 // If the return is carried out now, store the return value. For
4847 // a return immediately after reanimation, the value is already
4848 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 if (!reanimate && rettv != NULL)
4850 {
4851 clear_tv(current_funccal->rettv);
4852 *current_funccal->rettv = *(typval_T *)rettv;
4853 if (!is_cmd)
4854 vim_free(rettv);
4855 }
4856 }
4857
4858 return idx < 0;
4859}
4860
4861/*
4862 * Free the variable with a pending return value.
4863 */
4864 void
4865discard_pending_return(void *rettv)
4866{
4867 free_tv((typval_T *)rettv);
4868}
4869
4870/*
4871 * Generate a return command for producing the value of "rettv". The result
4872 * is an allocated string. Used by report_pending() for verbose messages.
4873 */
4874 char_u *
4875get_return_cmd(void *rettv)
4876{
4877 char_u *s = NULL;
4878 char_u *tofree = NULL;
4879 char_u numbuf[NUMBUFLEN];
4880
4881 if (rettv != NULL)
4882 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4883 if (s == NULL)
4884 s = (char_u *)"";
4885
4886 STRCPY(IObuff, ":return ");
4887 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4888 if (STRLEN(s) + 8 >= IOSIZE)
4889 STRCPY(IObuff + IOSIZE - 4, "...");
4890 vim_free(tofree);
4891 return vim_strsave(IObuff);
4892}
4893
4894/*
4895 * Get next function line.
4896 * Called by do_cmdline() to get the next line.
4897 * Returns allocated string, or NULL for end of function.
4898 */
4899 char_u *
4900get_func_line(
4901 int c UNUSED,
4902 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004903 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004904 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905{
4906 funccall_T *fcp = (funccall_T *)cookie;
4907 ufunc_T *fp = fcp->func;
4908 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004909 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910
Bram Moolenaare38eab22019-12-05 21:50:01 +01004911 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912 if (fcp->dbg_tick != debug_tick)
4913 {
4914 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004915 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916 fcp->dbg_tick = debug_tick;
4917 }
4918#ifdef FEAT_PROFILE
4919 if (do_profiling == PROF_YES)
4920 func_line_end(cookie);
4921#endif
4922
4923 gap = &fp->uf_lines;
4924 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4925 || fcp->returned)
4926 retval = NULL;
4927 else
4928 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004929 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930 while (fcp->linenr < gap->ga_len
4931 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4932 ++fcp->linenr;
4933 if (fcp->linenr >= gap->ga_len)
4934 retval = NULL;
4935 else
4936 {
4937 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004938 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939#ifdef FEAT_PROFILE
4940 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004941 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942#endif
4943 }
4944 }
4945
Bram Moolenaare38eab22019-12-05 21:50:01 +01004946 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004947 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004948 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004949 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004950 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004951 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004952 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 fcp->dbg_tick = debug_tick;
4954 }
4955
4956 return retval;
4957}
4958
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004959/*
4960 * Return TRUE if the currently active function should be ended, because a
4961 * return was encountered or an error occurred. Used inside a ":while".
4962 */
4963 int
4964func_has_ended(void *cookie)
4965{
4966 funccall_T *fcp = (funccall_T *)cookie;
4967
Bram Moolenaare38eab22019-12-05 21:50:01 +01004968 // Ignore the "abort" flag if the abortion behavior has been changed due to
4969 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004970 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4971 || fcp->returned);
4972}
4973
4974/*
4975 * return TRUE if cookie indicates a function which "abort"s on errors.
4976 */
4977 int
4978func_has_abort(
4979 void *cookie)
4980{
4981 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4982}
4983
4984
4985/*
4986 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4987 * Don't do this when "Func" is already a partial that was bound
4988 * explicitly (pt_auto is FALSE).
4989 * Changes "rettv" in-place.
4990 * Returns the updated "selfdict_in".
4991 */
4992 dict_T *
4993make_partial(dict_T *selfdict_in, typval_T *rettv)
4994{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004995 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004996 char_u *tofree = NULL;
4997 ufunc_T *fp;
4998 char_u fname_buf[FLEN_FIXED + 1];
4999 int error;
5000 dict_T *selfdict = selfdict_in;
5001
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005002 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5003 fp = rettv->vval.v_partial->pt_func;
5004 else
5005 {
5006 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5007 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005008 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005009 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005010 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005011 vim_free(tofree);
5012 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005013
5014 if (fp != NULL && (fp->uf_flags & FC_DICT))
5015 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005016 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017
5018 if (pt != NULL)
5019 {
5020 pt->pt_refcount = 1;
5021 pt->pt_dict = selfdict;
5022 pt->pt_auto = TRUE;
5023 selfdict = NULL;
5024 if (rettv->v_type == VAR_FUNC)
5025 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005026 // Just a function: Take over the function name and use
5027 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 pt->pt_name = rettv->vval.v_string;
5029 }
5030 else
5031 {
5032 partial_T *ret_pt = rettv->vval.v_partial;
5033 int i;
5034
Bram Moolenaare38eab22019-12-05 21:50:01 +01005035 // Partial: copy the function name, use selfdict and copy
5036 // args. Can't take over name or args, the partial might
5037 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005038 if (ret_pt->pt_name != NULL)
5039 {
5040 pt->pt_name = vim_strsave(ret_pt->pt_name);
5041 func_ref(pt->pt_name);
5042 }
5043 else
5044 {
5045 pt->pt_func = ret_pt->pt_func;
5046 func_ptr_ref(pt->pt_func);
5047 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005048 if (ret_pt->pt_argc > 0)
5049 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005050 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005051 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005052 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005053 pt->pt_argc = 0;
5054 else
5055 {
5056 pt->pt_argc = ret_pt->pt_argc;
5057 for (i = 0; i < pt->pt_argc; i++)
5058 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5059 }
5060 }
5061 partial_unref(ret_pt);
5062 }
5063 rettv->v_type = VAR_PARTIAL;
5064 rettv->vval.v_partial = pt;
5065 }
5066 }
5067 return selfdict;
5068}
5069
5070/*
5071 * Return the name of the executed function.
5072 */
5073 char_u *
5074func_name(void *cookie)
5075{
5076 return ((funccall_T *)cookie)->func->uf_name;
5077}
5078
5079/*
5080 * Return the address holding the next breakpoint line for a funccall cookie.
5081 */
5082 linenr_T *
5083func_breakpoint(void *cookie)
5084{
5085 return &((funccall_T *)cookie)->breakpoint;
5086}
5087
5088/*
5089 * Return the address holding the debug tick for a funccall cookie.
5090 */
5091 int *
5092func_dbg_tick(void *cookie)
5093{
5094 return &((funccall_T *)cookie)->dbg_tick;
5095}
5096
5097/*
5098 * Return the nesting level for a funccall cookie.
5099 */
5100 int
5101func_level(void *cookie)
5102{
5103 return ((funccall_T *)cookie)->level;
5104}
5105
5106/*
5107 * Return TRUE when a function was ended by a ":return" command.
5108 */
5109 int
5110current_func_returned(void)
5111{
5112 return current_funccal->returned;
5113}
5114
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115 int
5116free_unref_funccal(int copyID, int testing)
5117{
5118 int did_free = FALSE;
5119 int did_free_funccal = FALSE;
5120 funccall_T *fc, **pfc;
5121
5122 for (pfc = &previous_funccal; *pfc != NULL; )
5123 {
5124 if (can_free_funccal(*pfc, copyID))
5125 {
5126 fc = *pfc;
5127 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005128 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005129 did_free = TRUE;
5130 did_free_funccal = TRUE;
5131 }
5132 else
5133 pfc = &(*pfc)->caller;
5134 }
5135 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005136 // When a funccal was freed some more items might be garbage
5137 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005138 (void)garbage_collect(testing);
5139
5140 return did_free;
5141}
5142
5143/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005144 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145 */
5146 static funccall_T *
5147get_funccal(void)
5148{
5149 int i;
5150 funccall_T *funccal;
5151 funccall_T *temp_funccal;
5152
5153 funccal = current_funccal;
5154 if (debug_backtrace_level > 0)
5155 {
5156 for (i = 0; i < debug_backtrace_level; i++)
5157 {
5158 temp_funccal = funccal->caller;
5159 if (temp_funccal)
5160 funccal = temp_funccal;
5161 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005162 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005163 debug_backtrace_level = i;
5164 }
5165 }
5166 return funccal;
5167}
5168
5169/*
5170 * Return the hashtable used for local variables in the current funccal.
5171 * Return NULL if there is no current funccal.
5172 */
5173 hashtab_T *
5174get_funccal_local_ht()
5175{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005176 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 return NULL;
5178 return &get_funccal()->l_vars.dv_hashtab;
5179}
5180
5181/*
5182 * Return the l: scope variable.
5183 * Return NULL if there is no current funccal.
5184 */
5185 dictitem_T *
5186get_funccal_local_var()
5187{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005188 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005189 return NULL;
5190 return &get_funccal()->l_vars_var;
5191}
5192
5193/*
5194 * Return the hashtable used for argument in the current funccal.
5195 * Return NULL if there is no current funccal.
5196 */
5197 hashtab_T *
5198get_funccal_args_ht()
5199{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005200 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201 return NULL;
5202 return &get_funccal()->l_avars.dv_hashtab;
5203}
5204
5205/*
5206 * Return the a: scope variable.
5207 * Return NULL if there is no current funccal.
5208 */
5209 dictitem_T *
5210get_funccal_args_var()
5211{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005212 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005213 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005214 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215}
5216
5217/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218 * List function variables, if there is a function.
5219 */
5220 void
5221list_func_vars(int *first)
5222{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005223 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005225 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005226}
5227
5228/*
5229 * If "ht" is the hashtable for local variables in the current funccal, return
5230 * the dict that contains it.
5231 * Otherwise return NULL.
5232 */
5233 dict_T *
5234get_current_funccal_dict(hashtab_T *ht)
5235{
5236 if (current_funccal != NULL
5237 && ht == &current_funccal->l_vars.dv_hashtab)
5238 return &current_funccal->l_vars;
5239 return NULL;
5240}
5241
5242/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005243 * Search hashitem in parent scope.
5244 */
5245 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005246find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005247{
5248 funccall_T *old_current_funccal = current_funccal;
5249 hashtab_T *ht;
5250 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005251 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005252
5253 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5254 return NULL;
5255
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005256 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005257 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005258 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005259 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005260 ht = find_var_ht(name, &varname);
5261 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005262 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005263 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005264 if (!HASHITEM_EMPTY(hi))
5265 {
5266 *pht = ht;
5267 break;
5268 }
5269 }
5270 if (current_funccal == current_funccal->func->uf_scoped)
5271 break;
5272 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005273 }
5274 current_funccal = old_current_funccal;
5275
5276 return hi;
5277}
5278
5279/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005280 * Search variable in parent scope.
5281 */
5282 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005283find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005284{
5285 dictitem_T *v = NULL;
5286 funccall_T *old_current_funccal = current_funccal;
5287 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005288 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005289
5290 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5291 return NULL;
5292
Bram Moolenaare38eab22019-12-05 21:50:01 +01005293 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005294 current_funccal = current_funccal->func->uf_scoped;
5295 while (current_funccal)
5296 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005297 ht = find_var_ht(name, &varname);
5298 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005299 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005300 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005301 if (v != NULL)
5302 break;
5303 }
5304 if (current_funccal == current_funccal->func->uf_scoped)
5305 break;
5306 current_funccal = current_funccal->func->uf_scoped;
5307 }
5308 current_funccal = old_current_funccal;
5309
5310 return v;
5311}
5312
5313/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 * Set "copyID + 1" in previous_funccal and callers.
5315 */
5316 int
5317set_ref_in_previous_funccal(int copyID)
5318{
5319 int abort = FALSE;
5320 funccall_T *fc;
5321
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005322 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005323 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005324 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005325 abort = abort
5326 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5327 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005328 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329 }
5330 return abort;
5331}
5332
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005333 static int
5334set_ref_in_funccal(funccall_T *fc, int copyID)
5335{
5336 int abort = FALSE;
5337
5338 if (fc->fc_copyID != copyID)
5339 {
5340 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005341 abort = abort
5342 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5343 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005344 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005345 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005346 }
5347 return abort;
5348}
5349
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005350/*
5351 * Set "copyID" in all local vars and arguments in the call stack.
5352 */
5353 int
5354set_ref_in_call_stack(int copyID)
5355{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005356 int abort = FALSE;
5357 funccall_T *fc;
5358 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005360 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005361 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005362
5363 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005364 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5365 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005366 abort = abort || set_ref_in_funccal(fc, copyID);
5367
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005368 return abort;
5369}
5370
5371/*
5372 * Set "copyID" in all functions available by name.
5373 */
5374 int
5375set_ref_in_functions(int copyID)
5376{
5377 int todo;
5378 hashitem_T *hi = NULL;
5379 int abort = FALSE;
5380 ufunc_T *fp;
5381
5382 todo = (int)func_hashtab.ht_used;
5383 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005384 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005385 if (!HASHITEM_EMPTY(hi))
5386 {
5387 --todo;
5388 fp = HI2UF(hi);
5389 if (!func_name_refcount(fp->uf_name))
5390 abort = abort || set_ref_in_func(NULL, fp, copyID);
5391 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005392 }
5393 return abort;
5394}
5395
5396/*
5397 * Set "copyID" in all function arguments.
5398 */
5399 int
5400set_ref_in_func_args(int copyID)
5401{
5402 int i;
5403 int abort = FALSE;
5404
5405 for (i = 0; i < funcargs.ga_len; ++i)
5406 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5407 copyID, NULL, NULL);
5408 return abort;
5409}
5410
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005411/*
5412 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005413 * Returns TRUE if setting references failed somehow.
5414 */
5415 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005416set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005417{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005418 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005419 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005420 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005421 char_u fname_buf[FLEN_FIXED + 1];
5422 char_u *tofree = NULL;
5423 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005424 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005425
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005426 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005427 return FALSE;
5428
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005429 if (fp_in == NULL)
5430 {
5431 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005432 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005433 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005434 if (fp != NULL)
5435 {
5436 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005437 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005438 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005439
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005440 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005441 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005442}
5443
Bram Moolenaare38eab22019-12-05 21:50:01 +01005444#endif // FEAT_EVAL