blob: ba7e0c3da2be4ba84533af9f9ab630c5556131ac [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 Moolenaara9b579f2016-07-17 18:29:19 +0200310 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200311 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200312 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200313 // Don't give this error when skipping, it makes the "->" not
314 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100315 // Allow missing space after comma in legacy functions.
316 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200317 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
318 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100319 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200320 goto err_ret;
321 }
322 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 else
324 mustend = TRUE;
325 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200326 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200327 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200328 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200329
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200330 if (*p != endchar)
331 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100332 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200333
334 *argp = p;
335 return OK;
336
337err_ret:
338 if (newargs != NULL)
339 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200340 if (default_args != NULL)
341 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200342 return FAIL;
343}
344
345/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100346 * Parse the argument types, filling "fp->uf_arg_types".
347 * Return OK or FAIL.
348 */
349 static int
350parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
351{
352 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
353 if (argtypes->ga_len > 0)
354 {
355 // When "varargs" is set the last name/type goes into uf_va_name
356 // and uf_va_type.
357 int len = argtypes->ga_len - (varargs ? 1 : 0);
358
359 if (len > 0)
360 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
361 if (fp->uf_arg_types != NULL)
362 {
363 int i;
364 type_T *type;
365
366 for (i = 0; i < len; ++ i)
367 {
368 char_u *p = ((char_u **)argtypes->ga_data)[i];
369
370 if (p == NULL)
371 // will get the type from the default value
372 type = &t_unknown;
373 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100374 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100375 if (type == NULL)
376 return FAIL;
377 fp->uf_arg_types[i] = type;
378 }
379 }
380 if (varargs)
381 {
382 char_u *p;
383
384 // Move the last argument "...name: type" to uf_va_name and
385 // uf_va_type.
386 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
387 [fp->uf_args.ga_len - 1];
388 --fp->uf_args.ga_len;
389 p = ((char_u **)argtypes->ga_data)[len];
390 if (p == NULL)
391 // todo: get type from default value
392 fp->uf_va_type = &t_any;
393 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100394 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100395 if (fp->uf_va_type == NULL)
396 return FAIL;
397 }
398 }
399 return OK;
400}
401
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100402 static int
403parse_return_type(ufunc_T *fp, char_u *ret_type)
404{
405 if (ret_type == NULL)
406 fp->uf_ret_type = &t_void;
407 else
408 {
409 char_u *p = ret_type;
410
411 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
412 if (fp->uf_ret_type == NULL)
413 {
414 fp->uf_ret_type = &t_void;
415 return FAIL;
416 }
417 }
418 return OK;
419}
420
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100421/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200422 * Register function "fp" as using "current_funccal" as its scope.
423 */
424 static int
425register_closure(ufunc_T *fp)
426{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200427 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100428 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200429 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200430 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200431 fp->uf_scoped = current_funccal;
432 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200433
Bram Moolenaar58016442016-07-31 18:30:22 +0200434 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
435 return FAIL;
436 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
437 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200438 return OK;
439}
440
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100441 static void
442set_ufunc_name(ufunc_T *fp, char_u *name)
443{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100444 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
445 // actually extends beyond the struct.
446 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100447
448 if (name[0] == K_SPECIAL)
449 {
450 fp->uf_name_exp = alloc(STRLEN(name) + 3);
451 if (fp->uf_name_exp != NULL)
452 {
453 STRCPY(fp->uf_name_exp, "<SNR>");
454 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
455 }
456 }
457}
458
Bram Moolenaar58016442016-07-31 18:30:22 +0200459/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200460 * Get a name for a lambda. Returned in static memory.
461 */
462 char_u *
463get_lambda_name(void)
464{
465 static char_u name[30];
466 static int lambda_no = 0;
467
468 sprintf((char*)name, "<lambda>%d", ++lambda_no);
469 return name;
470}
471
Bram Moolenaar801ab062020-06-25 19:27:56 +0200472#if defined(FEAT_LUA) || defined(PROTO)
473/*
474 * Registers a native C callback which can be called from Vim script.
475 * Returns the name of the Vim script function.
476 */
477 char_u *
478register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
479{
480 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200481 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200482
483 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
484 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200485 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200486
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200487 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200488 fp->uf_refcount = 1;
489 fp->uf_varargs = TRUE;
490 fp->uf_flags = FC_CFUNC;
491 fp->uf_calls = 0;
492 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200493 fp->uf_cb = cb;
494 fp->uf_cb_free = cb_free;
495 fp->uf_cb_state = state;
496
497 set_ufunc_name(fp, name);
498 hash_add(&func_hashtab, UF2HIKEY(fp));
499
500 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200501}
502#endif
503
Bram Moolenaar04b12692020-05-04 23:24:44 +0200504/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100505 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100506 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100507 * If "white_error" is not NULL check for correct use of white space and set
508 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100509 * Return NULL if no valid arrow found.
510 */
511 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100512skip_arrow(
513 char_u *start,
514 int equal_arrow,
515 char_u **ret_type,
516 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100517{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100518 char_u *s = start;
519 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100520
521 if (equal_arrow)
522 {
523 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100524 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100525 if (white_error != NULL && !VIM_ISWHITE(s[1]))
526 {
527 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100528 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100529 return NULL;
530 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100531 s = skipwhite(s + 1);
532 *ret_type = s;
533 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100534 if (s == *ret_type)
535 {
536 emsg(_(e_missing_return_type));
537 return NULL;
538 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100539 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100540 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100541 s = skipwhite(s);
542 if (*s != '=')
543 return NULL;
544 ++s;
545 }
546 if (*s != '>')
547 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100548 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
549 || !IS_WHITE_OR_NUL(s[1])))
550 {
551 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100552 semsg(_(e_white_space_required_before_and_after_str_at_str),
553 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 return NULL;
555 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556 return skipwhite(s + 1);
557}
558
559/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100560 * Check if "*cmd" points to a function command and if so advance "*cmd" and
561 * return TRUE.
562 * Otherwise return FALSE;
563 * Do not consider "function(" to be a command.
564 */
565 static int
566is_function_cmd(char_u **cmd)
567{
568 char_u *p = *cmd;
569
570 if (checkforcmd(&p, "function", 2))
571 {
572 if (*p == '(')
573 return FALSE;
574 *cmd = p;
575 return TRUE;
576 }
577 return FALSE;
578}
579
580/*
581 * Read the body of a function, put every line in "newlines".
582 * "newlines" must already have been initialized.
583 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
584 */
585 static int
586get_function_body(
587 exarg_T *eap,
588 garray_T *newlines,
589 char_u *line_arg_in,
590 char_u **line_to_free)
591{
592 linenr_T sourcing_lnum_top = SOURCING_LNUM;
593 linenr_T sourcing_lnum_off;
594 int saved_wait_return = need_wait_return;
595 char_u *line_arg = line_arg_in;
596 int vim9_function = eap->cmdidx == CMD_def
597 || eap->cmdidx == CMD_block;
598#define MAX_FUNC_NESTING 50
599 char nesting_def[MAX_FUNC_NESTING];
600 int nesting = 0;
601 getline_opt_T getline_options;
602 int indent = 2;
603 char_u *skip_until = NULL;
604 int ret = FAIL;
605 int is_heredoc = FALSE;
606 char_u *heredoc_trimmed = NULL;
607
608 // Detect having skipped over comment lines to find the return
609 // type. Add NULL lines to keep the line count correct.
610 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
611 if (SOURCING_LNUM < sourcing_lnum_off)
612 {
613 sourcing_lnum_off -= SOURCING_LNUM;
614 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
615 goto theend;
616 while (sourcing_lnum_off-- > 0)
617 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
618 }
619
620 nesting_def[nesting] = vim9_function;
621 getline_options = vim9_function
622 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
623 for (;;)
624 {
625 char_u *theline;
626 char_u *p;
627 char_u *arg;
628
629 if (KeyTyped)
630 {
631 msg_scroll = TRUE;
632 saved_wait_return = FALSE;
633 }
634 need_wait_return = FALSE;
635
636 if (line_arg != NULL)
637 {
638 // Use eap->arg, split up in parts by line breaks.
639 theline = line_arg;
640 p = vim_strchr(theline, '\n');
641 if (p == NULL)
642 line_arg += STRLEN(line_arg);
643 else
644 {
645 *p = NUL;
646 line_arg = p + 1;
647 }
648 }
649 else
650 {
651 vim_free(*line_to_free);
652 if (eap->getline == NULL)
653 theline = getcmdline(':', 0L, indent, getline_options);
654 else
655 theline = eap->getline(':', eap->cookie, indent,
656 getline_options);
657 *line_to_free = theline;
658 }
659 if (KeyTyped)
660 lines_left = Rows - 1;
661 if (theline == NULL)
662 {
663 // Use the start of the function for the line number.
664 SOURCING_LNUM = sourcing_lnum_top;
665 if (skip_until != NULL)
666 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
667 else if (eap->cmdidx == CMD_def)
668 emsg(_(e_missing_enddef));
669 else if (eap->cmdidx == CMD_block)
670 emsg(_(e_missing_end_block));
671 else
672 emsg(_("E126: Missing :endfunction"));
673 goto theend;
674 }
675
676 // Detect line continuation: SOURCING_LNUM increased more than one.
677 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
678 if (SOURCING_LNUM < sourcing_lnum_off)
679 sourcing_lnum_off -= SOURCING_LNUM;
680 else
681 sourcing_lnum_off = 0;
682
683 if (skip_until != NULL)
684 {
685 // Don't check for ":endfunc"/":enddef" between
686 // * ":append" and "."
687 // * ":python <<EOF" and "EOF"
688 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
689 if (heredoc_trimmed == NULL
690 || (is_heredoc && skipwhite(theline) == theline)
691 || STRNCMP(theline, heredoc_trimmed,
692 STRLEN(heredoc_trimmed)) == 0)
693 {
694 if (heredoc_trimmed == NULL)
695 p = theline;
696 else if (is_heredoc)
697 p = skipwhite(theline) == theline
698 ? theline : theline + STRLEN(heredoc_trimmed);
699 else
700 p = theline + STRLEN(heredoc_trimmed);
701 if (STRCMP(p, skip_until) == 0)
702 {
703 VIM_CLEAR(skip_until);
704 VIM_CLEAR(heredoc_trimmed);
705 getline_options = vim9_function
706 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
707 is_heredoc = FALSE;
708 }
709 }
710 }
711 else
712 {
713 int c;
714
715 // skip ':' and blanks
716 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
717 ;
718
719 // Check for "endfunction", "enddef" or "}".
720 // When a ":" follows it must be a dict key; "enddef: value,"
721 if ((nesting == 0 && eap->cmdidx == CMD_block)
722 ? *p == '}'
723 : (checkforcmd(&p, nesting_def[nesting]
724 ? "enddef" : "endfunction", 4)
725 && *p != ':'))
726 {
727 if (nesting-- == 0)
728 {
729 char_u *nextcmd = NULL;
730
731 if (*p == '|' || *p == '}')
732 nextcmd = p + 1;
733 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
734 nextcmd = line_arg;
735 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100736 && (vim9_function || p_verbose > 0))
737 {
738 if (eap->cmdidx == CMD_def)
739 semsg(_(e_text_found_after_enddef_str), p);
740 else
741 give_warning2((char_u *)
742 _("W22: Text found after :endfunction: %s"),
743 p, TRUE);
744 }
745 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100746 {
747 // Another command follows. If the line came from "eap"
748 // we can simply point into it, otherwise we need to
749 // change "eap->cmdlinep".
750 eap->nextcmd = nextcmd;
751 if (*line_to_free != NULL)
752 {
753 vim_free(*eap->cmdlinep);
754 *eap->cmdlinep = *line_to_free;
755 *line_to_free = NULL;
756 }
757 }
758 break;
759 }
760 }
761
762 // Check for mismatched "endfunc" or "enddef".
763 // We don't check for "def" inside "func" thus we also can't check
764 // for "enddef".
765 // We continue to find the end of the function, although we might
766 // not find it.
767 else if (nesting_def[nesting])
768 {
769 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
770 emsg(_(e_mismatched_endfunction));
771 }
772 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
773 emsg(_(e_mismatched_enddef));
774
775 // Increase indent inside "if", "while", "for" and "try", decrease
776 // at "end".
777 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
778 indent -= 2;
779 else if (STRNCMP(p, "if", 2) == 0
780 || STRNCMP(p, "wh", 2) == 0
781 || STRNCMP(p, "for", 3) == 0
782 || STRNCMP(p, "try", 3) == 0)
783 indent += 2;
784
785 // Check for defining a function inside this function.
786 // Only recognize "def" inside "def", not inside "function",
787 // For backwards compatibility, see Test_function_python().
788 c = *p;
789 if (is_function_cmd(&p)
790 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
791 {
792 if (*p == '!')
793 p = skipwhite(p + 1);
794 p += eval_fname_script(p);
795 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
796 NULL, NULL));
797 if (*skipwhite(p) == '(')
798 {
799 if (nesting == MAX_FUNC_NESTING - 1)
800 emsg(_(e_function_nesting_too_deep));
801 else
802 {
803 ++nesting;
804 nesting_def[nesting] = (c == 'd');
805 indent += 2;
806 }
807 }
808 }
809
810 // Check for ":append", ":change", ":insert". Not for :def.
811 p = skip_range(p, FALSE, NULL);
812 if (!vim9_function
813 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
814 || (p[0] == 'c'
815 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
816 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
817 && (STRNCMP(&p[3], "nge", 3) != 0
818 || !ASCII_ISALPHA(p[6])))))))
819 || (p[0] == 'i'
820 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
821 && (!ASCII_ISALPHA(p[2])
822 || (p[2] == 's'
823 && (!ASCII_ISALPHA(p[3])
824 || p[3] == 'e'))))))))
825 skip_until = vim_strsave((char_u *)".");
826
827 // Check for ":python <<EOF", ":tcl <<EOF", etc.
828 arg = skipwhite(skiptowhite(p));
829 if (arg[0] == '<' && arg[1] =='<'
830 && ((p[0] == 'p' && p[1] == 'y'
831 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
832 || ((p[2] == '3' || p[2] == 'x')
833 && !ASCII_ISALPHA(p[3]))))
834 || (p[0] == 'p' && p[1] == 'e'
835 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
836 || (p[0] == 't' && p[1] == 'c'
837 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
838 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
839 && !ASCII_ISALPHA(p[3]))
840 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
841 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
842 || (p[0] == 'm' && p[1] == 'z'
843 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
844 ))
845 {
846 // ":python <<" continues until a dot, like ":append"
847 p = skipwhite(arg + 2);
848 if (STRNCMP(p, "trim", 4) == 0)
849 {
850 // Ignore leading white space.
851 p = skipwhite(p + 4);
852 heredoc_trimmed = vim_strnsave(theline,
853 skipwhite(theline) - theline);
854 }
855 if (*p == NUL)
856 skip_until = vim_strsave((char_u *)".");
857 else
858 skip_until = vim_strnsave(p, skiptowhite(p) - p);
859 getline_options = GETLINE_NONE;
860 is_heredoc = TRUE;
861 }
862
863 // Check for ":cmd v =<< [trim] EOF"
864 // and ":cmd [a, b] =<< [trim] EOF"
865 // and "lines =<< [trim] EOF" for Vim9
866 // Where "cmd" can be "let", "var", "final" or "const".
867 arg = skipwhite(skiptowhite(p));
868 if (*arg == '[')
869 arg = vim_strchr(arg, ']');
870 if (arg != NULL)
871 {
872 int found = (eap->cmdidx == CMD_def && arg[0] == '='
873 && arg[1] == '<' && arg[2] =='<');
874
875 if (!found)
876 // skip over the argument after "cmd"
877 arg = skipwhite(skiptowhite(arg));
878 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
879 && (checkforcmd(&p, "let", 2)
880 || checkforcmd(&p, "var", 3)
881 || checkforcmd(&p, "final", 5)
882 || checkforcmd(&p, "const", 5))))
883 {
884 p = skipwhite(arg + 3);
885 if (STRNCMP(p, "trim", 4) == 0)
886 {
887 // Ignore leading white space.
888 p = skipwhite(p + 4);
889 heredoc_trimmed = vim_strnsave(theline,
890 skipwhite(theline) - theline);
891 }
892 skip_until = vim_strnsave(p, skiptowhite(p) - p);
893 getline_options = GETLINE_NONE;
894 is_heredoc = TRUE;
895 }
896 }
897 }
898
899 // Add the line to the function.
900 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
901 goto theend;
902
903 // Copy the line to newly allocated memory. get_one_sourceline()
904 // allocates 250 bytes per line, this saves 80% on average. The cost
905 // is an extra alloc/free.
906 p = vim_strsave(theline);
907 if (p == NULL)
908 goto theend;
909 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
910
911 // Add NULL lines for continuation lines, so that the line count is
912 // equal to the index in the growarray.
913 while (sourcing_lnum_off-- > 0)
914 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
915
916 // Check for end of eap->arg.
917 if (line_arg != NULL && *line_arg == NUL)
918 line_arg = NULL;
919 }
920
921 // Don't define the function when skipping commands or when an error was
922 // detected.
923 if (!eap->skip && !did_emsg)
924 ret = OK;
925
926theend:
927 vim_free(skip_until);
928 vim_free(heredoc_trimmed);
929 need_wait_return |= saved_wait_return;
930 return ret;
931}
932
933/*
934 * Handle the body of a lambda. *arg points to the "{", process statements
935 * until the matching "}".
936 * When successful "rettv" is set to a funcref.
937 */
938 static int
939lambda_function_body(
940 char_u **arg,
941 typval_T *rettv,
942 evalarg_T *evalarg,
943 garray_T *newargs,
944 garray_T *argtypes,
945 int varargs,
946 garray_T *default_args,
947 char_u *ret_type)
948{
949 int evaluate = evalarg != NULL
950 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +0100951 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100952 exarg_T eap;
953 garray_T newlines;
954 char_u *cmdline = NULL;
955 int ret = FAIL;
956 char_u *line_to_free = NULL;
957 partial_T *pt;
958 char_u *name;
959 int lnum_save = -1;
960 linenr_T sourcing_lnum_top = SOURCING_LNUM;
961
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100962 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
963 {
964 semsg(_(e_trailing_arg), *arg + 1);
965 return FAIL;
966 }
967
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100968 CLEAR_FIELD(eap);
969 eap.cmdidx = CMD_block;
970 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100971 eap.cmdlinep = &cmdline;
972 eap.skip = !evaluate;
973 if (evalarg->eval_cctx != NULL)
974 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
975 else
976 {
977 eap.getline = evalarg->eval_getline;
978 eap.cookie = evalarg->eval_cookie;
979 }
980
981 ga_init2(&newlines, (int)sizeof(char_u *), 10);
982 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100983 {
984 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100985 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100986 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100987 if (cmdline != NULL)
988 {
989 // Something comes after the "}".
990 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100991
992 // "arg" points into cmdline, need to keep the line and free it later.
993 vim_free(evalarg->eval_tofree_cmdline);
994 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100995 }
996 else
997 *arg = (char_u *)"";
998
999 name = get_lambda_name();
1000 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1001 if (ufunc == NULL)
1002 goto erret;
1003 set_ufunc_name(ufunc, name);
1004 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001005 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001006 ufunc->uf_refcount = 1;
1007 ufunc->uf_args = *newargs;
1008 newargs->ga_data = NULL;
1009 ufunc->uf_def_args = *default_args;
1010 default_args->ga_data = NULL;
1011 ufunc->uf_func_type = &t_func_any;
1012
1013 // error messages are for the first function line
1014 lnum_save = SOURCING_LNUM;
1015 SOURCING_LNUM = sourcing_lnum_top;
1016
1017 // parse argument types
1018 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1019 {
1020 SOURCING_LNUM = lnum_save;
1021 goto erret;
1022 }
1023
1024 // parse the return type, if any
1025 if (parse_return_type(ufunc, ret_type) == FAIL)
1026 goto erret;
1027
1028 pt = ALLOC_CLEAR_ONE(partial_T);
1029 if (pt == NULL)
1030 goto erret;
1031 pt->pt_func = ufunc;
1032 pt->pt_refcount = 1;
1033
1034 ufunc->uf_lines = newlines;
1035 newlines.ga_data = NULL;
1036 if (sandbox)
1037 ufunc->uf_flags |= FC_SANDBOX;
1038 if (!ASCII_ISUPPER(*ufunc->uf_name))
1039 ufunc->uf_flags |= FC_VIM9;
1040 ufunc->uf_script_ctx = current_sctx;
1041 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1042 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1043 set_function_type(ufunc);
1044
1045 rettv->vval.v_partial = pt;
1046 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001047 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001048 ret = OK;
1049
1050erret:
1051 if (lnum_save >= 0)
1052 SOURCING_LNUM = lnum_save;
1053 vim_free(line_to_free);
1054 ga_clear_strings(&newlines);
1055 ga_clear_strings(newargs);
1056 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001057 if (ufunc != NULL)
1058 {
1059 func_clear(ufunc, TRUE);
1060 func_free(ufunc, TRUE);
1061 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001062 return ret;
1063}
1064
1065/*
1066 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001067 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001068 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001069 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1070 */
1071 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001072get_lambda_tv(
1073 char_u **arg,
1074 typval_T *rettv,
1075 int types_optional,
1076 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001077{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001078 int evaluate = evalarg != NULL
1079 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001080 garray_T newargs;
1081 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001082 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001083 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001084 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001085 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001086 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001087 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001088 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001089 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001090 char_u *s;
1091 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001092 int *old_eval_lavars = eval_lavars_used;
1093 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001094 char_u *tofree1 = NULL;
1095 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001096 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001097 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001098 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001099
1100 if (equal_arrow && !in_vim9script())
1101 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001102
1103 ga_init(&newargs);
1104 ga_init(&newlines);
1105
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001106 // First, check if this is really a lambda expression. "->" or "=>" must
1107 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001108 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001109 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001110 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001111 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001112 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001113 {
1114 if (types_optional)
1115 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001116 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001117 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001118
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001119 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001120 if (evaluate)
1121 pnewargs = &newargs;
1122 else
1123 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001124 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001125 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001126 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001127 &varargs, &default_args,
1128 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001129 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001130 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001131 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001132 {
1133 if (types_optional)
1134 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001135 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001136 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001137 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001138 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001139
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001140 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1141 if (ret_type != NULL)
1142 {
1143 ret_type = vim_strsave(ret_type);
1144 tofree2 = ret_type;
1145 }
1146
Bram Moolenaare38eab22019-12-05 21:50:01 +01001147 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001148 if (evaluate)
1149 eval_lavars_used = &eval_lavars;
1150
Bram Moolenaar65c44152020-12-24 15:14:01 +01001151 *arg = skipwhite_and_linebreak(*arg, evalarg);
1152
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001153 // Recognize "{" as the start of a function body.
1154 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001155 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001156 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1157 types_optional ? &argtypes : NULL, varargs,
1158 &default_args, ret_type) == FAIL)
1159 goto errret;
1160 goto theend;
1161 }
1162 if (default_args.ga_len > 0)
1163 {
1164 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001165 goto errret;
1166 }
1167
Bram Moolenaare38eab22019-12-05 21:50:01 +01001168 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001169 start = *arg;
1170 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001171 if (ret == FAIL)
1172 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001173 if (evalarg != NULL)
1174 {
1175 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001176 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001177 evalarg->eval_tofree = NULL;
1178 }
1179
Bram Moolenaar65c44152020-12-24 15:14:01 +01001180 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001181 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001182 *arg = skipwhite_and_linebreak(*arg, evalarg);
1183 if (**arg != '}')
1184 {
1185 semsg(_("E451: Expected }: %s"), *arg);
1186 goto errret;
1187 }
1188 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001189 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001190
1191 if (evaluate)
1192 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001193 int len;
1194 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001195 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001196 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001197
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001198 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001199 if (fp == NULL)
1200 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001201 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001202 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001203 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001204 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001205
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001206 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1207 if (ga_grow(&newlines, 1) == FAIL)
1208 goto errret;
1209
Bram Moolenaare38eab22019-12-05 21:50:01 +01001210 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001211 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001212 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001213 if (p == NULL)
1214 goto errret;
1215 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1216 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001217 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001218 if (strstr((char *)p + 7, "a:") == NULL)
1219 // No a: variables are used for sure.
1220 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001221
1222 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001223 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001224 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001225 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001226 if (types_optional)
1227 {
1228 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
1229 goto errret;
1230 if (ret_type != NULL)
1231 {
1232 fp->uf_ret_type = parse_type(&ret_type,
1233 &fp->uf_type_list, TRUE);
1234 if (fp->uf_ret_type == NULL)
1235 goto errret;
1236 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001237 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001238 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001239 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001240
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001241 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001242 if (current_funccal != NULL && eval_lavars)
1243 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001244 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001245 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001246 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001247 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001248
1249#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001250 if (prof_def_func())
1251 func_do_profile(fp);
1252#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001253 if (sandbox)
1254 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001255 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001256 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001257 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001258 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001259 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001260 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001261
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001262 pt->pt_func = fp;
1263 pt->pt_refcount = 1;
1264 rettv->vval.v_partial = pt;
1265 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001266
1267 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001268 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001269
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001270theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001271 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001272 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001273 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001274 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001275 vim_free(tofree1);
1276 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001277 if (types_optional)
1278 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001279 return OK;
1280
1281errret:
1282 ga_clear_strings(&newargs);
1283 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001284 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001285 if (types_optional)
1286 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001287 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001288 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001289 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001290 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001291 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001292 vim_free(tofree1);
1293 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001294 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001295 return FAIL;
1296}
1297
1298/*
1299 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1300 * name it contains, otherwise return "name".
1301 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1302 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001303 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1304 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001305 */
1306 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001307deref_func_name(
1308 char_u *name,
1309 int *lenp,
1310 partial_T **partialp,
1311 type_T **type,
1312 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001313{
1314 dictitem_T *v;
1315 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001316 char_u *s = NULL;
1317 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001318
1319 if (partialp != NULL)
1320 *partialp = NULL;
1321
1322 cc = name[*lenp];
1323 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001324 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001325 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001326 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001327 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001328 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001329 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001330 if (v->di_tv.vval.v_string == NULL)
1331 {
1332 *lenp = 0;
1333 return (char_u *)""; // just in case
1334 }
1335 s = v->di_tv.vval.v_string;
1336 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001337 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001338
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001339 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001340 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001341 partial_T *pt = v->di_tv.vval.v_partial;
1342
1343 if (pt == NULL)
1344 {
1345 *lenp = 0;
1346 return (char_u *)""; // just in case
1347 }
1348 if (partialp != NULL)
1349 *partialp = pt;
1350 s = partial_name(pt);
1351 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001352 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001353
1354 if (s != NULL)
1355 {
1356 if (type != NULL && ht == get_script_local_ht())
1357 {
1358 svar_T *sv = find_typval_in_script(&v->di_tv);
1359
1360 if (sv != NULL)
1361 *type = sv->sv_type;
1362 }
1363 return s;
1364 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 }
1366
1367 return name;
1368}
1369
1370/*
1371 * Give an error message with a function name. Handle <SNR> things.
1372 * "ermsg" is to be passed without translation, use N_() instead of _().
1373 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001374 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001375emsg_funcname(char *ermsg, char_u *name)
1376{
1377 char_u *p;
1378
1379 if (*name == K_SPECIAL)
1380 p = concat_str((char_u *)"<SNR>", name + 3);
1381 else
1382 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001383 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001384 if (p != name)
1385 vim_free(p);
1386}
1387
1388/*
1389 * Allocate a variable for the result of a function.
1390 * Return OK or FAIL.
1391 */
1392 int
1393get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001394 char_u *name, // name of the function
1395 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001396 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001397 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001398 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001399 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001400{
1401 char_u *argp;
1402 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001403 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1404 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001405 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001406
1407 /*
1408 * Get the arguments.
1409 */
1410 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001411 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1412 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001413 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001414 // skip the '(' or ',' and possibly line breaks
1415 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1416
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001417 if (*argp == ')' || *argp == ',' || *argp == NUL)
1418 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001419 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001420 {
1421 ret = FAIL;
1422 break;
1423 }
1424 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001425 // The comma should come right after the argument, but this wasn't
1426 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001427 if (vim9script)
1428 {
1429 if (*argp != ',' && *skipwhite(argp) == ',')
1430 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001431 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001432 ret = FAIL;
1433 break;
1434 }
1435 }
1436 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001437 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438 if (*argp != ',')
1439 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001440 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1441 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001442 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001443 ret = FAIL;
1444 break;
1445 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001446 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001447 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448 if (*argp == ')')
1449 ++argp;
1450 else
1451 ret = FAIL;
1452
1453 if (ret == OK)
1454 {
1455 int i = 0;
1456
1457 if (get_vim_var_nr(VV_TESTING))
1458 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001459 // Prepare for calling test_garbagecollect_now(), need to know
1460 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001461 if (funcargs.ga_itemsize == 0)
1462 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1463 for (i = 0; i < argcount; ++i)
1464 if (ga_grow(&funcargs, 1) == OK)
1465 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1466 &argvars[i];
1467 }
1468
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001469 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001470
1471 funcargs.ga_len -= i;
1472 }
1473 else if (!aborting())
1474 {
1475 if (argcount == MAX_FUNC_ARGS)
1476 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1477 else
1478 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1479 }
1480
1481 while (--argcount >= 0)
1482 clear_tv(&argvars[argcount]);
1483
Bram Moolenaar8294d492020-08-10 22:40:56 +02001484 if (in_vim9script())
1485 *arg = argp;
1486 else
1487 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488 return ret;
1489}
1490
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001491/*
1492 * Return TRUE if "p" starts with "<SID>" or "s:".
1493 * Only works if eval_fname_script() returned non-zero for "p"!
1494 */
1495 static int
1496eval_fname_sid(char_u *p)
1497{
1498 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1499}
1500
1501/*
1502 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1503 * Change <SNR>123_name() to K_SNR 123_name().
1504 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1505 * (slow).
1506 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001507 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1509{
1510 int llen;
1511 char_u *fname;
1512 int i;
1513
1514 llen = eval_fname_script(name);
1515 if (llen > 0)
1516 {
1517 fname_buf[0] = K_SPECIAL;
1518 fname_buf[1] = KS_EXTRA;
1519 fname_buf[2] = (int)KE_SNR;
1520 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001521 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001523 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001524 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 else
1526 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001527 sprintf((char *)fname_buf + 3, "%ld_",
1528 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 i = (int)STRLEN(fname_buf);
1530 }
1531 }
1532 if (i + STRLEN(name + llen) < FLEN_FIXED)
1533 {
1534 STRCPY(fname_buf + i, name + llen);
1535 fname = fname_buf;
1536 }
1537 else
1538 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001539 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001540 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001541 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001542 else
1543 {
1544 *tofree = fname;
1545 mch_memmove(fname, fname_buf, (size_t)i);
1546 STRCPY(fname + i, name + llen);
1547 }
1548 }
1549 }
1550 else
1551 fname = name;
1552 return fname;
1553}
1554
1555/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001556 * Find a function "name" in script "sid".
1557 */
1558 static ufunc_T *
1559find_func_with_sid(char_u *name, int sid)
1560{
1561 hashitem_T *hi;
1562 char_u buffer[200];
1563
1564 buffer[0] = K_SPECIAL;
1565 buffer[1] = KS_EXTRA;
1566 buffer[2] = (int)KE_SNR;
1567 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1568 (long)sid, name);
1569 hi = hash_find(&func_hashtab, buffer);
1570 if (!HASHITEM_EMPTY(hi))
1571 return HI2UF(hi);
1572
1573 return NULL;
1574}
1575
1576/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001578 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001579 * Return NULL for unknown function.
1580 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001581 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001582find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001583{
1584 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001585 ufunc_T *func;
1586 imported_T *imported;
1587
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001588 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001589 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001590 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001591 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001592 int find_script_local = in_vim9script()
1593 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001594
Bram Moolenaar95006e32020-08-29 17:47:08 +02001595 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001596 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001597 // Find script-local function before global one.
1598 func = find_func_with_sid(name, current_sctx.sc_sid);
1599 if (func != NULL)
1600 return func;
1601 }
1602
Bram Moolenaarefa94442020-08-08 22:16:00 +02001603 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001604 && name[1] == KS_EXTRA
1605 && name[2] == KE_SNR)
1606 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001607 // Caller changes s: to <SNR>99_name.
1608
1609 after_script = name + 3;
1610 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001611 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001612 ++after_script;
1613 else
1614 after_script = NULL;
1615 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001616 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001617 {
1618 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001619 if (after_script != NULL && sid != current_sctx.sc_sid)
1620 imported = find_imported_in_script(after_script, 0, sid);
1621 else
1622 imported = find_imported(after_script == NULL
1623 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001624 if (imported != NULL && imported->imp_funcname != NULL)
1625 {
1626 hi = hash_find(&func_hashtab, imported->imp_funcname);
1627 if (!HASHITEM_EMPTY(hi))
1628 return HI2UF(hi);
1629 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001630 }
1631 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001632
Bram Moolenaara26b9702020-04-18 19:53:28 +02001633 hi = hash_find(&func_hashtab,
1634 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 if (!HASHITEM_EMPTY(hi))
1636 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001637
1638 return NULL;
1639}
1640
1641/*
1642 * Find a function by name, return pointer to it in ufuncs.
1643 * "cctx" is passed in a :def function to find imported functions.
1644 * Return NULL for unknown or dead function.
1645 */
1646 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001647find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001648{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001649 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001650
1651 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1652 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653 return NULL;
1654}
1655
1656/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001657 * Return TRUE if "ufunc" is a global function.
1658 */
1659 int
1660func_is_global(ufunc_T *ufunc)
1661{
1662 return ufunc->uf_name[0] != K_SPECIAL;
1663}
1664
1665/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001666 * Copy the function name of "fp" to buffer "buf".
1667 * "buf" must be able to hold the function name plus three bytes.
1668 * Takes care of script-local function names.
1669 */
1670 static void
1671cat_func_name(char_u *buf, ufunc_T *fp)
1672{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001673 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001674 {
1675 STRCPY(buf, "<SNR>");
1676 STRCAT(buf, fp->uf_name + 3);
1677 }
1678 else
1679 STRCPY(buf, fp->uf_name);
1680}
1681
1682/*
1683 * Add a number variable "name" to dict "dp" with value "nr".
1684 */
1685 static void
1686add_nr_var(
1687 dict_T *dp,
1688 dictitem_T *v,
1689 char *name,
1690 varnumber_T nr)
1691{
1692 STRCPY(v->di_key, name);
1693 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1694 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1695 v->di_tv.v_type = VAR_NUMBER;
1696 v->di_tv.v_lock = VAR_FIXED;
1697 v->di_tv.vval.v_number = nr;
1698}
1699
1700/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001701 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001702 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001703 static void
1704free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001706 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001707
1708 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1709 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001710 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001711
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001712 // When garbage collecting a funccall_T may be freed before the
1713 // function that references it, clear its uf_scoped field.
1714 // The function may have been redefined and point to another
1715 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001716 if (fp != NULL && fp->uf_scoped == fc)
1717 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001718 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001719 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001721 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 vim_free(fc);
1723}
1724
1725/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001726 * Free "fc" and what it contains.
1727 * Can be called only when "fc" is kept beyond the period of it called,
1728 * i.e. after cleanup_function_call(fc).
1729 */
1730 static void
1731free_funccal_contents(funccall_T *fc)
1732{
1733 listitem_T *li;
1734
1735 // Free all l: variables.
1736 vars_clear(&fc->l_vars.dv_hashtab);
1737
1738 // Free all a: variables.
1739 vars_clear(&fc->l_avars.dv_hashtab);
1740
1741 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001742 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001743 clear_tv(&li->li_tv);
1744
1745 free_funccal(fc);
1746}
1747
1748/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001749 * Handle the last part of returning from a function: free the local hashtable.
1750 * Unless it is still in use by a closure.
1751 */
1752 static void
1753cleanup_function_call(funccall_T *fc)
1754{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001755 int may_free_fc = fc->fc_refcount <= 0;
1756 int free_fc = TRUE;
1757
Bram Moolenaar6914c642017-04-01 21:21:30 +02001758 current_funccal = fc->caller;
1759
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001760 // Free all l: variables if not referred.
1761 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1762 vars_clear(&fc->l_vars.dv_hashtab);
1763 else
1764 free_fc = FALSE;
1765
1766 // If the a:000 list and the l: and a: dicts are not referenced and
1767 // there is no closure using it, we can free the funccall_T and what's
1768 // in it.
1769 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1770 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001771 else
1772 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001773 int todo;
1774 hashitem_T *hi;
1775 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001776
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001777 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001778
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001779 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001780 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1781 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1782 {
1783 if (!HASHITEM_EMPTY(hi))
1784 {
1785 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001786 di = HI2DI(hi);
1787 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001788 }
1789 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001790 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001791
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001792 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1793 fc->l_varlist.lv_first = NULL;
1794 else
1795 {
1796 listitem_T *li;
1797
1798 free_fc = FALSE;
1799
1800 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001801 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001802 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001803 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001804
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001805 if (free_fc)
1806 free_funccal(fc);
1807 else
1808 {
1809 static int made_copy = 0;
1810
1811 // "fc" is still in use. This can happen when returning "a:000",
1812 // assigning "l:" to a global variable or defining a closure.
1813 // Link "fc" in the list for garbage collection later.
1814 fc->caller = previous_funccal;
1815 previous_funccal = fc;
1816
1817 if (want_garbage_collect)
1818 // If garbage collector is ready, clear count.
1819 made_copy = 0;
1820 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001821 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001822 // We have made a lot of copies, worth 4 Mbyte. This can happen
1823 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001824 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001825 // too much memory.
1826 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001827 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001828 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001829 }
1830}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001831
1832/*
1833 * There are two kinds of function names:
1834 * 1. ordinary names, function defined with :function or :def
1835 * 2. numbered functions and lambdas
1836 * For the first we only count the name stored in func_hashtab as a reference,
1837 * using function() does not count as a reference, because the function is
1838 * looked up by name.
1839 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001840 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001841func_name_refcount(char_u *name)
1842{
1843 return isdigit(*name) || *name == '<';
1844}
1845
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001846/*
1847 * Unreference "fc": decrement the reference count and free it when it
1848 * becomes zero. "fp" is detached from "fc".
1849 * When "force" is TRUE we are exiting.
1850 */
1851 static void
1852funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1853{
1854 funccall_T **pfc;
1855 int i;
1856
1857 if (fc == NULL)
1858 return;
1859
1860 if (--fc->fc_refcount <= 0 && (force || (
1861 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1862 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1863 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1864 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1865 {
1866 if (fc == *pfc)
1867 {
1868 *pfc = fc->caller;
1869 free_funccal_contents(fc);
1870 return;
1871 }
1872 }
1873 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1874 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1875 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1876}
1877
1878/*
1879 * Remove the function from the function hashtable. If the function was
1880 * deleted while it still has references this was already done.
1881 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1882 */
1883 static int
1884func_remove(ufunc_T *fp)
1885{
1886 hashitem_T *hi;
1887
1888 // Return if it was already virtually deleted.
1889 if (fp->uf_flags & FC_DEAD)
1890 return FALSE;
1891
1892 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1893 if (!HASHITEM_EMPTY(hi))
1894 {
1895 // When there is a def-function index do not actually remove the
1896 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001897 // Do remove it when it's a copy.
1898 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001899 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001900 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001901 return FALSE;
1902 }
1903 hash_remove(&func_hashtab, hi);
1904 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001905 return TRUE;
1906 }
1907 return FALSE;
1908}
1909
1910 static void
1911func_clear_items(ufunc_T *fp)
1912{
1913 ga_clear_strings(&(fp->uf_args));
1914 ga_clear_strings(&(fp->uf_def_args));
1915 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001916 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001917 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001918 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001919 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001920 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001921
1922 // Increment the refcount of this function to avoid it being freed
1923 // recursively when the partial is freed.
1924 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001925 partial_unref(fp->uf_partial);
1926 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001927 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001928
1929#ifdef FEAT_LUA
1930 if (fp->uf_cb_free != NULL)
1931 {
1932 fp->uf_cb_free(fp->uf_cb_state);
1933 fp->uf_cb_free = NULL;
1934 }
1935
1936 fp->uf_cb_state = NULL;
1937 fp->uf_cb = NULL;
1938#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001939#ifdef FEAT_PROFILE
1940 VIM_CLEAR(fp->uf_tml_count);
1941 VIM_CLEAR(fp->uf_tml_total);
1942 VIM_CLEAR(fp->uf_tml_self);
1943#endif
1944}
1945
1946/*
1947 * Free all things that a function contains. Does not free the function
1948 * itself, use func_free() for that.
1949 * When "force" is TRUE we are exiting.
1950 */
1951 static void
1952func_clear(ufunc_T *fp, int force)
1953{
1954 if (fp->uf_cleared)
1955 return;
1956 fp->uf_cleared = TRUE;
1957
1958 // clear this function
1959 func_clear_items(fp);
1960 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001961 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001962}
1963
1964/*
1965 * Free a function and remove it from the list of functions. Does not free
1966 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001967 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001968 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001969 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001970 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001971func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001972{
1973 // Only remove it when not done already, otherwise we would remove a newer
1974 // version of the function with the same name.
1975 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1976 func_remove(fp);
1977
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001978 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001979 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001980 if (fp->uf_dfunc_idx > 0)
1981 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001982 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001983 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001984 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001985 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001986 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001987}
1988
1989/*
1990 * Free all things that a function contains and free the function itself.
1991 * When "force" is TRUE we are exiting.
1992 */
1993 static void
1994func_clear_free(ufunc_T *fp, int force)
1995{
1996 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001997 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1998 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001999 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002000 else
2001 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002002}
2003
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002004/*
2005 * Copy already defined function "lambda" to a new function with name "global".
2006 * This is for when a compiled function defines a global function.
2007 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002008 int
2009copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002010{
2011 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002012 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002013
2014 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002015 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002016 semsg(_(e_lambda_function_not_found_str), lambda);
2017 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002018 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002019
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002020 fp = find_func(global, TRUE, NULL);
2021 if (fp != NULL)
2022 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002023 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002024 semsg(_(e_funcexts), global);
2025 return FAIL;
2026 }
2027
2028 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2029 if (fp == NULL)
2030 return FAIL;
2031
2032 fp->uf_varargs = ufunc->uf_varargs;
2033 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2034 fp->uf_def_status = ufunc->uf_def_status;
2035 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2036 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2037 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2038 == FAIL
2039 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2040 goto failed;
2041
2042 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2043 : vim_strsave(ufunc->uf_name_exp);
2044 if (ufunc->uf_arg_types != NULL)
2045 {
2046 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2047 if (fp->uf_arg_types == NULL)
2048 goto failed;
2049 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2050 sizeof(type_T *) * fp->uf_args.ga_len);
2051 }
2052 if (ufunc->uf_def_arg_idx != NULL)
2053 {
2054 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
2055 if (fp->uf_def_arg_idx == NULL)
2056 goto failed;
2057 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
2058 sizeof(int) * fp->uf_def_args.ga_len + 1);
2059 }
2060 if (ufunc->uf_va_name != NULL)
2061 {
2062 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2063 if (fp->uf_va_name == NULL)
2064 goto failed;
2065 }
2066 fp->uf_ret_type = ufunc->uf_ret_type;
2067
2068 fp->uf_refcount = 1;
2069 STRCPY(fp->uf_name, global);
2070 hash_add(&func_hashtab, UF2HIKEY(fp));
2071
2072 // the referenced dfunc_T is now used one more time
2073 link_def_function(fp);
2074
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002075 // Create a partial to store the context of the function where it was
2076 // instantiated. Only needs to be done once. Do this on the original
2077 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002078 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2079 {
2080 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2081
2082 if (pt == NULL)
2083 goto failed;
2084 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002085 {
2086 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002087 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002088 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002089 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002090 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002091 }
2092
2093 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002094
2095failed:
2096 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002097 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002098}
2099
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002100static int funcdepth = 0;
2101
2102/*
2103 * Increment the function call depth count.
2104 * Return FAIL when going over 'maxfuncdepth'.
2105 * Otherwise return OK, must call funcdepth_decrement() later!
2106 */
2107 int
2108funcdepth_increment(void)
2109{
2110 if (funcdepth >= p_mfd)
2111 {
2112 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2113 return FAIL;
2114 }
2115 ++funcdepth;
2116 return OK;
2117}
2118
2119 void
2120funcdepth_decrement(void)
2121{
2122 --funcdepth;
2123}
2124
2125/*
2126 * Get the current function call depth.
2127 */
2128 int
2129funcdepth_get(void)
2130{
2131 return funcdepth;
2132}
2133
2134/*
2135 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002136 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002137 * times as funcdepth_increment().
2138 */
2139 void
2140funcdepth_restore(int depth)
2141{
2142 funcdepth = depth;
2143}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002144
2145/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002146 * Call a user function.
2147 */
2148 static void
2149call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002150 ufunc_T *fp, // pointer to function
2151 int argcount, // nr of args
2152 typval_T *argvars, // arguments
2153 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002154 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002155 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002157 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002158 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159 funccall_T *fc;
2160 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002161 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002162 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002163 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002164 int i;
2165 int ai;
2166 int islambda = FALSE;
2167 char_u numbuf[NUMBUFLEN];
2168 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002169#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002170 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002171#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002172 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002173
Bram Moolenaarb2049902021-01-24 12:53:53 +01002174#ifdef FEAT_PROFILE
2175 CLEAR_FIELD(profile_info);
2176#endif
2177
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002178 // If depth of calling is getting too high, don't execute the function.
2179 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002180 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002181 rettv->v_type = VAR_NUMBER;
2182 rettv->vval.v_number = -1;
2183 return;
2184 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002185
Bram Moolenaare38eab22019-12-05 21:50:01 +01002186 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002187
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002188 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002189 if (fc == NULL)
2190 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002191 fc->caller = current_funccal;
2192 current_funccal = fc;
2193 fc->func = fp;
2194 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002196 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002197 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2198 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002199 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002200 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002201 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002202
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002203 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002204 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002205#ifdef FEAT_PROFILE
2206 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2207#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002208 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002209#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002210 if (do_profiling == PROF_YES)
2211 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002212#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002213 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002214 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002215#ifdef FEAT_PROFILE
2216 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002217 || (caller != NULL && caller->uf_profiling)))
2218 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002219#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002220 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002221 free_funccal(fc);
2222 return;
2223 }
2224
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002225 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2226 islambda = TRUE;
2227
2228 /*
2229 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2230 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2231 * each argument variable and saves a lot of time.
2232 */
2233 /*
2234 * Init l: variables.
2235 */
2236 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2237 if (selfdict != NULL)
2238 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002239 // Set l:self to "selfdict". Use "name" to avoid a warning from
2240 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 v = &fc->fixvar[fixvar_idx++].var;
2242 name = v->di_key;
2243 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002244 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002245 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2246 v->di_tv.v_type = VAR_DICT;
2247 v->di_tv.v_lock = 0;
2248 v->di_tv.vval.v_dict = selfdict;
2249 ++selfdict->dv_refcount;
2250 }
2251
2252 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002253 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002254 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002255 * Set a:000 to a list with room for the "..." arguments.
2256 */
2257 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002258 if ((fp->uf_flags & FC_NOARGS) == 0)
2259 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002260 (varnumber_T)(argcount >= fp->uf_args.ga_len
2261 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002262 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002263 if ((fp->uf_flags & FC_NOARGS) == 0)
2264 {
2265 // Use "name" to avoid a warning from some compiler that checks the
2266 // destination size.
2267 v = &fc->fixvar[fixvar_idx++].var;
2268 name = v->di_key;
2269 STRCPY(name, "000");
2270 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2271 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2272 v->di_tv.v_type = VAR_LIST;
2273 v->di_tv.v_lock = VAR_FIXED;
2274 v->di_tv.vval.v_list = &fc->l_varlist;
2275 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002276 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2278 fc->l_varlist.lv_lock = VAR_FIXED;
2279
2280 /*
2281 * Set a:firstline to "firstline" and a:lastline to "lastline".
2282 * Set a:name to named arguments.
2283 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002284 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002286 if ((fp->uf_flags & FC_NOARGS) == 0)
2287 {
2288 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002289 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002290 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002291 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002292 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002293 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002294 {
2295 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002296 typval_T def_rettv;
2297 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298
2299 ai = i - fp->uf_args.ga_len;
2300 if (ai < 0)
2301 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002302 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002303 name = FUNCARG(fp, i);
2304 if (islambda)
2305 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002306
2307 // evaluate named argument default expression
2308 isdefault = ai + fp->uf_def_args.ga_len >= 0
2309 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2310 && argvars[i].vval.v_number == VVAL_NONE));
2311 if (isdefault)
2312 {
2313 char_u *default_expr = NULL;
2314 def_rettv.v_type = VAR_NUMBER;
2315 def_rettv.vval.v_number = -1;
2316
2317 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2318 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002319 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002320 {
2321 default_arg_err = 1;
2322 break;
2323 }
2324 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002325 }
2326 else
2327 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002328 if ((fp->uf_flags & FC_NOARGS) != 0)
2329 // Bail out if no a: arguments used (in lambda).
2330 break;
2331
Bram Moolenaare38eab22019-12-05 21:50:01 +01002332 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333 sprintf((char *)numbuf, "%d", ai + 1);
2334 name = numbuf;
2335 }
2336 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2337 {
2338 v = &fc->fixvar[fixvar_idx++].var;
2339 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002340 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341 }
2342 else
2343 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002344 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002345 if (v == NULL)
2346 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002347 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002350 // Note: the values are copied directly to avoid alloc/free.
2351 // "argvars" must have VAR_FIXED for v_lock.
2352 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 v->di_tv.v_lock = VAR_FIXED;
2354
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355 if (addlocal)
2356 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002357 // Named arguments should be accessed without the "a:" prefix in
2358 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002359 copy_tv(&v->di_tv, &v->di_tv);
2360 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002362 else
2363 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002364
2365 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2366 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002367 listitem_T *li = &fc->l_listitems[ai];
2368
2369 li->li_tv = argvars[i];
2370 li->li_tv.v_lock = VAR_FIXED;
2371 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 }
2373 }
2374
Bram Moolenaare38eab22019-12-05 21:50:01 +01002375 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002377
2378 if (fp->uf_flags & FC_SANDBOX)
2379 {
2380 using_sandbox = TRUE;
2381 ++sandbox;
2382 }
2383
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002384 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002385 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002386 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002387 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002388 ++no_wait_return;
2389 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002391 smsg(_("calling %s"), SOURCING_NAME);
2392 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002394 char_u buf[MSG_BUF_LEN];
2395 char_u numbuf2[NUMBUFLEN];
2396 char_u *tofree;
2397 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002399 msg_puts("(");
2400 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002402 if (i > 0)
2403 msg_puts(", ");
2404 if (argvars[i].v_type == VAR_NUMBER)
2405 msg_outnum((long)argvars[i].vval.v_number);
2406 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002408 // Do not want errors such as E724 here.
2409 ++emsg_off;
2410 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2411 --emsg_off;
2412 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002413 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002414 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002415 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002416 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2417 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002419 msg_puts((char *)s);
2420 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421 }
2422 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002424 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002426 msg_puts("\n"); // don't overwrite this either
2427
2428 verbose_leave_scroll();
2429 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 }
2431#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002432 if (do_profiling == PROF_YES)
2433 profile_may_start_func(&profile_info, fp,
2434 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002435#endif
2436
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002437 save_current_sctx = current_sctx;
2438 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439 save_did_emsg = did_emsg;
2440 did_emsg = FALSE;
2441
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002442 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2443 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002444 else if (islambda)
2445 {
2446 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2447
2448 // A Lambda always has the command "return {expr}". It is much faster
2449 // to evaluate {expr} directly.
2450 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002451 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002452 --ex_nesting_level;
2453 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002454 else
2455 // call do_cmdline() to execute the lines
2456 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2458
2459 --RedrawingDisabled;
2460
Bram Moolenaare38eab22019-12-05 21:50:01 +01002461 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002462 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2463 {
2464 clear_tv(rettv);
2465 rettv->v_type = VAR_NUMBER;
2466 rettv->vval.v_number = -1;
2467 }
2468
2469#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002470 if (do_profiling == PROF_YES)
2471 {
2472 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2473
2474 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2475 profile_may_end_func(&profile_info, fp, caller);
2476 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002477#endif
2478
Bram Moolenaare38eab22019-12-05 21:50:01 +01002479 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 if (p_verbose >= 12)
2481 {
2482 ++no_wait_return;
2483 verbose_enter_scroll();
2484
2485 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002486 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002488 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 (long)fc->rettv->vval.v_number);
2490 else
2491 {
2492 char_u buf[MSG_BUF_LEN];
2493 char_u numbuf2[NUMBUFLEN];
2494 char_u *tofree;
2495 char_u *s;
2496
Bram Moolenaare38eab22019-12-05 21:50:01 +01002497 // The value may be very long. Skip the middle part, so that we
2498 // have some idea how it starts and ends. smsg() would always
2499 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 ++emsg_off;
2501 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2502 --emsg_off;
2503 if (s != NULL)
2504 {
2505 if (vim_strsize(s) > MSG_BUF_CLEN)
2506 {
2507 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2508 s = buf;
2509 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002510 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511 vim_free(tofree);
2512 }
2513 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002514 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515
2516 verbose_leave_scroll();
2517 --no_wait_return;
2518 }
2519
Bram Moolenaare31ee862020-01-07 20:59:34 +01002520 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002521 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002522 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523#ifdef FEAT_PROFILE
2524 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002525 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002527 if (using_sandbox)
2528 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002530 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 {
2532 ++no_wait_return;
2533 verbose_enter_scroll();
2534
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002535 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002536 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537
2538 verbose_leave_scroll();
2539 --no_wait_return;
2540 }
2541
2542 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002543 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002544 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002545}
2546
2547/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002548 * Check the argument count for user function "fp".
2549 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2550 */
2551 int
2552check_user_func_argcount(ufunc_T *fp, int argcount)
2553{
2554 int regular_args = fp->uf_args.ga_len;
2555
2556 if (argcount < regular_args - fp->uf_def_args.ga_len)
2557 return FCERR_TOOFEW;
2558 else if (!has_varargs(fp) && argcount > regular_args)
2559 return FCERR_TOOMANY;
2560 return FCERR_UNKNOWN;
2561}
2562
2563/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002564 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002565 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002566 int
2567call_user_func_check(
2568 ufunc_T *fp,
2569 int argcount,
2570 typval_T *argvars,
2571 typval_T *rettv,
2572 funcexe_T *funcexe,
2573 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002574{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002575 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002576
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002577 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2578 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002579 error = check_user_func_argcount(fp, argcount);
2580 if (error != FCERR_UNKNOWN)
2581 return error;
2582 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002583 error = FCERR_DICT;
2584 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002585 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002586 int did_save_redo = FALSE;
2587 save_redo_T save_redo;
2588
2589 /*
2590 * Call the user function.
2591 * Save and restore search patterns, script variables and
2592 * redo buffer.
2593 */
2594 save_search_patterns();
2595 if (!ins_compl_active())
2596 {
2597 saveRedobuff(&save_redo);
2598 did_save_redo = TRUE;
2599 }
2600 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002601 call_user_func(fp, argcount, argvars, rettv, funcexe,
2602 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002603 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2604 // Function was unreferenced while being used, free it now.
2605 func_clear_free(fp, FALSE);
2606 if (did_save_redo)
2607 restoreRedobuff(&save_redo);
2608 restore_search_patterns();
2609 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002610 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002611 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002612}
2613
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002614static funccal_entry_T *funccal_stack = NULL;
2615
2616/*
2617 * Save the current function call pointer, and set it to NULL.
2618 * Used when executing autocommands and for ":source".
2619 */
2620 void
2621save_funccal(funccal_entry_T *entry)
2622{
2623 entry->top_funccal = current_funccal;
2624 entry->next = funccal_stack;
2625 funccal_stack = entry;
2626 current_funccal = NULL;
2627}
2628
2629 void
2630restore_funccal(void)
2631{
2632 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002633 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002634 else
2635 {
2636 current_funccal = funccal_stack->top_funccal;
2637 funccal_stack = funccal_stack->next;
2638 }
2639}
2640
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002641 funccall_T *
2642get_current_funccal(void)
2643{
2644 return current_funccal;
2645}
2646
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002647/*
2648 * Mark all functions of script "sid" as deleted.
2649 */
2650 void
2651delete_script_functions(int sid)
2652{
2653 hashitem_T *hi;
2654 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002655 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002656 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002657 size_t len;
2658
2659 buf[0] = K_SPECIAL;
2660 buf[1] = KS_EXTRA;
2661 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002662 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002663 len = STRLEN(buf);
2664
Bram Moolenaarce658352020-07-31 23:47:12 +02002665 while (todo > 0)
2666 {
2667 todo = func_hashtab.ht_used;
2668 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2669 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002670 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002671 fp = HI2UF(hi);
2672 if (STRNCMP(fp->uf_name, buf, len) == 0)
2673 {
2674 int changed = func_hashtab.ht_changed;
2675
2676 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002677
2678 if (fp->uf_calls > 0)
2679 {
2680 // Function is executing, don't free it but do remove
2681 // it from the hashtable.
2682 if (func_remove(fp))
2683 fp->uf_refcount--;
2684 }
2685 else
2686 {
2687 func_clear(fp, TRUE);
2688 // When clearing a function another function can be
2689 // cleared as a side effect. When that happens start
2690 // over.
2691 if (changed != func_hashtab.ht_changed)
2692 break;
2693 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002694 }
2695 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002696 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002697 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002698}
2699
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700#if defined(EXITFREE) || defined(PROTO)
2701 void
2702free_all_functions(void)
2703{
2704 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002705 ufunc_T *fp;
2706 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002707 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002708 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709
Bram Moolenaare38eab22019-12-05 21:50:01 +01002710 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002711 while (current_funccal != NULL)
2712 {
2713 clear_tv(current_funccal->rettv);
2714 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002715 if (current_funccal == NULL && funccal_stack != NULL)
2716 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002717 }
2718
Bram Moolenaare38eab22019-12-05 21:50:01 +01002719 // First clear what the functions contain. Since this may lower the
2720 // reference count of a function, it may also free a function and change
2721 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002722 while (todo > 0)
2723 {
2724 todo = func_hashtab.ht_used;
2725 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2726 if (!HASHITEM_EMPTY(hi))
2727 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002728 // clear the def function index now
2729 fp = HI2UF(hi);
2730 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002731 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002732
Bram Moolenaare38eab22019-12-05 21:50:01 +01002733 // Only free functions that are not refcounted, those are
2734 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002735 if (func_name_refcount(fp->uf_name))
2736 ++skipped;
2737 else
2738 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002739 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002740 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002741 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002742 {
2743 skipped = 0;
2744 break;
2745 }
2746 }
2747 --todo;
2748 }
2749 }
2750
Bram Moolenaare38eab22019-12-05 21:50:01 +01002751 // Now actually free the functions. Need to start all over every time,
2752 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002753 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002754 while (func_hashtab.ht_used > skipped)
2755 {
2756 todo = func_hashtab.ht_used;
2757 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 if (!HASHITEM_EMPTY(hi))
2759 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002760 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002761 // Only free functions that are not refcounted, those are
2762 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002763 fp = HI2UF(hi);
2764 if (func_name_refcount(fp->uf_name))
2765 ++skipped;
2766 else
2767 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002768 if (func_free(fp, FALSE) == OK)
2769 {
2770 skipped = 0;
2771 break;
2772 }
2773 // did not actually free it
2774 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002775 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002777 }
2778 if (skipped == 0)
2779 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002780
2781 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782}
2783#endif
2784
2785/*
2786 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002787 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 * "len" is the length of "name", or -1 for NUL terminated.
2789 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002790 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791builtin_function(char_u *name, int len)
2792{
2793 char_u *p;
2794
Bram Moolenaara26b9702020-04-18 19:53:28 +02002795 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002796 return FALSE;
2797 p = vim_strchr(name, AUTOLOAD_CHAR);
2798 return p == NULL || (len > 0 && p > name + len);
2799}
2800
2801 int
2802func_call(
2803 char_u *name,
2804 typval_T *args,
2805 partial_T *partial,
2806 dict_T *selfdict,
2807 typval_T *rettv)
2808{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002809 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 listitem_T *item;
2811 typval_T argv[MAX_FUNC_ARGS + 1];
2812 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 int r = 0;
2814
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002815 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002816 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 {
2818 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2819 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002820 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 break;
2822 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002823 // Make a copy of each argument. This is needed to be able to set
2824 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825 copy_tv(&item->li_tv, &argv[argc++]);
2826 }
2827
2828 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002829 {
2830 funcexe_T funcexe;
2831
Bram Moolenaara80faa82020-04-12 19:37:17 +02002832 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002833 funcexe.firstline = curwin->w_cursor.lnum;
2834 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002835 funcexe.evaluate = TRUE;
2836 funcexe.partial = partial;
2837 funcexe.selfdict = selfdict;
2838 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2839 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840
Bram Moolenaare38eab22019-12-05 21:50:01 +01002841 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 while (argc > 0)
2843 clear_tv(&argv[--argc]);
2844
2845 return r;
2846}
2847
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002848static int callback_depth = 0;
2849
2850 int
2851get_callback_depth(void)
2852{
2853 return callback_depth;
2854}
2855
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002857 * Invoke call_func() with a callback.
2858 */
2859 int
2860call_callback(
2861 callback_T *callback,
2862 int len, // length of "name" or -1 to use strlen()
2863 typval_T *rettv, // return value goes here
2864 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002865 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002866 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002867{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002868 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002869 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002870
Bram Moolenaara80faa82020-04-12 19:37:17 +02002871 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002872 funcexe.evaluate = TRUE;
2873 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002874 ++callback_depth;
2875 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2876 --callback_depth;
2877 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002878}
2879
2880/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 * Give an error message for the result of a function.
2882 * Nothing if "error" is FCERR_NONE.
2883 */
2884 void
2885user_func_error(int error, char_u *name)
2886{
2887 switch (error)
2888 {
2889 case FCERR_UNKNOWN:
2890 emsg_funcname(e_unknownfunc, name);
2891 break;
2892 case FCERR_NOTMETHOD:
2893 emsg_funcname(
2894 N_("E276: Cannot use function as a method: %s"), name);
2895 break;
2896 case FCERR_DELETED:
2897 emsg_funcname(N_(e_func_deleted), name);
2898 break;
2899 case FCERR_TOOMANY:
2900 emsg_funcname((char *)e_toomanyarg, name);
2901 break;
2902 case FCERR_TOOFEW:
2903 emsg_funcname((char *)e_toofewarg, name);
2904 break;
2905 case FCERR_SCRIPT:
2906 emsg_funcname(
2907 N_("E120: Using <SID> not in a script context: %s"), name);
2908 break;
2909 case FCERR_DICT:
2910 emsg_funcname(
2911 N_("E725: Calling dict function without Dictionary: %s"),
2912 name);
2913 break;
2914 }
2915}
2916
2917/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002919 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920 * Return FAIL when the function can't be called, OK otherwise.
2921 * Also returns OK when an error was encountered while executing the function.
2922 */
2923 int
2924call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002925 char_u *funcname, // name of the function
2926 int len, // length of "name" or -1 to use strlen()
2927 typval_T *rettv, // return value goes here
2928 int argcount_in, // number of "argvars"
2929 typval_T *argvars_in, // vars for arguments, must have "argcount"
2930 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002931 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932{
2933 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002934 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002935 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002936 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002937 char_u fname_buf[FLEN_FIXED + 1];
2938 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002939 char_u *fname = NULL;
2940 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941 int argcount = argcount_in;
2942 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002943 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002944 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2945 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002947 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002948 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002950 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2951 // even when call_func() returns FAIL.
2952 rettv->v_type = VAR_UNKNOWN;
2953
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002954 if (partial != NULL)
2955 fp = partial->pt_func;
2956 if (fp == NULL)
2957 {
2958 // Make a copy of the name, if it comes from a funcref variable it
2959 // could be changed or deleted in the called function.
2960 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2961 if (name == NULL)
2962 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002963
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002964 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2965 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002967 if (funcexe->doesrange != NULL)
2968 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969
2970 if (partial != NULL)
2971 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002972 // When the function has a partial with a dict and there is a dict
2973 // argument, use the dict argument. That is backwards compatible.
2974 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002975 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002976 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002977 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 {
2979 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002980 {
2981 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2982 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002983 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002984 goto theend;
2985 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002986 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002987 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988 for (i = 0; i < argcount_in; ++i)
2989 argv[i + argv_clear] = argvars_in[i];
2990 argvars = argv;
2991 argcount = partial->pt_argc + argcount_in;
2992 }
2993 }
2994
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002995 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2996 {
2997 // Check that the argument types are OK for the types of the funcref.
2998 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01002999 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003000 error = FCERR_OTHER;
3001 }
3002
Bram Moolenaaref140542019-12-31 21:27:13 +01003003 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004 {
3005 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003006 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007
Bram Moolenaar333894b2020-08-01 18:53:07 +02003008 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003009 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003010 {
3011 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003013 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003014
Bram Moolenaare38eab22019-12-05 21:50:01 +01003015 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003017 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003019 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 {
3021 /*
3022 * User defined function.
3023 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003024 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003025 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026
Bram Moolenaare38eab22019-12-05 21:50:01 +01003027 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028 if (fp == NULL
3029 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003030 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031 && !aborting())
3032 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003033 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003034 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003036 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003037 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3038 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003039 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003040 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003042 if (fp == NULL)
3043 {
3044 char_u *p = untrans_function_name(rfname);
3045
3046 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003047 // Don't do this if the name starts with "s:".
3048 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003049 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003050 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003052 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003053 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003054#ifdef FEAT_LUA
3055 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3056 {
3057 cfunc_T cb = fp->uf_cb;
3058
3059 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3060 }
3061#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003062 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003063 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003064 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003065 // postponed filling in the arguments, do it now
3066 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003067 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003068
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003069 if (funcexe->basetv != NULL)
3070 {
3071 // Method call: base->Method()
3072 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3073 argv[0] = *funcexe->basetv;
3074 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003075 argvars = argv;
3076 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003077 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003078
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003079 error = call_user_func_check(fp, argcount, argvars, rettv,
3080 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003081 }
3082 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003083 else if (funcexe->basetv != NULL)
3084 {
3085 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003086 * expr->method(): Find the method name in the table, call its
3087 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003088 */
3089 error = call_internal_method(fname, argcount, argvars, rettv,
3090 funcexe->basetv);
3091 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003092 else
3093 {
3094 /*
3095 * Find the function name in the table, call its implementation.
3096 */
3097 error = call_internal_func(fname, argcount, argvars, rettv);
3098 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003099
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003100 /*
3101 * The function call (or "FuncUndefined" autocommand sequence) might
3102 * have been aborted by an error, an interrupt, or an explicitly thrown
3103 * exception that has not been caught so far. This situation can be
3104 * tested for by calling aborting(). For an error in an internal
3105 * function or for the "E132" error in call_user_func(), however, the
3106 * throw point at which the "force_abort" flag (temporarily reset by
3107 * emsg()) is normally updated has not been reached yet. We need to
3108 * update that flag first to make aborting() reliable.
3109 */
3110 update_force_abort();
3111 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003112 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 ret = OK;
3114
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003115theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 /*
3117 * Report an error unless the argument evaluation or function call has been
3118 * cancelled due to an aborting error, an interrupt, or an exception.
3119 */
3120 if (!aborting())
3121 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003122 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 }
3124
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003125 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003127 clear_tv(&argv[--argv_clear + argv_base]);
3128
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 vim_free(tofree);
3130 vim_free(name);
3131
3132 return ret;
3133}
3134
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003135 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003136printable_func_name(ufunc_T *fp)
3137{
3138 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3139}
3140
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003142 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 */
3144 static void
3145list_func_head(ufunc_T *fp, int indent)
3146{
3147 int j;
3148
3149 msg_start();
3150 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003151 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003152 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003153 msg_puts("def ");
3154 else
3155 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003156 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157 msg_putchar('(');
3158 for (j = 0; j < fp->uf_args.ga_len; ++j)
3159 {
3160 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003161 msg_puts(", ");
3162 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003163 if (fp->uf_arg_types != NULL)
3164 {
3165 char *tofree;
3166
3167 msg_puts(": ");
3168 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3169 vim_free(tofree);
3170 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003171 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3172 {
3173 msg_puts(" = ");
3174 msg_puts(((char **)(fp->uf_def_args.ga_data))
3175 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3176 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 }
3178 if (fp->uf_varargs)
3179 {
3180 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003181 msg_puts(", ");
3182 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003183 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003184 if (fp->uf_va_name != NULL)
3185 {
3186 if (j)
3187 msg_puts(", ");
3188 msg_puts("...");
3189 msg_puts((char *)fp->uf_va_name);
3190 if (fp->uf_va_type)
3191 {
3192 char *tofree;
3193
3194 msg_puts(": ");
3195 msg_puts(type_name(fp->uf_va_type, &tofree));
3196 vim_free(tofree);
3197 }
3198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003199 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003200
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003201 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003202 {
3203 if (fp->uf_ret_type != &t_void)
3204 {
3205 char *tofree;
3206
3207 msg_puts(": ");
3208 msg_puts(type_name(fp->uf_ret_type, &tofree));
3209 vim_free(tofree);
3210 }
3211 }
3212 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003213 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003215 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003217 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003218 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003219 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003220 msg_clr_eos();
3221 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003222 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223}
3224
3225/*
3226 * Get a function name, translating "<SID>" and "<SNR>".
3227 * Also handles a Funcref in a List or Dictionary.
3228 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003229 * Set "*is_global" to TRUE when the function must be global, unless
3230 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 * flags:
3232 * TFN_INT: internal function name OK
3233 * TFN_QUIET: be quiet
3234 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003235 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 * Advances "pp" to just after the function name (if no error).
3237 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003238 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239trans_function_name(
3240 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003241 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003242 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003244 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003245 partial_T **partial, // return: partial of a FuncRef
3246 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247{
3248 char_u *name = NULL;
3249 char_u *start;
3250 char_u *end;
3251 int lead;
3252 char_u sid_buf[20];
3253 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003254 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003255 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003256 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003257 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258
3259 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003260 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 start = *pp;
3262
Bram Moolenaare38eab22019-12-05 21:50:01 +01003263 // Check for hard coded <SNR>: already translated function ID (from a user
3264 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3266 && (*pp)[2] == (int)KE_SNR)
3267 {
3268 *pp += 3;
3269 len = get_id_len(pp) + 3;
3270 return vim_strnsave(start, len);
3271 }
3272
Bram Moolenaare38eab22019-12-05 21:50:01 +01003273 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3274 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 lead = eval_fname_script(start);
3276 if (lead > 2)
3277 start += lead;
3278
Bram Moolenaare38eab22019-12-05 21:50:01 +01003279 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003280 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 lead > 2 ? 0 : FNE_CHECK_START);
3282 if (end == start)
3283 {
3284 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003285 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 goto theend;
3287 }
3288 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3289 {
3290 /*
3291 * Report an invalid expression in braces, unless the expression
3292 * evaluation has been cancelled due to an aborting error, an
3293 * interrupt, or an exception.
3294 */
3295 if (!aborting())
3296 {
3297 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003298 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299 }
3300 else
3301 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3302 goto theend;
3303 }
3304
3305 if (lv.ll_tv != NULL)
3306 {
3307 if (fdp != NULL)
3308 {
3309 fdp->fd_dict = lv.ll_dict;
3310 fdp->fd_newkey = lv.ll_newkey;
3311 lv.ll_newkey = NULL;
3312 fdp->fd_di = lv.ll_di;
3313 }
3314 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3315 {
3316 name = vim_strsave(lv.ll_tv->vval.v_string);
3317 *pp = end;
3318 }
3319 else if (lv.ll_tv->v_type == VAR_PARTIAL
3320 && lv.ll_tv->vval.v_partial != NULL)
3321 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003322 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323 *pp = end;
3324 if (partial != NULL)
3325 *partial = lv.ll_tv->vval.v_partial;
3326 }
3327 else
3328 {
3329 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3330 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003331 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 else
3333 *pp = end;
3334 name = NULL;
3335 }
3336 goto theend;
3337 }
3338
3339 if (lv.ll_name == NULL)
3340 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003341 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342 *pp = end;
3343 goto theend;
3344 }
3345
Bram Moolenaare38eab22019-12-05 21:50:01 +01003346 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 if (lv.ll_exp_name != NULL)
3348 {
3349 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003350 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 flags & TFN_NO_AUTOLOAD);
3352 if (name == lv.ll_exp_name)
3353 name = NULL;
3354 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003355 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003356 {
3357 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003358 name = deref_func_name(*pp, &len, partial, type,
3359 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360 if (name == *pp)
3361 name = NULL;
3362 }
3363 if (name != NULL)
3364 {
3365 name = vim_strsave(name);
3366 *pp = end;
3367 if (STRNCMP(name, "<SNR>", 5) == 0)
3368 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003369 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 name[0] = K_SPECIAL;
3371 name[1] = KS_EXTRA;
3372 name[2] = (int)KE_SNR;
3373 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3374 }
3375 goto theend;
3376 }
3377
3378 if (lv.ll_exp_name != NULL)
3379 {
3380 len = (int)STRLEN(lv.ll_exp_name);
3381 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3382 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3383 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003384 // When there was "s:" already or the name expanded to get a
3385 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 lv.ll_name += 2;
3387 len -= 2;
3388 lead = 2;
3389 }
3390 }
3391 else
3392 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003393 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003394 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003395 {
3396 if (is_global != NULL && lv.ll_name[0] == 'g')
3397 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003399 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400 len = (int)(end - lv.ll_name);
3401 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003402 if (len <= 0)
3403 {
3404 if (!skip)
3405 emsg(_(e_function_name));
3406 goto theend;
3407 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003409 // In Vim9 script a user function is script-local by default, unless it
3410 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003411 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003412 if (vim9script)
3413 {
3414 char_u *p;
3415
3416 // SomeScript#func() is a global function.
3417 for (p = start; *p != NUL && *p != '('; ++p)
3418 if (*p == AUTOLOAD_CHAR)
3419 vim9script = FALSE;
3420 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003421
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 /*
3423 * Copy the function name to allocated memory.
3424 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3425 * Accept <SNR>123_name() outside a script.
3426 */
3427 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003428 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003429 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003431 if (!vim9script)
3432 lead = 3;
3433 if (vim9script || (lv.ll_exp_name != NULL
3434 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 || eval_fname_sid(*pp))
3436 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003437 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003438 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003440 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003441 goto theend;
3442 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003443 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003444 if (vim9script)
3445 extra = 3 + (int)STRLEN(sid_buf);
3446 else
3447 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 }
3449 }
3450 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3451 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003452 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453 start);
3454 goto theend;
3455 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003456 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 {
3458 char_u *cp = vim_strchr(lv.ll_name, ':');
3459
3460 if (cp != NULL && cp < end)
3461 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003462 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 goto theend;
3464 }
3465 }
3466
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003467 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003468 if (name != NULL)
3469 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003470 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 {
3472 name[0] = K_SPECIAL;
3473 name[1] = KS_EXTRA;
3474 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003475 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476 STRCPY(name + 3, sid_buf);
3477 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003478 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3479 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480 }
3481 *pp = end;
3482
3483theend:
3484 clear_lval(&lv);
3485 return name;
3486}
3487
3488/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003489 * Assuming "name" is the result of trans_function_name() and it was prefixed
3490 * to use the script-local name, return the unmodified name (points into
3491 * "name"). Otherwise return NULL.
3492 * This can be used to first search for a script-local function and fall back
3493 * to the global function if not found.
3494 */
3495 char_u *
3496untrans_function_name(char_u *name)
3497{
3498 char_u *p;
3499
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003500 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003501 {
3502 p = vim_strchr(name, '_');
3503 if (p != NULL)
3504 return p + 1;
3505 }
3506 return NULL;
3507}
3508
3509/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003510 * List functions. When "regmatch" is NULL all of then.
3511 * Otherwise functions matching "regmatch".
3512 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003513 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003514list_functions(regmatch_T *regmatch)
3515{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003516 int changed = func_hashtab.ht_changed;
3517 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003518 hashitem_T *hi;
3519
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003520 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003521 {
3522 if (!HASHITEM_EMPTY(hi))
3523 {
3524 ufunc_T *fp = HI2UF(hi);
3525
3526 --todo;
3527 if ((fp->uf_flags & FC_DEAD) == 0
3528 && (regmatch == NULL
3529 ? !message_filtered(fp->uf_name)
3530 && !func_name_refcount(fp->uf_name)
3531 : !isdigit(*fp->uf_name)
3532 && vim_regexec(regmatch, fp->uf_name, 0)))
3533 {
3534 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003535 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003536 {
3537 emsg(_("E454: function list was modified"));
3538 return;
3539 }
3540 }
3541 }
3542 }
3543}
3544
3545/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003546 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003547 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3548 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003549 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003551 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003552define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003554 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 int j;
3556 int c;
3557 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003558 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003559 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 char_u *p;
3561 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003562 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 char_u *line_arg = NULL;
3564 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003565 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003566 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 garray_T newlines;
3568 int varargs = FALSE;
3569 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003570 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003571 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003572 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 dictitem_T *v;
3574 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003575 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003578 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003579 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003580 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581
3582 /*
3583 * ":function" without argument: list functions.
3584 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003585 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 {
3587 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003588 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003590 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 }
3592
3593 /*
3594 * ":function /pat": list functions matching pattern.
3595 */
3596 if (*eap->arg == '/')
3597 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003598 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 if (!eap->skip)
3600 {
3601 regmatch_T regmatch;
3602
3603 c = *p;
3604 *p = NUL;
3605 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3606 *p = c;
3607 if (regmatch.regprog != NULL)
3608 {
3609 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003610 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 vim_regfree(regmatch.regprog);
3612 }
3613 }
3614 if (*p == '/')
3615 ++p;
3616 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003617 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 }
3619
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003620 ga_init(&newargs);
3621 ga_init(&argtypes);
3622 ga_init(&default_args);
3623
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 /*
3625 * Get the function name. There are these situations:
3626 * func normal function name
3627 * "name" == func, "fudi.fd_dict" == NULL
3628 * dict.func new dictionary entry
3629 * "name" == NULL, "fudi.fd_dict" set,
3630 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3631 * dict.func existing dict entry with a Funcref
3632 * "name" == func, "fudi.fd_dict" set,
3633 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3634 * dict.func existing dict entry that's not a Funcref
3635 * "name" == NULL, "fudi.fd_dict" set,
3636 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3637 * s:func script-local function name
3638 * g:func global function name, same as "func"
3639 */
3640 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003641 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003643 // nested function, argument is (args).
3644 paren = TRUE;
3645 CLEAR_FIELD(fudi);
3646 }
3647 else
3648 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003649 if (STRNCMP(p, "<lambda>", 8) == 0)
3650 {
3651 p += 8;
3652 (void)getdigits(&p);
3653 name = vim_strnsave(eap->arg, p - eap->arg);
3654 CLEAR_FIELD(fudi);
3655 }
3656 else
3657 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003658 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003659 paren = (vim_strchr(p, '(') != NULL);
3660 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003662 /*
3663 * Return on an invalid expression in braces, unless the expression
3664 * evaluation has been cancelled due to an aborting error, an
3665 * interrupt, or an exception.
3666 */
3667 if (!aborting())
3668 {
3669 if (!eap->skip && fudi.fd_newkey != NULL)
3670 semsg(_(e_dictkey), fudi.fd_newkey);
3671 vim_free(fudi.fd_newkey);
3672 return NULL;
3673 }
3674 else
3675 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 }
3678
Bram Moolenaare38eab22019-12-05 21:50:01 +01003679 // An error in a function call during evaluation of an expression in magic
3680 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 saved_did_emsg = did_emsg;
3682 did_emsg = FALSE;
3683
3684 /*
3685 * ":function func" with only function name: list function.
3686 */
3687 if (!paren)
3688 {
3689 if (!ends_excmd(*skipwhite(p)))
3690 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003691 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 goto ret_free;
3693 }
3694 eap->nextcmd = check_nextcmd(p);
3695 if (eap->nextcmd != NULL)
3696 *p = NUL;
3697 if (!eap->skip && !got_int)
3698 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003699 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003700 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3701 {
3702 char_u *up = untrans_function_name(name);
3703
3704 // With Vim9 script the name was made script-local, if not
3705 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003706 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003707 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003708 }
3709
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 if (fp != NULL)
3711 {
3712 list_func_head(fp, TRUE);
3713 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3714 {
3715 if (FUNCLINE(fp, j) == NULL)
3716 continue;
3717 msg_putchar('\n');
3718 msg_outnum((long)(j + 1));
3719 if (j < 9)
3720 msg_putchar(' ');
3721 if (j < 99)
3722 msg_putchar(' ');
3723 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003724 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 ui_breakcheck();
3726 }
3727 if (!got_int)
3728 {
3729 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003730 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003731 msg_puts(" enddef");
3732 else
3733 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 }
3735 }
3736 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003737 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 }
3739 goto ret_free;
3740 }
3741
3742 /*
3743 * ":function name(arg1, arg2)" Define function.
3744 */
3745 p = skipwhite(p);
3746 if (*p != '(')
3747 {
3748 if (!eap->skip)
3749 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003750 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751 goto ret_free;
3752 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003753 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754 if (vim_strchr(p, '(') != NULL)
3755 p = vim_strchr(p, '(');
3756 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003758 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3759 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003760 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003761 goto ret_free;
3762 }
3763
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003764 // In Vim9 script only global functions can be redefined.
3765 if (vim9script && eap->forceit && !is_global)
3766 {
3767 emsg(_(e_nobang));
3768 goto ret_free;
3769 }
3770
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003771 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772
Bram Moolenaar04b12692020-05-04 23:24:44 +02003773 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003775 // Check the name of the function. Unless it's a dictionary function
3776 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 if (name != NULL)
3778 arg = name;
3779 else
3780 arg = fudi.fd_newkey;
3781 if (arg != NULL && (fudi.fd_di == NULL
3782 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3783 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3784 {
3785 if (*arg == K_SPECIAL)
3786 j = 3;
3787 else
3788 j = 0;
3789 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3790 : eval_isnamec(arg[j])))
3791 ++j;
3792 if (arg[j] != NUL)
3793 emsg_funcname((char *)e_invarg2, arg);
3794 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003795 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003797 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 }
3799
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003800 // This may get more lines and make the pointers into the first line
3801 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003802 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003803 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003804 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003805 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003806 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003808 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003810 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003812 // find the return type: :def Func(): type
3813 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003815 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003816 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003817 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003818 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003819 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003820 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003821 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003822 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003823 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003824 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003825 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003826 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003827 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003829 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003831 else
3832 // find extra arguments "range", "dict", "abort" and "closure"
3833 for (;;)
3834 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003835 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003836 p = skipwhite(p);
3837 if (STRNCMP(p, "range", 5) == 0)
3838 {
3839 flags |= FC_RANGE;
3840 p += 5;
3841 }
3842 else if (STRNCMP(p, "dict", 4) == 0)
3843 {
3844 flags |= FC_DICT;
3845 p += 4;
3846 }
3847 else if (STRNCMP(p, "abort", 5) == 0)
3848 {
3849 flags |= FC_ABORT;
3850 p += 5;
3851 }
3852 else if (STRNCMP(p, "closure", 7) == 0)
3853 {
3854 flags |= FC_CLOSURE;
3855 p += 7;
3856 if (current_funccal == NULL)
3857 {
3858 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3859 name == NULL ? (char_u *)"" : name);
3860 goto erret;
3861 }
3862 }
3863 else
3864 break;
3865 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866
Bram Moolenaare38eab22019-12-05 21:50:01 +01003867 // When there is a line break use what follows for the function body.
3868 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 if (*p == '\n')
3870 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003871 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003872 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3873 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003874 && !(VIM_ISWHITE(*whitep) && *p == '#'
3875 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003876 && !eap->skip
3877 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003878 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879
3880 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003881 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3882 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003883 */
3884 if (KeyTyped)
3885 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003886 // Check if the function already exists, don't let the user type the
3887 // whole function before telling him it doesn't work! For a script we
3888 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003889 if (!eap->skip && !eap->forceit)
3890 {
3891 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003892 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003893 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 emsg_funcname(e_funcexts, name);
3895 }
3896
3897 if (!eap->skip && did_emsg)
3898 goto erret;
3899
Bram Moolenaare38eab22019-12-05 21:50:01 +01003900 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901 cmdline_row = msg_row;
3902 }
3903
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003904 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003905 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003906
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003907 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003908 goto erret;
3909
3910 /*
3911 * If there are no errors, add the function
3912 */
3913 if (fudi.fd_dict == NULL)
3914 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003915 hashtab_T *ht;
3916
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003917 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3919 {
3920 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3921 name);
3922 goto erret;
3923 }
3924
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003925 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003926 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003928 char_u *uname = untrans_function_name(name);
3929
3930 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3931 }
3932
3933 if (fp != NULL || import != NULL)
3934 {
3935 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003936
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003937 // Function can be replaced with "function!" and when sourcing the
3938 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003939 // A name that is used by an import can not be overruled.
3940 if (import != NULL
3941 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003942 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003943 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003945 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003946 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003947 else
3948 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 goto erret;
3950 }
3951 if (fp->uf_calls > 0)
3952 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003953 emsg_funcname(
3954 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 name);
3956 goto erret;
3957 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003958 if (fp->uf_refcount > 1)
3959 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003960 // This function is referenced somewhere, don't redefine it but
3961 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003962 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003963 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003964 fp = NULL;
3965 overwrite = TRUE;
3966 }
3967 else
3968 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003969 char_u *exp_name = fp->uf_name_exp;
3970
3971 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003972 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003973 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003974 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003975 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003976 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003977#ifdef FEAT_PROFILE
3978 fp->uf_profiling = FALSE;
3979 fp->uf_prof_initialized = FALSE;
3980#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003981 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003982 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 }
3984 }
3985 else
3986 {
3987 char numbuf[20];
3988
3989 fp = NULL;
3990 if (fudi.fd_newkey == NULL && !eap->forceit)
3991 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003992 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 goto erret;
3994 }
3995 if (fudi.fd_di == NULL)
3996 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003997 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003998 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 goto erret;
4000 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004001 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004002 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004003 goto erret;
4004
Bram Moolenaare38eab22019-12-05 21:50:01 +01004005 // Give the function a sequential number. Can only be used with a
4006 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004007 vim_free(name);
4008 sprintf(numbuf, "%d", ++func_nr);
4009 name = vim_strsave((char_u *)numbuf);
4010 if (name == NULL)
4011 goto erret;
4012 }
4013
4014 if (fp == NULL)
4015 {
4016 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4017 {
4018 int slen, plen;
4019 char_u *scriptname;
4020
Bram Moolenaare38eab22019-12-05 21:50:01 +01004021 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004023 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024 {
4025 scriptname = autoload_name(name);
4026 if (scriptname != NULL)
4027 {
4028 p = vim_strchr(scriptname, '/');
4029 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004030 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004032 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 j = OK;
4034 vim_free(scriptname);
4035 }
4036 }
4037 if (j == FAIL)
4038 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004039 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 goto erret;
4041 }
4042 }
4043
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004044 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 if (fp == NULL)
4046 goto erret;
4047
4048 if (fudi.fd_dict != NULL)
4049 {
4050 if (fudi.fd_di == NULL)
4051 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004052 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4054 if (fudi.fd_di == NULL)
4055 {
4056 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004057 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 goto erret;
4059 }
4060 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4061 {
4062 vim_free(fudi.fd_di);
4063 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004064 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 goto erret;
4066 }
4067 }
4068 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004069 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 clear_tv(&fudi.fd_di->di_tv);
4071 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073
Bram Moolenaare38eab22019-12-05 21:50:01 +01004074 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 flags |= FC_DICT;
4076 }
4077
Bram Moolenaare38eab22019-12-05 21:50:01 +01004078 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004079 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004080 if (overwrite)
4081 {
4082 hi = hash_find(&func_hashtab, name);
4083 hi->hi_key = UF2HIKEY(fp);
4084 }
4085 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 {
4087 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004088 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089 goto erret;
4090 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004091 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 }
4093 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004094 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004095 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004096 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004097
4098 if (eap->cmdidx == CMD_def)
4099 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004100 int lnum_save = SOURCING_LNUM;
4101 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004102
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004103 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004104
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004105 // error messages are for the first function line
4106 SOURCING_LNUM = sourcing_lnum_top;
4107
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004108 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004109 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004110 int count = cstack->cs_idx + 1;
4111 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004112
4113 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004114 // a block that is visible now but not when the function is called
4115 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004116 fp->uf_block_ids = ALLOC_MULT(int, count);
4117 if (fp->uf_block_ids != NULL)
4118 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004119 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004120 sizeof(int) * count);
4121 fp->uf_block_depth = count;
4122 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004123
4124 // Set flag in each block to indicate a function was defined. This
4125 // is used to keep the variable when leaving the block, see
4126 // hide_script_var().
4127 for (i = 0; i <= cstack->cs_idx; ++i)
4128 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004129 }
4130
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004131 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004132 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004133 SOURCING_LNUM = lnum_save;
4134 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004136 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004137
4138 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004139 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004140 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004141 SOURCING_LNUM = lnum_save;
4142 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004143 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004144 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004145 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004146 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004147 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004148
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004149 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004150 if ((flags & FC_CLOSURE) != 0)
4151 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004152 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004153 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004154 }
4155 else
4156 fp->uf_scoped = NULL;
4157
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 if (prof_def_func())
4160 func_do_profile(fp);
4161#endif
4162 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004163 if (sandbox)
4164 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004165 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004166 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 fp->uf_flags = flags;
4168 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004169 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004170 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004171 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004172 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004173 if (is_export)
4174 {
4175 fp->uf_flags |= FC_EXPORT;
4176 // let ex_export() know the export worked.
4177 is_export = FALSE;
4178 }
4179
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004180 if (eap->cmdidx == CMD_def)
4181 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004182 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4183 // :func does not use Vim9 script syntax, even in a Vim9 script file
4184 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004185
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 goto ret_free;
4187
4188erret:
4189 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004190 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004191 if (fp != NULL)
4192 {
4193 ga_init(&fp->uf_args);
4194 ga_init(&fp->uf_def_args);
4195 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196errret_2:
4197 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004198 if (fp != NULL)
4199 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004200ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004201 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004202 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004204 if (name != name_arg)
4205 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004206 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004207 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004208
4209 return fp;
4210}
4211
4212/*
4213 * ":function"
4214 */
4215 void
4216ex_function(exarg_T *eap)
4217{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004218 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004219}
4220
4221/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004222 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004223 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004224 */
4225 void
4226ex_defcompile(exarg_T *eap UNUSED)
4227{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004228 long todo = (long)func_hashtab.ht_used;
4229 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004230 hashitem_T *hi;
4231 ufunc_T *ufunc;
4232
4233 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4234 {
4235 if (!HASHITEM_EMPTY(hi))
4236 {
4237 --todo;
4238 ufunc = HI2UF(hi);
4239 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004240 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4241 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004242 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004243 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004244
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004245 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004246 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004247 // a function has been added or removed, need to start over
4248 todo = (long)func_hashtab.ht_used;
4249 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004250 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004251 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004252 }
4253 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004254 }
4255 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256}
4257
4258/*
4259 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4260 * Return 2 if "p" starts with "s:".
4261 * Return 0 otherwise.
4262 */
4263 int
4264eval_fname_script(char_u *p)
4265{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004266 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4267 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4269 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4270 return 5;
4271 if (p[0] == 's' && p[1] == ':')
4272 return 2;
4273 return 0;
4274}
4275
4276 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004277translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278{
4279 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004280 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004281 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004282}
4283
4284/*
4285 * Return TRUE when "ufunc" has old-style "..." varargs
4286 * or named varargs "...name: type".
4287 */
4288 int
4289has_varargs(ufunc_T *ufunc)
4290{
4291 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292}
4293
4294/*
4295 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004296 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 */
4298 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004299function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300{
4301 char_u *nm = name;
4302 char_u *p;
4303 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004304 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004305 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004307 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4308 if (no_deref)
4309 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004310 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311 nm = skipwhite(nm);
4312
Bram Moolenaare38eab22019-12-05 21:50:01 +01004313 // Only accept "funcname", "funcname ", "funcname (..." and
4314 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004316 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 vim_free(p);
4318 return n;
4319}
4320
Bram Moolenaar113e1072019-01-20 15:30:40 +01004321#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 char_u *
4323get_expanded_name(char_u *name, int check)
4324{
4325 char_u *nm = name;
4326 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004327 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004329 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004330 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004332 if (p != NULL && *nm == NUL
4333 && (!check || translated_function_exists(p, is_global)))
4334 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335
4336 vim_free(p);
4337 return NULL;
4338}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004339#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341/*
4342 * Function given to ExpandGeneric() to obtain the list of user defined
4343 * function names.
4344 */
4345 char_u *
4346get_user_func_name(expand_T *xp, int idx)
4347{
4348 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004349 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004350 static hashitem_T *hi;
4351 ufunc_T *fp;
4352
4353 if (idx == 0)
4354 {
4355 done = 0;
4356 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004357 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004359 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004360 {
4361 if (done++ > 0)
4362 ++hi;
4363 while (HASHITEM_EMPTY(hi))
4364 ++hi;
4365 fp = HI2UF(hi);
4366
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004367 // don't show dead, dict and lambda functions
4368 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004369 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004370 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004371
4372 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004373 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374
4375 cat_func_name(IObuff, fp);
4376 if (xp->xp_context != EXPAND_USER_FUNC)
4377 {
4378 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004379 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004380 STRCAT(IObuff, ")");
4381 }
4382 return IObuff;
4383 }
4384 return NULL;
4385}
4386
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387/*
4388 * ":delfunction {name}"
4389 */
4390 void
4391ex_delfunction(exarg_T *eap)
4392{
4393 ufunc_T *fp = NULL;
4394 char_u *p;
4395 char_u *name;
4396 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004397 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398
4399 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004400 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4401 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 vim_free(fudi.fd_newkey);
4403 if (name == NULL)
4404 {
4405 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004406 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 return;
4408 }
4409 if (!ends_excmd(*skipwhite(p)))
4410 {
4411 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004412 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413 return;
4414 }
4415 eap->nextcmd = check_nextcmd(p);
4416 if (eap->nextcmd != NULL)
4417 *p = NUL;
4418
4419 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004420 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 vim_free(name);
4422
4423 if (!eap->skip)
4424 {
4425 if (fp == NULL)
4426 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004427 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004428 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 return;
4430 }
4431 if (fp->uf_calls > 0)
4432 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004433 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 return;
4435 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004436 if (fp->uf_flags & FC_VIM9)
4437 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004438 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004439 return;
4440 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004441
4442 if (fudi.fd_dict != NULL)
4443 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004444 // Delete the dict item that refers to the function, it will
4445 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4447 }
4448 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004449 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004450 // A normal function (not a numbered function or lambda) has a
4451 // refcount of 1 for the entry in the hashtable. When deleting
4452 // it and the refcount is more than one, it should be kept.
4453 // A numbered function and lambda should be kept if the refcount is
4454 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004455 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004456 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004457 // Function is still referenced somewhere. Don't free it but
4458 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004459 if (func_remove(fp))
4460 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004461 }
4462 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004463 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004464 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 }
4466}
4467
4468/*
4469 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004470 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 */
4472 void
4473func_unref(char_u *name)
4474{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004475 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004477 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004479 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004480 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004483 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004484#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004485 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004487 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004488}
4489
4490/*
4491 * Unreference a Function: decrement the reference count and free it when it
4492 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004493 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004494 */
4495 void
4496func_ptr_unref(ufunc_T *fp)
4497{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004498 if (fp != NULL && (--fp->uf_refcount <= 0
4499 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4500 && fp->uf_partial->pt_refcount <= 1
4501 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004502 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004503 // Only delete it when it's not being used. Otherwise it's done
4504 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004505 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004506 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004507 }
4508}
4509
4510/*
4511 * Count a reference to a Function.
4512 */
4513 void
4514func_ref(char_u *name)
4515{
4516 ufunc_T *fp;
4517
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004518 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004520 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004521 if (fp != NULL)
4522 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004524 // Only give an error for a numbered function.
4525 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004526 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004527}
4528
4529/*
4530 * Count a reference to a Function.
4531 */
4532 void
4533func_ptr_ref(ufunc_T *fp)
4534{
4535 if (fp != NULL)
4536 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537}
4538
4539/*
4540 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4541 * referenced from anywhere that is in use.
4542 */
4543 static int
4544can_free_funccal(funccall_T *fc, int copyID)
4545{
4546 return (fc->l_varlist.lv_copyID != copyID
4547 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004548 && fc->l_avars.dv_copyID != copyID
4549 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550}
4551
4552/*
4553 * ":return [expr]"
4554 */
4555 void
4556ex_return(exarg_T *eap)
4557{
4558 char_u *arg = eap->arg;
4559 typval_T rettv;
4560 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004561 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562
4563 if (current_funccal == NULL)
4564 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004565 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004566 return;
4567 }
4568
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004569 CLEAR_FIELD(evalarg);
4570 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4571
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572 if (eap->skip)
4573 ++emsg_skip;
4574
4575 eap->nextcmd = NULL;
4576 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004577 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578 {
4579 if (!eap->skip)
4580 returning = do_return(eap, FALSE, TRUE, &rettv);
4581 else
4582 clear_tv(&rettv);
4583 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004584 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 else if (!eap->skip)
4586 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004587 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004588 update_force_abort();
4589
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 /*
4591 * Return unless the expression evaluation has been cancelled due to an
4592 * aborting error, an interrupt, or an exception.
4593 */
4594 if (!aborting())
4595 returning = do_return(eap, FALSE, TRUE, NULL);
4596 }
4597
Bram Moolenaare38eab22019-12-05 21:50:01 +01004598 // When skipping or the return gets pending, advance to the next command
4599 // in this line (!returning). Otherwise, ignore the rest of the line.
4600 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004601 if (returning)
4602 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004603 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 eap->nextcmd = check_nextcmd(arg);
4605
4606 if (eap->skip)
4607 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004608 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609}
4610
4611/*
4612 * ":1,25call func(arg1, arg2)" function call.
4613 */
4614 void
4615ex_call(exarg_T *eap)
4616{
4617 char_u *arg = eap->arg;
4618 char_u *startarg;
4619 char_u *name;
4620 char_u *tofree;
4621 int len;
4622 typval_T rettv;
4623 linenr_T lnum;
4624 int doesrange;
4625 int failed = FALSE;
4626 funcdict_T fudi;
4627 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004628 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004629 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630
Bram Moolenaare6b53242020-07-01 17:28:33 +02004631 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632 if (eap->skip)
4633 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004634 // trans_function_name() doesn't work well when skipping, use eval0()
4635 // instead to skip to any following command, e.g. for:
4636 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004638 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639 clear_tv(&rettv);
4640 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004641 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 return;
4643 }
4644
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004645 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4646 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004647 if (fudi.fd_newkey != NULL)
4648 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004649 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004650 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651 vim_free(fudi.fd_newkey);
4652 }
4653 if (tofree == NULL)
4654 return;
4655
Bram Moolenaare38eab22019-12-05 21:50:01 +01004656 // Increase refcount on dictionary, it could get deleted when evaluating
4657 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658 if (fudi.fd_dict != NULL)
4659 ++fudi.fd_dict->dv_refcount;
4660
Bram Moolenaare38eab22019-12-05 21:50:01 +01004661 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4662 // contents. For VAR_PARTIAL get its partial, unless we already have one
4663 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004665 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4666 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667
Bram Moolenaare38eab22019-12-05 21:50:01 +01004668 // Skip white space to allow ":call func ()". Not good, but required for
4669 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004671 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672
4673 if (*startarg != '(')
4674 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004675 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676 goto end;
4677 }
4678
4679 /*
4680 * When skipping, evaluate the function once, to find the end of the
4681 * arguments.
4682 * When the function takes a range, this is discovered after the first
4683 * call, and the loop is broken.
4684 */
4685 if (eap->skip)
4686 {
4687 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004688 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 }
4690 else
4691 lnum = eap->line1;
4692 for ( ; lnum <= eap->line2; ++lnum)
4693 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004694 funcexe_T funcexe;
4695
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696 if (!eap->skip && eap->addr_count > 0)
4697 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004698 if (lnum > curbuf->b_ml.ml_line_count)
4699 {
4700 // If the function deleted lines or switched to another buffer
4701 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004702 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004703 break;
4704 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004705 curwin->w_cursor.lnum = lnum;
4706 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 }
4709 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004710
Bram Moolenaara80faa82020-04-12 19:37:17 +02004711 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004712 funcexe.firstline = eap->line1;
4713 funcexe.lastline = eap->line2;
4714 funcexe.doesrange = &doesrange;
4715 funcexe.evaluate = !eap->skip;
4716 funcexe.partial = partial;
4717 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004718 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004719 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004720 {
4721 failed = TRUE;
4722 break;
4723 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004724 if (has_watchexpr())
4725 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004727 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004728 if (handle_subscript(&arg, &rettv,
4729 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730 {
4731 failed = TRUE;
4732 break;
4733 }
4734
4735 clear_tv(&rettv);
4736 if (doesrange || eap->skip)
4737 break;
4738
Bram Moolenaare38eab22019-12-05 21:50:01 +01004739 // Stop when immediately aborting on error, or when an interrupt
4740 // occurred or an exception was thrown but not caught.
4741 // get_func_tv() returned OK, so that the check for trailing
4742 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004743 if (aborting())
4744 break;
4745 }
4746 if (eap->skip)
4747 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004748 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749
Bram Moolenaare51bb172020-02-16 19:42:23 +01004750 // When inside :try we need to check for following "| catch".
4751 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004753 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004754 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004755 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004757 if (!failed)
4758 {
4759 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004760 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004761 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 }
4763 else
4764 eap->nextcmd = check_nextcmd(arg);
4765 }
4766
4767end:
4768 dict_unref(fudi.fd_dict);
4769 vim_free(tofree);
4770}
4771
4772/*
4773 * Return from a function. Possibly makes the return pending. Also called
4774 * for a pending return at the ":endtry" or after returning from an extra
4775 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4776 * when called due to a ":return" command. "rettv" may point to a typval_T
4777 * with the return rettv. Returns TRUE when the return can be carried out,
4778 * FALSE when the return gets pending.
4779 */
4780 int
4781do_return(
4782 exarg_T *eap,
4783 int reanimate,
4784 int is_cmd,
4785 void *rettv)
4786{
4787 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004788 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789
4790 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004791 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004792 current_funccal->returned = FALSE;
4793
4794 /*
4795 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4796 * not in its finally clause (which then is to be executed next) is found.
4797 * In this case, make the ":return" pending for execution at the ":endtry".
4798 * Otherwise, return normally.
4799 */
4800 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4801 if (idx >= 0)
4802 {
4803 cstack->cs_pending[idx] = CSTP_RETURN;
4804
4805 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004806 // A pending return again gets pending. "rettv" points to an
4807 // allocated variable with the rettv of the original ":return"'s
4808 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809 cstack->cs_rettv[idx] = rettv;
4810 else
4811 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004812 // When undoing a return in order to make it pending, get the stored
4813 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004814 if (reanimate)
4815 rettv = current_funccal->rettv;
4816
4817 if (rettv != NULL)
4818 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004819 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4821 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4822 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004823 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824 }
4825 else
4826 cstack->cs_rettv[idx] = NULL;
4827
4828 if (reanimate)
4829 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004830 // The pending return value could be overwritten by a ":return"
4831 // without argument in a finally clause; reset the default
4832 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 current_funccal->rettv->v_type = VAR_NUMBER;
4834 current_funccal->rettv->vval.v_number = 0;
4835 }
4836 }
4837 report_make_pending(CSTP_RETURN, rettv);
4838 }
4839 else
4840 {
4841 current_funccal->returned = TRUE;
4842
Bram Moolenaare38eab22019-12-05 21:50:01 +01004843 // If the return is carried out now, store the return value. For
4844 // a return immediately after reanimation, the value is already
4845 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004846 if (!reanimate && rettv != NULL)
4847 {
4848 clear_tv(current_funccal->rettv);
4849 *current_funccal->rettv = *(typval_T *)rettv;
4850 if (!is_cmd)
4851 vim_free(rettv);
4852 }
4853 }
4854
4855 return idx < 0;
4856}
4857
4858/*
4859 * Free the variable with a pending return value.
4860 */
4861 void
4862discard_pending_return(void *rettv)
4863{
4864 free_tv((typval_T *)rettv);
4865}
4866
4867/*
4868 * Generate a return command for producing the value of "rettv". The result
4869 * is an allocated string. Used by report_pending() for verbose messages.
4870 */
4871 char_u *
4872get_return_cmd(void *rettv)
4873{
4874 char_u *s = NULL;
4875 char_u *tofree = NULL;
4876 char_u numbuf[NUMBUFLEN];
4877
4878 if (rettv != NULL)
4879 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4880 if (s == NULL)
4881 s = (char_u *)"";
4882
4883 STRCPY(IObuff, ":return ");
4884 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4885 if (STRLEN(s) + 8 >= IOSIZE)
4886 STRCPY(IObuff + IOSIZE - 4, "...");
4887 vim_free(tofree);
4888 return vim_strsave(IObuff);
4889}
4890
4891/*
4892 * Get next function line.
4893 * Called by do_cmdline() to get the next line.
4894 * Returns allocated string, or NULL for end of function.
4895 */
4896 char_u *
4897get_func_line(
4898 int c UNUSED,
4899 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004900 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004901 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004902{
4903 funccall_T *fcp = (funccall_T *)cookie;
4904 ufunc_T *fp = fcp->func;
4905 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004906 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907
Bram Moolenaare38eab22019-12-05 21:50:01 +01004908 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004909 if (fcp->dbg_tick != debug_tick)
4910 {
4911 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004912 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 fcp->dbg_tick = debug_tick;
4914 }
4915#ifdef FEAT_PROFILE
4916 if (do_profiling == PROF_YES)
4917 func_line_end(cookie);
4918#endif
4919
4920 gap = &fp->uf_lines;
4921 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4922 || fcp->returned)
4923 retval = NULL;
4924 else
4925 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004926 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927 while (fcp->linenr < gap->ga_len
4928 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4929 ++fcp->linenr;
4930 if (fcp->linenr >= gap->ga_len)
4931 retval = NULL;
4932 else
4933 {
4934 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004935 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936#ifdef FEAT_PROFILE
4937 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004938 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939#endif
4940 }
4941 }
4942
Bram Moolenaare38eab22019-12-05 21:50:01 +01004943 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004944 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004946 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004947 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004948 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004949 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950 fcp->dbg_tick = debug_tick;
4951 }
4952
4953 return retval;
4954}
4955
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956/*
4957 * Return TRUE if the currently active function should be ended, because a
4958 * return was encountered or an error occurred. Used inside a ":while".
4959 */
4960 int
4961func_has_ended(void *cookie)
4962{
4963 funccall_T *fcp = (funccall_T *)cookie;
4964
Bram Moolenaare38eab22019-12-05 21:50:01 +01004965 // Ignore the "abort" flag if the abortion behavior has been changed due to
4966 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004967 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4968 || fcp->returned);
4969}
4970
4971/*
4972 * return TRUE if cookie indicates a function which "abort"s on errors.
4973 */
4974 int
4975func_has_abort(
4976 void *cookie)
4977{
4978 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4979}
4980
4981
4982/*
4983 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4984 * Don't do this when "Func" is already a partial that was bound
4985 * explicitly (pt_auto is FALSE).
4986 * Changes "rettv" in-place.
4987 * Returns the updated "selfdict_in".
4988 */
4989 dict_T *
4990make_partial(dict_T *selfdict_in, typval_T *rettv)
4991{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004992 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993 char_u *tofree = NULL;
4994 ufunc_T *fp;
4995 char_u fname_buf[FLEN_FIXED + 1];
4996 int error;
4997 dict_T *selfdict = selfdict_in;
4998
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004999 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5000 fp = rettv->vval.v_partial->pt_func;
5001 else
5002 {
5003 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5004 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005005 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005006 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005007 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005008 vim_free(tofree);
5009 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005010
5011 if (fp != NULL && (fp->uf_flags & FC_DICT))
5012 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005013 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005014
5015 if (pt != NULL)
5016 {
5017 pt->pt_refcount = 1;
5018 pt->pt_dict = selfdict;
5019 pt->pt_auto = TRUE;
5020 selfdict = NULL;
5021 if (rettv->v_type == VAR_FUNC)
5022 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005023 // Just a function: Take over the function name and use
5024 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005025 pt->pt_name = rettv->vval.v_string;
5026 }
5027 else
5028 {
5029 partial_T *ret_pt = rettv->vval.v_partial;
5030 int i;
5031
Bram Moolenaare38eab22019-12-05 21:50:01 +01005032 // Partial: copy the function name, use selfdict and copy
5033 // args. Can't take over name or args, the partial might
5034 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005035 if (ret_pt->pt_name != NULL)
5036 {
5037 pt->pt_name = vim_strsave(ret_pt->pt_name);
5038 func_ref(pt->pt_name);
5039 }
5040 else
5041 {
5042 pt->pt_func = ret_pt->pt_func;
5043 func_ptr_ref(pt->pt_func);
5044 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005045 if (ret_pt->pt_argc > 0)
5046 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005047 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005048 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005049 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005050 pt->pt_argc = 0;
5051 else
5052 {
5053 pt->pt_argc = ret_pt->pt_argc;
5054 for (i = 0; i < pt->pt_argc; i++)
5055 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5056 }
5057 }
5058 partial_unref(ret_pt);
5059 }
5060 rettv->v_type = VAR_PARTIAL;
5061 rettv->vval.v_partial = pt;
5062 }
5063 }
5064 return selfdict;
5065}
5066
5067/*
5068 * Return the name of the executed function.
5069 */
5070 char_u *
5071func_name(void *cookie)
5072{
5073 return ((funccall_T *)cookie)->func->uf_name;
5074}
5075
5076/*
5077 * Return the address holding the next breakpoint line for a funccall cookie.
5078 */
5079 linenr_T *
5080func_breakpoint(void *cookie)
5081{
5082 return &((funccall_T *)cookie)->breakpoint;
5083}
5084
5085/*
5086 * Return the address holding the debug tick for a funccall cookie.
5087 */
5088 int *
5089func_dbg_tick(void *cookie)
5090{
5091 return &((funccall_T *)cookie)->dbg_tick;
5092}
5093
5094/*
5095 * Return the nesting level for a funccall cookie.
5096 */
5097 int
5098func_level(void *cookie)
5099{
5100 return ((funccall_T *)cookie)->level;
5101}
5102
5103/*
5104 * Return TRUE when a function was ended by a ":return" command.
5105 */
5106 int
5107current_func_returned(void)
5108{
5109 return current_funccal->returned;
5110}
5111
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005112 int
5113free_unref_funccal(int copyID, int testing)
5114{
5115 int did_free = FALSE;
5116 int did_free_funccal = FALSE;
5117 funccall_T *fc, **pfc;
5118
5119 for (pfc = &previous_funccal; *pfc != NULL; )
5120 {
5121 if (can_free_funccal(*pfc, copyID))
5122 {
5123 fc = *pfc;
5124 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005125 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126 did_free = TRUE;
5127 did_free_funccal = TRUE;
5128 }
5129 else
5130 pfc = &(*pfc)->caller;
5131 }
5132 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005133 // When a funccal was freed some more items might be garbage
5134 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005135 (void)garbage_collect(testing);
5136
5137 return did_free;
5138}
5139
5140/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005141 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005142 */
5143 static funccall_T *
5144get_funccal(void)
5145{
5146 int i;
5147 funccall_T *funccal;
5148 funccall_T *temp_funccal;
5149
5150 funccal = current_funccal;
5151 if (debug_backtrace_level > 0)
5152 {
5153 for (i = 0; i < debug_backtrace_level; i++)
5154 {
5155 temp_funccal = funccal->caller;
5156 if (temp_funccal)
5157 funccal = temp_funccal;
5158 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005159 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005160 debug_backtrace_level = i;
5161 }
5162 }
5163 return funccal;
5164}
5165
5166/*
5167 * Return the hashtable used for local variables in the current funccal.
5168 * Return NULL if there is no current funccal.
5169 */
5170 hashtab_T *
5171get_funccal_local_ht()
5172{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005173 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005174 return NULL;
5175 return &get_funccal()->l_vars.dv_hashtab;
5176}
5177
5178/*
5179 * Return the l: scope variable.
5180 * Return NULL if there is no current funccal.
5181 */
5182 dictitem_T *
5183get_funccal_local_var()
5184{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005185 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005186 return NULL;
5187 return &get_funccal()->l_vars_var;
5188}
5189
5190/*
5191 * Return the hashtable used for argument in the current funccal.
5192 * Return NULL if there is no current funccal.
5193 */
5194 hashtab_T *
5195get_funccal_args_ht()
5196{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005197 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005198 return NULL;
5199 return &get_funccal()->l_avars.dv_hashtab;
5200}
5201
5202/*
5203 * Return the a: scope variable.
5204 * Return NULL if there is no current funccal.
5205 */
5206 dictitem_T *
5207get_funccal_args_var()
5208{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005209 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005210 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005211 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212}
5213
5214/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215 * List function variables, if there is a function.
5216 */
5217 void
5218list_func_vars(int *first)
5219{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005220 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005221 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005222 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223}
5224
5225/*
5226 * If "ht" is the hashtable for local variables in the current funccal, return
5227 * the dict that contains it.
5228 * Otherwise return NULL.
5229 */
5230 dict_T *
5231get_current_funccal_dict(hashtab_T *ht)
5232{
5233 if (current_funccal != NULL
5234 && ht == &current_funccal->l_vars.dv_hashtab)
5235 return &current_funccal->l_vars;
5236 return NULL;
5237}
5238
5239/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005240 * Search hashitem in parent scope.
5241 */
5242 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005243find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005244{
5245 funccall_T *old_current_funccal = current_funccal;
5246 hashtab_T *ht;
5247 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005248 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005249
5250 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5251 return NULL;
5252
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005253 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005254 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005255 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005256 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005257 ht = find_var_ht(name, &varname);
5258 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005259 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005260 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005261 if (!HASHITEM_EMPTY(hi))
5262 {
5263 *pht = ht;
5264 break;
5265 }
5266 }
5267 if (current_funccal == current_funccal->func->uf_scoped)
5268 break;
5269 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005270 }
5271 current_funccal = old_current_funccal;
5272
5273 return hi;
5274}
5275
5276/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005277 * Search variable in parent scope.
5278 */
5279 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005280find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005281{
5282 dictitem_T *v = NULL;
5283 funccall_T *old_current_funccal = current_funccal;
5284 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005285 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005286
5287 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5288 return NULL;
5289
Bram Moolenaare38eab22019-12-05 21:50:01 +01005290 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005291 current_funccal = current_funccal->func->uf_scoped;
5292 while (current_funccal)
5293 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005294 ht = find_var_ht(name, &varname);
5295 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005296 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005297 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005298 if (v != NULL)
5299 break;
5300 }
5301 if (current_funccal == current_funccal->func->uf_scoped)
5302 break;
5303 current_funccal = current_funccal->func->uf_scoped;
5304 }
5305 current_funccal = old_current_funccal;
5306
5307 return v;
5308}
5309
5310/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005311 * Set "copyID + 1" in previous_funccal and callers.
5312 */
5313 int
5314set_ref_in_previous_funccal(int copyID)
5315{
5316 int abort = FALSE;
5317 funccall_T *fc;
5318
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005319 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005320 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005321 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005322 abort = abort
5323 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5324 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005325 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005326 }
5327 return abort;
5328}
5329
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005330 static int
5331set_ref_in_funccal(funccall_T *fc, int copyID)
5332{
5333 int abort = FALSE;
5334
5335 if (fc->fc_copyID != copyID)
5336 {
5337 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005338 abort = abort
5339 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5340 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005341 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005342 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005343 }
5344 return abort;
5345}
5346
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005347/*
5348 * Set "copyID" in all local vars and arguments in the call stack.
5349 */
5350 int
5351set_ref_in_call_stack(int copyID)
5352{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005353 int abort = FALSE;
5354 funccall_T *fc;
5355 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005356
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005357 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005358 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005359
5360 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005361 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5362 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005363 abort = abort || set_ref_in_funccal(fc, copyID);
5364
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005365 return abort;
5366}
5367
5368/*
5369 * Set "copyID" in all functions available by name.
5370 */
5371 int
5372set_ref_in_functions(int copyID)
5373{
5374 int todo;
5375 hashitem_T *hi = NULL;
5376 int abort = FALSE;
5377 ufunc_T *fp;
5378
5379 todo = (int)func_hashtab.ht_used;
5380 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005381 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005382 if (!HASHITEM_EMPTY(hi))
5383 {
5384 --todo;
5385 fp = HI2UF(hi);
5386 if (!func_name_refcount(fp->uf_name))
5387 abort = abort || set_ref_in_func(NULL, fp, copyID);
5388 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005389 }
5390 return abort;
5391}
5392
5393/*
5394 * Set "copyID" in all function arguments.
5395 */
5396 int
5397set_ref_in_func_args(int copyID)
5398{
5399 int i;
5400 int abort = FALSE;
5401
5402 for (i = 0; i < funcargs.ga_len; ++i)
5403 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5404 copyID, NULL, NULL);
5405 return abort;
5406}
5407
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005408/*
5409 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005410 * Returns TRUE if setting references failed somehow.
5411 */
5412 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005413set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005414{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005415 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005416 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005417 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005418 char_u fname_buf[FLEN_FIXED + 1];
5419 char_u *tofree = NULL;
5420 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005421 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005422
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005423 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005424 return FALSE;
5425
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005426 if (fp_in == NULL)
5427 {
5428 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005429 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005430 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005431 if (fp != NULL)
5432 {
5433 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005434 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005435 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005436
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005437 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005438 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005439}
5440
Bram Moolenaare38eab22019-12-05 21:50:01 +01005441#endif // FEAT_EVAL