blob: 7d3bb292d8f5748f1c75060843466a613962f93d [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
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020035
36 void
37func_init()
38{
39 hash_init(&func_hashtab);
40}
41
Dominique Pelle748b3082022-01-08 12:41:16 +000042#if defined(FEAT_PROFILE) || defined(PROTO)
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020043/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020044 * Return the function hash table
45 */
46 hashtab_T *
47func_tbl_get(void)
48{
49 return &func_hashtab;
50}
Dominique Pelle748b3082022-01-08 12:41:16 +000051#endif
Bram Moolenaar660a10a2019-07-14 15:48:38 +020052
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010067 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020068 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010069 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010070{
Bram Moolenaar6e949782020-04-13 17:21:00 +020071 char_u *p = arg;
72 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020073 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010074
75 while (ASCII_ISALNUM(*p) || *p == '_')
76 ++p;
77 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020078 || (argtypes == NULL
79 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
80 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010081 {
82 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000083 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 return arg;
85 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010086
Bram Moolenaar057e84a2021-02-28 16:55:11 +010087 // Vim9 script: cannot use script var name for argument. In function: also
88 // check local vars and arguments.
89 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
90 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010091 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010092
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010093 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
94 return arg;
95 if (newargs != NULL)
96 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010097 int c;
98 int i;
99
100 c = *p;
101 *p = NUL;
102 arg_copy = vim_strsave(arg);
103 if (arg_copy == NULL)
104 {
105 *p = c;
106 return arg;
107 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200108 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200109 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200110 // 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 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000114 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200115 vim_free(arg_copy);
116 return arg;
117 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100118 ((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 Moolenaar51e7e782021-04-10 17:46:52 +0200148 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
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
Bram Moolenaar2a389082021-04-09 20:24:31 +0200158 type = vim_strsave((char_u *)
159 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100160 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
161 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100162 }
163
164 return p;
165}
166
167/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000168 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000169 * Get a next line, store it in "eap" if appropriate and put the line in
170 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 */
172 static char_u *
173get_function_line(
174 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000175 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000176 int indent,
177 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000178{
179 char_u *theline;
180
181 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000182 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000183 else
184 theline = eap->getline(':', eap->cookie, indent, getline_options);
185 if (theline != NULL)
186 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000187 if (lines_to_free->ga_len > 0
188 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
189 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000190 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000191 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000192 }
193
194 return theline;
195}
196
197/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200198 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100199 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100200 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203get_function_args(
204 char_u **argp,
205 char_u endchar,
206 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100207 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100208 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100209 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200210 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200211 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200212 int skip,
213 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000214 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200215{
216 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100217 char_u *arg;
218 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200219 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200220 int any_default = FALSE;
221 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100222 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200223
224 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000225 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100226 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000227 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200228 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000229 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230
231 if (varargs != NULL)
232 *varargs = FALSE;
233
234 /*
235 * Isolate the arguments: "arg1, arg2, ...)"
236 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100237 arg = skipwhite(*argp);
238 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200239 while (*p != endchar)
240 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200241 while (eap != NULL && eap->getline != NULL
242 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200243 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200244 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000245 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000246 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000247
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200248 if (theline == NULL)
249 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200250 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 p = skipwhite(theline);
252 }
253
254 if (mustend && *p != endchar)
255 {
256 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000257 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100258 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200259 }
260 if (*p == endchar)
261 break;
262
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200263 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
264 {
265 if (varargs != NULL)
266 *varargs = TRUE;
267 p += 3;
268 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100269
270 if (argtypes != NULL)
271 {
272 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200273 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100275 if (!skip)
276 emsg(_(e_missing_name_after_dots));
277 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100278 }
279
280 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100281 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200282 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100283 if (p == arg)
284 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100285 if (*skipwhite(p) == '=')
286 {
287 emsg(_(e_cannot_use_default_for_variable_arguments));
288 break;
289 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100290 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200291 }
292 else
293 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200294 char_u *np;
295
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200296 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100297 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200298 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100299 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200300 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200301
Bram Moolenaar015cf102021-06-26 21:52:02 +0200302 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200303 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200304 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200305 if (*np == '=' && np[1] != '=' && np[1] != '~'
306 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200307 {
308 typval_T rettv;
309
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100310 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200311 any_default = TRUE;
312 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200313 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 p = skipwhite(p);
315 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200316 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200318 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200319 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200320 if (ga_grow(default_args, 1) == FAIL)
321 goto err_ret;
322
323 // trim trailing whitespace
324 while (p > expr && VIM_ISWHITE(p[-1]))
325 p--;
326 c = *p;
327 *p = NUL;
328 expr = vim_strsave(expr);
329 if (expr == NULL)
330 {
331 *p = c;
332 goto err_ret;
333 }
334 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200335 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200336 default_args->ga_len++;
337 *p = c;
338 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200339 }
340 else
341 mustend = TRUE;
342 }
343 else if (any_default)
344 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000345 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200346 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200347 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200348
349 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
350 {
351 // Be tolerant when skipping
352 if (!skip)
353 {
354 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
355 goto err_ret;
356 }
357 p = skipwhite(p);
358 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200359 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200360 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200361 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200362 // Don't give this error when skipping, it makes the "->" not
363 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100364 // Allow missing space after comma in legacy functions.
365 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200366 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
367 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100368 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 goto err_ret;
370 }
371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200372 else
373 mustend = TRUE;
374 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200375 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200376 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200378
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200379 if (*p != endchar)
380 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100381 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200382
383 *argp = p;
384 return OK;
385
386err_ret:
387 if (newargs != NULL)
388 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200389 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200390 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200391 return FAIL;
392}
393
394/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100395 * Parse the argument types, filling "fp->uf_arg_types".
396 * Return OK or FAIL.
397 */
398 static int
399parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
400{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200401 int len = 0;
402
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100403 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
404 if (argtypes->ga_len > 0)
405 {
406 // When "varargs" is set the last name/type goes into uf_va_name
407 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200408 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100409
410 if (len > 0)
411 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
412 if (fp->uf_arg_types != NULL)
413 {
414 int i;
415 type_T *type;
416
417 for (i = 0; i < len; ++ i)
418 {
419 char_u *p = ((char_u **)argtypes->ga_data)[i];
420
421 if (p == NULL)
422 // will get the type from the default value
423 type = &t_unknown;
424 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100425 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100426 if (type == NULL)
427 return FAIL;
428 fp->uf_arg_types[i] = type;
429 }
430 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100431 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200432
433 if (varargs)
434 {
435 char_u *p;
436
437 // Move the last argument "...name: type" to uf_va_name and
438 // uf_va_type.
439 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
440 [fp->uf_args.ga_len - 1];
441 --fp->uf_args.ga_len;
442 p = ((char_u **)argtypes->ga_data)[len];
443 if (p == NULL)
444 // TODO: get type from default value
445 fp->uf_va_type = &t_list_any;
446 else
447 {
448 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
449 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
450 {
451 semsg(_(e_variable_arguments_type_must_be_list_str),
452 ((char_u **)argtypes->ga_data)[len]);
453 return FAIL;
454 }
455 }
456 if (fp->uf_va_type == NULL)
457 return FAIL;
458 }
459
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100460 return OK;
461}
462
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100463 static int
464parse_return_type(ufunc_T *fp, char_u *ret_type)
465{
466 if (ret_type == NULL)
467 fp->uf_ret_type = &t_void;
468 else
469 {
470 char_u *p = ret_type;
471
472 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
473 if (fp->uf_ret_type == NULL)
474 {
475 fp->uf_ret_type = &t_void;
476 return FAIL;
477 }
478 }
479 return OK;
480}
481
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100482/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200483 * Register function "fp" as using "current_funccal" as its scope.
484 */
485 static int
486register_closure(ufunc_T *fp)
487{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200488 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100489 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200490 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200491 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200492 fp->uf_scoped = current_funccal;
493 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
496 return FAIL;
497 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
498 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200499 return OK;
500}
501
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100502 static void
503set_ufunc_name(ufunc_T *fp, char_u *name)
504{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100505 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
506 // actually extends beyond the struct.
507 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100508
509 if (name[0] == K_SPECIAL)
510 {
511 fp->uf_name_exp = alloc(STRLEN(name) + 3);
512 if (fp->uf_name_exp != NULL)
513 {
514 STRCPY(fp->uf_name_exp, "<SNR>");
515 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
516 }
517 }
518}
519
Bram Moolenaar58016442016-07-31 18:30:22 +0200520/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200521 * Get a name for a lambda. Returned in static memory.
522 */
523 char_u *
524get_lambda_name(void)
525{
526 static char_u name[30];
527 static int lambda_no = 0;
528
529 sprintf((char*)name, "<lambda>%d", ++lambda_no);
530 return name;
531}
532
Bram Moolenaar801ab062020-06-25 19:27:56 +0200533#if defined(FEAT_LUA) || defined(PROTO)
534/*
535 * Registers a native C callback which can be called from Vim script.
536 * Returns the name of the Vim script function.
537 */
538 char_u *
539register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
540{
541 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200542 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200543
544 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
545 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200546 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200547
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200548 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200549 fp->uf_refcount = 1;
550 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000551 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200552 fp->uf_calls = 0;
553 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200554 fp->uf_cb = cb;
555 fp->uf_cb_free = cb_free;
556 fp->uf_cb_state = state;
557
558 set_ufunc_name(fp, name);
559 hash_add(&func_hashtab, UF2HIKEY(fp));
560
561 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200562}
563#endif
564
Bram Moolenaar04b12692020-05-04 23:24:44 +0200565/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100566 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100568 * If "white_error" is not NULL check for correct use of white space and set
569 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100570 * Return NULL if no valid arrow found.
571 */
572 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100573skip_arrow(
574 char_u *start,
575 int equal_arrow,
576 char_u **ret_type,
577 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100578{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100579 char_u *s = start;
580 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100581
582 if (equal_arrow)
583 {
584 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100585 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100586 if (white_error != NULL && !VIM_ISWHITE(s[1]))
587 {
588 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100589 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100592 s = skipwhite(s + 1);
593 *ret_type = s;
594 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100595 if (s == *ret_type)
596 {
597 emsg(_(e_missing_return_type));
598 return NULL;
599 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100600 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100601 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100602 s = skipwhite(s);
603 if (*s != '=')
604 return NULL;
605 ++s;
606 }
607 if (*s != '>')
608 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100609 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
610 || !IS_WHITE_OR_NUL(s[1])))
611 {
612 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100613 semsg(_(e_white_space_required_before_and_after_str_at_str),
614 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100615 return NULL;
616 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100617 return skipwhite(s + 1);
618}
619
620/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100621 * Check if "*cmd" points to a function command and if so advance "*cmd" and
622 * return TRUE.
623 * Otherwise return FALSE;
624 * Do not consider "function(" to be a command.
625 */
626 static int
627is_function_cmd(char_u **cmd)
628{
629 char_u *p = *cmd;
630
631 if (checkforcmd(&p, "function", 2))
632 {
633 if (*p == '(')
634 return FALSE;
635 *cmd = p;
636 return TRUE;
637 }
638 return FALSE;
639}
640
641/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200642 * Called when defining a function: The context may be needed for script
643 * variables declared in a block that is visible now but not when the function
644 * is compiled or called later.
645 */
646 static void
647function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
648{
649 if (cstack != NULL && cstack->cs_idx >= 0)
650 {
651 int count = cstack->cs_idx + 1;
652 int i;
653
654 fp->uf_block_ids = ALLOC_MULT(int, count);
655 if (fp->uf_block_ids != NULL)
656 {
657 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
658 sizeof(int) * count);
659 fp->uf_block_depth = count;
660 }
661
662 // Set flag in each block to indicate a function was defined. This
663 // is used to keep the variable when leaving the block, see
664 // hide_script_var().
665 for (i = 0; i <= cstack->cs_idx; ++i)
666 cstack->cs_flags[i] |= CSF_FUNC_DEF;
667 }
668}
669
670/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100671 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200672 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100673 * "newlines" must already have been initialized.
674 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
675 */
676 static int
677get_function_body(
678 exarg_T *eap,
679 garray_T *newlines,
680 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000681 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100682{
683 linenr_T sourcing_lnum_top = SOURCING_LNUM;
684 linenr_T sourcing_lnum_off;
685 int saved_wait_return = need_wait_return;
686 char_u *line_arg = line_arg_in;
687 int vim9_function = eap->cmdidx == CMD_def
688 || eap->cmdidx == CMD_block;
689#define MAX_FUNC_NESTING 50
690 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100692 int nesting = 0;
693 getline_opt_T getline_options;
694 int indent = 2;
695 char_u *skip_until = NULL;
696 int ret = FAIL;
697 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200698 int heredoc_concat_len = 0;
699 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100700 char_u *heredoc_trimmed = NULL;
701
Bram Moolenaar20677332021-06-06 17:02:53 +0200702 ga_init2(&heredoc_ga, 1, 500);
703
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100704 // Detect having skipped over comment lines to find the return
705 // type. Add NULL lines to keep the line count correct.
706 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
707 if (SOURCING_LNUM < sourcing_lnum_off)
708 {
709 sourcing_lnum_off -= SOURCING_LNUM;
710 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
711 goto theend;
712 while (sourcing_lnum_off-- > 0)
713 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
714 }
715
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200716 nesting_def[0] = vim9_function;
717 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100718 getline_options = vim9_function
719 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
720 for (;;)
721 {
722 char_u *theline;
723 char_u *p;
724 char_u *arg;
725
726 if (KeyTyped)
727 {
728 msg_scroll = TRUE;
729 saved_wait_return = FALSE;
730 }
731 need_wait_return = FALSE;
732
733 if (line_arg != NULL)
734 {
735 // Use eap->arg, split up in parts by line breaks.
736 theline = line_arg;
737 p = vim_strchr(theline, '\n');
738 if (p == NULL)
739 line_arg += STRLEN(line_arg);
740 else
741 {
742 *p = NUL;
743 line_arg = p + 1;
744 }
745 }
746 else
747 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000748 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100749 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100750 }
751 if (KeyTyped)
752 lines_left = Rows - 1;
753 if (theline == NULL)
754 {
755 // Use the start of the function for the line number.
756 SOURCING_LNUM = sourcing_lnum_top;
757 if (skip_until != NULL)
758 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200759 else if (nesting_inline[nesting])
760 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100761 else if (eap->cmdidx == CMD_def)
762 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100763 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000764 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100765 goto theend;
766 }
767
768 // Detect line continuation: SOURCING_LNUM increased more than one.
769 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
770 if (SOURCING_LNUM < sourcing_lnum_off)
771 sourcing_lnum_off -= SOURCING_LNUM;
772 else
773 sourcing_lnum_off = 0;
774
775 if (skip_until != NULL)
776 {
777 // Don't check for ":endfunc"/":enddef" between
778 // * ":append" and "."
779 // * ":python <<EOF" and "EOF"
780 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
781 if (heredoc_trimmed == NULL
782 || (is_heredoc && skipwhite(theline) == theline)
783 || STRNCMP(theline, heredoc_trimmed,
784 STRLEN(heredoc_trimmed)) == 0)
785 {
786 if (heredoc_trimmed == NULL)
787 p = theline;
788 else if (is_heredoc)
789 p = skipwhite(theline) == theline
790 ? theline : theline + STRLEN(heredoc_trimmed);
791 else
792 p = theline + STRLEN(heredoc_trimmed);
793 if (STRCMP(p, skip_until) == 0)
794 {
795 VIM_CLEAR(skip_until);
796 VIM_CLEAR(heredoc_trimmed);
797 getline_options = vim9_function
798 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
799 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200800
801 if (heredoc_concat_len > 0)
802 {
803 // Replace the starting line with all the concatenated
804 // lines.
805 ga_concat(&heredoc_ga, theline);
806 vim_free(((char_u **)(newlines->ga_data))[
807 heredoc_concat_len - 1]);
808 ((char_u **)(newlines->ga_data))[
809 heredoc_concat_len - 1] = heredoc_ga.ga_data;
810 ga_init(&heredoc_ga);
811 heredoc_concat_len = 0;
812 theline += STRLEN(theline); // skip the "EOF"
813 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100814 }
815 }
816 }
817 else
818 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200819 int c;
820 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100821
822 // skip ':' and blanks
823 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
824 ;
825
826 // Check for "endfunction", "enddef" or "}".
827 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200828 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100829 ? *p == '}'
830 : (checkforcmd(&p, nesting_def[nesting]
831 ? "enddef" : "endfunction", 4)
832 && *p != ':'))
833 {
834 if (nesting-- == 0)
835 {
836 char_u *nextcmd = NULL;
837
838 if (*p == '|' || *p == '}')
839 nextcmd = p + 1;
840 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
841 nextcmd = line_arg;
842 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100843 && (vim9_function || p_verbose > 0))
844 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200845 SOURCING_LNUM = sourcing_lnum_top
846 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100847 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000848 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100849 else
850 give_warning2((char_u *)
851 _("W22: Text found after :endfunction: %s"),
852 p, TRUE);
853 }
854 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100855 {
856 // Another command follows. If the line came from "eap"
857 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000858 // change "eap->cmdlinep" to point to the last fetched
859 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100860 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000861 if (lines_to_free->ga_len > 0
862 && *eap->cmdlinep !=
863 ((char_u **)lines_to_free->ga_data)
864 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100865 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000866 // *cmdlinep will be freed later, thus remove the
867 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000869 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
870 [lines_to_free->ga_len - 1];
871 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100872 }
873 }
874 break;
875 }
876 }
877
878 // Check for mismatched "endfunc" or "enddef".
879 // We don't check for "def" inside "func" thus we also can't check
880 // for "enddef".
881 // We continue to find the end of the function, although we might
882 // not find it.
883 else if (nesting_def[nesting])
884 {
885 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
886 emsg(_(e_mismatched_endfunction));
887 }
888 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
889 emsg(_(e_mismatched_enddef));
890
891 // Increase indent inside "if", "while", "for" and "try", decrease
892 // at "end".
893 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
894 indent -= 2;
895 else if (STRNCMP(p, "if", 2) == 0
896 || STRNCMP(p, "wh", 2) == 0
897 || STRNCMP(p, "for", 3) == 0
898 || STRNCMP(p, "try", 3) == 0)
899 indent += 2;
900
901 // Check for defining a function inside this function.
902 // Only recognize "def" inside "def", not inside "function",
903 // For backwards compatibility, see Test_function_python().
904 c = *p;
905 if (is_function_cmd(&p)
906 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
907 {
908 if (*p == '!')
909 p = skipwhite(p + 1);
910 p += eval_fname_script(p);
911 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
912 NULL, NULL));
913 if (*skipwhite(p) == '(')
914 {
915 if (nesting == MAX_FUNC_NESTING - 1)
916 emsg(_(e_function_nesting_too_deep));
917 else
918 {
919 ++nesting;
920 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200921 nesting_inline[nesting] = FALSE;
922 indent += 2;
923 }
924 }
925 }
926
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200927 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200928 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200929 // Not a comment line: check for nested inline function.
930 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200931 while (end > p && VIM_ISWHITE(*end))
932 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200933 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200934 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200935 int is_block;
936
937 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200938 --end;
939 while (end > p && VIM_ISWHITE(*end))
940 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200941 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
942 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200943 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200944 char_u *s = p;
945
946 // check for line starting with "au" for :autocmd or
947 // "com" for :command, these can use a {} block
948 is_block = checkforcmd_noparen(&s, "autocmd", 2)
949 || checkforcmd_noparen(&s, "command", 3);
950 }
951
952 if (is_block)
953 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200954 if (nesting == MAX_FUNC_NESTING - 1)
955 emsg(_(e_function_nesting_too_deep));
956 else
957 {
958 ++nesting;
959 nesting_def[nesting] = TRUE;
960 nesting_inline[nesting] = TRUE;
961 indent += 2;
962 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100963 }
964 }
965 }
966
967 // Check for ":append", ":change", ":insert". Not for :def.
968 p = skip_range(p, FALSE, NULL);
969 if (!vim9_function
970 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
971 || (p[0] == 'c'
972 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
973 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
974 && (STRNCMP(&p[3], "nge", 3) != 0
975 || !ASCII_ISALPHA(p[6])))))))
976 || (p[0] == 'i'
977 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
978 && (!ASCII_ISALPHA(p[2])
979 || (p[2] == 's'
980 && (!ASCII_ISALPHA(p[3])
981 || p[3] == 'e'))))))))
982 skip_until = vim_strsave((char_u *)".");
983
984 // Check for ":python <<EOF", ":tcl <<EOF", etc.
985 arg = skipwhite(skiptowhite(p));
986 if (arg[0] == '<' && arg[1] =='<'
987 && ((p[0] == 'p' && p[1] == 'y'
988 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
989 || ((p[2] == '3' || p[2] == 'x')
990 && !ASCII_ISALPHA(p[3]))))
991 || (p[0] == 'p' && p[1] == 'e'
992 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
993 || (p[0] == 't' && p[1] == 'c'
994 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
995 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
996 && !ASCII_ISALPHA(p[3]))
997 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
998 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
999 || (p[0] == 'm' && p[1] == 'z'
1000 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1001 ))
1002 {
1003 // ":python <<" continues until a dot, like ":append"
1004 p = skipwhite(arg + 2);
1005 if (STRNCMP(p, "trim", 4) == 0)
1006 {
1007 // Ignore leading white space.
1008 p = skipwhite(p + 4);
1009 heredoc_trimmed = vim_strnsave(theline,
1010 skipwhite(theline) - theline);
1011 }
1012 if (*p == NUL)
1013 skip_until = vim_strsave((char_u *)".");
1014 else
1015 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1016 getline_options = GETLINE_NONE;
1017 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001018 if (eap->cmdidx == CMD_def)
1019 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001020 }
1021
1022 // Check for ":cmd v =<< [trim] EOF"
1023 // and ":cmd [a, b] =<< [trim] EOF"
1024 // and "lines =<< [trim] EOF" for Vim9
1025 // Where "cmd" can be "let", "var", "final" or "const".
1026 arg = skipwhite(skiptowhite(p));
1027 if (*arg == '[')
1028 arg = vim_strchr(arg, ']');
1029 if (arg != NULL)
1030 {
1031 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1032 && arg[1] == '<' && arg[2] =='<');
1033
1034 if (!found)
1035 // skip over the argument after "cmd"
1036 arg = skipwhite(skiptowhite(arg));
1037 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1038 && (checkforcmd(&p, "let", 2)
1039 || checkforcmd(&p, "var", 3)
1040 || checkforcmd(&p, "final", 5)
1041 || checkforcmd(&p, "const", 5))))
1042 {
1043 p = skipwhite(arg + 3);
1044 if (STRNCMP(p, "trim", 4) == 0)
1045 {
1046 // Ignore leading white space.
1047 p = skipwhite(p + 4);
1048 heredoc_trimmed = vim_strnsave(theline,
1049 skipwhite(theline) - theline);
1050 }
1051 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1052 getline_options = GETLINE_NONE;
1053 is_heredoc = TRUE;
1054 }
1055 }
1056 }
1057
1058 // Add the line to the function.
1059 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1060 goto theend;
1061
Bram Moolenaar20677332021-06-06 17:02:53 +02001062 if (heredoc_concat_len > 0)
1063 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001064 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001065 // to be used for the instruction later.
1066 ga_concat(&heredoc_ga, theline);
1067 ga_concat(&heredoc_ga, (char_u *)"\n");
1068 p = vim_strsave((char_u *)"");
1069 }
1070 else
1071 {
1072 // Copy the line to newly allocated memory. get_one_sourceline()
1073 // allocates 250 bytes per line, this saves 80% on average. The
1074 // cost is an extra alloc/free.
1075 p = vim_strsave(theline);
1076 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001077 if (p == NULL)
1078 goto theend;
1079 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1080
1081 // Add NULL lines for continuation lines, so that the line count is
1082 // equal to the index in the growarray.
1083 while (sourcing_lnum_off-- > 0)
1084 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1085
1086 // Check for end of eap->arg.
1087 if (line_arg != NULL && *line_arg == NUL)
1088 line_arg = NULL;
1089 }
1090
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001091 // Return OK when no error was detected.
1092 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001093 ret = OK;
1094
1095theend:
1096 vim_free(skip_until);
1097 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001098 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001099 need_wait_return |= saved_wait_return;
1100 return ret;
1101}
1102
1103/*
1104 * Handle the body of a lambda. *arg points to the "{", process statements
1105 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001106 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 * When successful "rettv" is set to a funcref.
1108 */
1109 static int
1110lambda_function_body(
1111 char_u **arg,
1112 typval_T *rettv,
1113 evalarg_T *evalarg,
1114 garray_T *newargs,
1115 garray_T *argtypes,
1116 int varargs,
1117 garray_T *default_args,
1118 char_u *ret_type)
1119{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001120 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001121 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001122 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001123 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001124 exarg_T eap;
1125 garray_T newlines;
1126 char_u *cmdline = NULL;
1127 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001128 partial_T *pt;
1129 char_u *name;
1130 int lnum_save = -1;
1131 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1132
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001133 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1134 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001135 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001136 return FAIL;
1137 }
1138
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001139 CLEAR_FIELD(eap);
1140 eap.cmdidx = CMD_block;
1141 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 eap.cmdlinep = &cmdline;
1143 eap.skip = !evaluate;
1144 if (evalarg->eval_cctx != NULL)
1145 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1146 else
1147 {
1148 eap.getline = evalarg->eval_getline;
1149 eap.cookie = evalarg->eval_cookie;
1150 }
1151
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001152 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001153 if (get_function_body(&eap, &newlines, NULL,
1154 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001155 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001156
1157 // When inside a lambda must add the function lines to evalarg.eval_ga.
1158 evalarg->eval_break_count += newlines.ga_len;
1159 if (gap->ga_itemsize > 0)
1160 {
1161 int idx;
1162 char_u *last;
1163 size_t plen;
1164 char_u *pnl;
1165
1166 for (idx = 0; idx < newlines.ga_len; ++idx)
1167 {
1168 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1169
Bram Moolenaarecb66452021-05-18 15:09:18 +02001170 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001171 goto erret;
1172
1173 // Going to concatenate the lines after parsing. For an empty or
1174 // comment line use an empty string.
1175 // Insert NL characters at the start of each line, the string will
1176 // be split again later in .get_lambda_tv().
1177 if (*p == NUL || vim9_comment_start(p))
1178 p = (char_u *)"";
1179 plen = STRLEN(p);
1180 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1181 if (pnl != NULL)
1182 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001183 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1184 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001185 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001186 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001187 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001188 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001189 // more is following after the "}", which was skipped
1190 last = cmdline;
1191 else
1192 // nothing is following the "}"
1193 last = (char_u *)"}";
1194 plen = STRLEN(last);
1195 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1196 if (pnl != NULL)
1197 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001198 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1199 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001200 }
1201
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001202 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001203 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001204 garray_T *tfgap = &evalarg->eval_tofree_ga;
1205
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 // Something comes after the "}".
1207 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001208
1209 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001210 if (ga_grow(tfgap, 1) == OK)
1211 {
1212 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1213 evalarg->eval_using_cmdline = TRUE;
1214 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001215 }
1216 else
1217 *arg = (char_u *)"";
1218
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001219 if (!evaluate)
1220 {
1221 ret = OK;
1222 goto erret;
1223 }
1224
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001225 name = get_lambda_name();
1226 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1227 if (ufunc == NULL)
1228 goto erret;
1229 set_ufunc_name(ufunc, name);
1230 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001231 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001232 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001233 ufunc->uf_refcount = 1;
1234 ufunc->uf_args = *newargs;
1235 newargs->ga_data = NULL;
1236 ufunc->uf_def_args = *default_args;
1237 default_args->ga_data = NULL;
1238 ufunc->uf_func_type = &t_func_any;
1239
1240 // error messages are for the first function line
1241 lnum_save = SOURCING_LNUM;
1242 SOURCING_LNUM = sourcing_lnum_top;
1243
1244 // parse argument types
1245 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1246 {
1247 SOURCING_LNUM = lnum_save;
1248 goto erret;
1249 }
1250
1251 // parse the return type, if any
1252 if (parse_return_type(ufunc, ret_type) == FAIL)
1253 goto erret;
1254
1255 pt = ALLOC_CLEAR_ONE(partial_T);
1256 if (pt == NULL)
1257 goto erret;
1258 pt->pt_func = ufunc;
1259 pt->pt_refcount = 1;
1260
1261 ufunc->uf_lines = newlines;
1262 newlines.ga_data = NULL;
1263 if (sandbox)
1264 ufunc->uf_flags |= FC_SANDBOX;
1265 if (!ASCII_ISUPPER(*ufunc->uf_name))
1266 ufunc->uf_flags |= FC_VIM9;
1267 ufunc->uf_script_ctx = current_sctx;
1268 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1269 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1270 set_function_type(ufunc);
1271
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001272 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1273
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001274 rettv->vval.v_partial = pt;
1275 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001276 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001277 ret = OK;
1278
1279erret:
1280 if (lnum_save >= 0)
1281 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001283 if (newargs != NULL)
1284 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001286 if (ufunc != NULL)
1287 {
1288 func_clear(ufunc, TRUE);
1289 func_free(ufunc, TRUE);
1290 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001291 return ret;
1292}
1293
1294/*
1295 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001296 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001297 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001298 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1299 */
1300 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001301get_lambda_tv(
1302 char_u **arg,
1303 typval_T *rettv,
1304 int types_optional,
1305 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001306{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001307 int evaluate = evalarg != NULL
1308 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309 garray_T newargs;
1310 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001311 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001312 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001313 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001315 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001316 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001317 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001318 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001319 char_u *s;
1320 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001321 int *old_eval_lavars = eval_lavars_used;
1322 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001323 char_u *tofree1 = NULL;
1324 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001325 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001326 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001327 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001328
1329 if (equal_arrow && !in_vim9script())
1330 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001331
1332 ga_init(&newargs);
1333 ga_init(&newlines);
1334
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 // First, check if this is really a lambda expression. "->" or "=>" must
1336 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001337 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001338 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001339 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001340 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001341 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001342 {
1343 if (types_optional)
1344 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001345 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001348 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001349 if (evaluate)
1350 pnewargs = &newargs;
1351 else
1352 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001353 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001354 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001355 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001356 &varargs, &default_args,
1357 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001358 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001359 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001360 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001361 {
1362 if (types_optional)
1363 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001364 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001365 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001366 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001367 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001368
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001369 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1370 if (ret_type != NULL)
1371 {
1372 ret_type = vim_strsave(ret_type);
1373 tofree2 = ret_type;
1374 }
1375
Bram Moolenaare38eab22019-12-05 21:50:01 +01001376 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001377 if (evaluate)
1378 eval_lavars_used = &eval_lavars;
1379
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380 *arg = skipwhite_and_linebreak(*arg, evalarg);
1381
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001382 // Recognize "{" as the start of a function body.
1383 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001384 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001385 if (evalarg == NULL)
1386 // cannot happen?
1387 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001388 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1389 types_optional ? &argtypes : NULL, varargs,
1390 &default_args, ret_type) == FAIL)
1391 goto errret;
1392 goto theend;
1393 }
1394 if (default_args.ga_len > 0)
1395 {
1396 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001397 goto errret;
1398 }
1399
Bram Moolenaare38eab22019-12-05 21:50:01 +01001400 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001401 start = *arg;
1402 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001403 if (ret == FAIL)
1404 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001405 if (evalarg != NULL)
1406 {
1407 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001408 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001409 evalarg->eval_tofree = NULL;
1410 }
1411
Bram Moolenaar65c44152020-12-24 15:14:01 +01001412 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001413 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001414 *arg = skipwhite_and_linebreak(*arg, evalarg);
1415 if (**arg != '}')
1416 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001417 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001418 goto errret;
1419 }
1420 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422
1423 if (evaluate)
1424 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001425 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001426 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001427 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001428 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001429 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001430
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001431 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 if (fp == NULL)
1433 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001434 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001435 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001436 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001437 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001439 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 if (ga_grow(&newlines, 1) == FAIL)
1441 goto errret;
1442
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001443 // If there are line breaks, we need to split up the string.
1444 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001445 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001446 line_end = end;
1447
1448 // Add "return " before the expression (or the first line).
1449 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001450 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 if (p == NULL)
1452 goto errret;
1453 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1454 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001455 vim_strncpy(p + 7, start, line_end - start);
1456
1457 if (line_end != end)
1458 {
1459 // Add more lines, split by line breaks. Thus is used when a
1460 // lambda with { cmds } is encountered.
1461 while (*line_end == '\n')
1462 {
1463 if (ga_grow(&newlines, 1) == FAIL)
1464 goto errret;
1465 start = line_end + 1;
1466 line_end = vim_strchr(start, '\n');
1467 if (line_end == NULL)
1468 line_end = end;
1469 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1470 vim_strnsave(start, line_end - start);
1471 }
1472 }
1473
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001474 if (strstr((char *)p + 7, "a:") == NULL)
1475 // No a: variables are used for sure.
1476 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477
1478 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001479 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001481 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001482 if (types_optional)
1483 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001484 if (parse_argument_types(fp, &argtypes,
1485 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001486 goto errret;
1487 if (ret_type != NULL)
1488 {
1489 fp->uf_ret_type = parse_type(&ret_type,
1490 &fp->uf_type_list, TRUE);
1491 if (fp->uf_ret_type == NULL)
1492 goto errret;
1493 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001494 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001495 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001496 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001497
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001499 if (current_funccal != NULL && eval_lavars)
1500 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001501 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001502 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001503 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001504 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505
1506#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 if (prof_def_func())
1508 func_do_profile(fp);
1509#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001510 if (sandbox)
1511 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001512 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001513 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1514 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001515 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001517 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001518 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001520 function_using_block_scopes(fp, evalarg->eval_cstack);
1521
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001522 pt->pt_func = fp;
1523 pt->pt_refcount = 1;
1524 rettv->vval.v_partial = pt;
1525 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001526
1527 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001530theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001531 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001532 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001533 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001534 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001535 vim_free(tofree1);
1536 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001537 if (types_optional)
1538 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001539
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001540 return OK;
1541
1542errret:
1543 ga_clear_strings(&newargs);
1544 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001545 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001546 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001547 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001548 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001549 if (fp != NULL)
1550 vim_free(fp->uf_arg_types);
1551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001553 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001554 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001555 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001556 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001557 vim_free(tofree1);
1558 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001559 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 return FAIL;
1561}
1562
1563/*
1564 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1565 * name it contains, otherwise return "name".
1566 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1567 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001568 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1569 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001570 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001571 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 */
1573 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001574deref_func_name(
1575 char_u *name,
1576 int *lenp,
1577 partial_T **partialp,
1578 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001579 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001580 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001581 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582{
1583 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001584 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001585 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001586 char_u *s = NULL;
1587 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001588 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589
1590 if (partialp != NULL)
1591 *partialp = NULL;
1592
1593 cc = name[*lenp];
1594 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001595
Bram Moolenaar71f21932022-01-07 18:20:55 +00001596 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001598 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001600 tv = &v->di_tv;
1601 }
1602 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1603 {
1604 imported_T *import;
1605 char_u *p = name;
1606 int len = *lenp;
1607
1608 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001610 p = name + 2;
1611 len -= 2;
1612 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001613 import = find_imported(p, len, FALSE, NULL);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001614
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001615 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001616 if (import != NULL)
1617 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001618 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001619 if (new_function)
1620 semsg(_(e_redefining_imported_item_str), name);
1621 else
1622 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001623 name[len] = cc;
1624 *lenp = 0;
1625 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001626 }
1627 }
1628
1629 if (tv != NULL)
1630 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001631 if (found_var != NULL)
1632 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001633 if (tv->v_type == VAR_FUNC)
1634 {
1635 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636 {
1637 *lenp = 0;
1638 return (char_u *)""; // just in case
1639 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001640 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001641 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001643
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001644 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001646 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001647
1648 if (pt == NULL)
1649 {
1650 *lenp = 0;
1651 return (char_u *)""; // just in case
1652 }
1653 if (partialp != NULL)
1654 *partialp = pt;
1655 s = partial_name(pt);
1656 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001658
1659 if (s != NULL)
1660 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001661 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001662 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001663 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001664
1665 if (sv != NULL)
1666 *type = sv->sv_type;
1667 }
1668 return s;
1669 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001670 }
1671
1672 return name;
1673}
1674
1675/*
1676 * Give an error message with a function name. Handle <SNR> things.
1677 * "ermsg" is to be passed without translation, use N_() instead of _().
1678 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001679 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680emsg_funcname(char *ermsg, char_u *name)
1681{
Bram Moolenaar54598062022-01-13 12:05:09 +00001682 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683
Bram Moolenaar54598062022-01-13 12:05:09 +00001684 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001686 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687 if (p != name)
1688 vim_free(p);
1689}
1690
1691/*
1692 * Allocate a variable for the result of a function.
1693 * Return OK or FAIL.
1694 */
1695 int
1696get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001697 char_u *name, // name of the function
1698 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001699 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001700 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001701 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001702 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703{
1704 char_u *argp;
1705 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001706 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1707 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001708 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001709 int evaluate = evalarg == NULL
1710 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001711
1712 /*
1713 * Get the arguments.
1714 */
1715 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001716 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1717 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001719 // skip the '(' or ',' and possibly line breaks
1720 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1721
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 if (*argp == ')' || *argp == ',' || *argp == NUL)
1723 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001724 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 {
1726 ret = FAIL;
1727 break;
1728 }
1729 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001730 // The comma should come right after the argument, but this wasn't
1731 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001732 if (vim9script)
1733 {
1734 if (*argp != ',' && *skipwhite(argp) == ',')
1735 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001736 if (evaluate)
1737 semsg(_(e_no_white_space_allowed_before_str_str),
1738 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001739 ret = FAIL;
1740 break;
1741 }
1742 }
1743 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001744 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 if (*argp != ',')
1746 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001747 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1748 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001749 if (evaluate)
1750 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001751 ret = FAIL;
1752 break;
1753 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001755 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001756 if (*argp == ')')
1757 ++argp;
1758 else
1759 ret = FAIL;
1760
1761 if (ret == OK)
1762 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001763 int i = 0;
1764 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765
1766 if (get_vim_var_nr(VV_TESTING))
1767 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001768 // Prepare for calling test_garbagecollect_now(), need to know
1769 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001770 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001771 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001772 for (i = 0; i < argcount; ++i)
1773 if (ga_grow(&funcargs, 1) == OK)
1774 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1775 &argvars[i];
1776 }
1777
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001778 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001779 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001780 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001781 // An error in a builtin function does not return FAIL, but we do
1782 // want to abort further processing if an error was given.
1783 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001784 clear_tv(rettv);
1785 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001786
1787 funcargs.ga_len -= i;
1788 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001789 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790 {
1791 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001792 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001794 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795 }
1796
1797 while (--argcount >= 0)
1798 clear_tv(&argvars[argcount]);
1799
Bram Moolenaar8294d492020-08-10 22:40:56 +02001800 if (in_vim9script())
1801 *arg = argp;
1802 else
1803 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804 return ret;
1805}
1806
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807/*
1808 * Return TRUE if "p" starts with "<SID>" or "s:".
1809 * Only works if eval_fname_script() returned non-zero for "p"!
1810 */
1811 static int
1812eval_fname_sid(char_u *p)
1813{
1814 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1815}
1816
1817/*
1818 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1819 * Change <SNR>123_name() to K_SNR 123_name().
1820 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1821 * (slow).
1822 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001823 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001824fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1825{
1826 int llen;
1827 char_u *fname;
1828 int i;
1829
1830 llen = eval_fname_script(name);
1831 if (llen > 0)
1832 {
1833 fname_buf[0] = K_SPECIAL;
1834 fname_buf[1] = KS_EXTRA;
1835 fname_buf[2] = (int)KE_SNR;
1836 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001837 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001839 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001840 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 else
1842 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001843 sprintf((char *)fname_buf + 3, "%ld_",
1844 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 i = (int)STRLEN(fname_buf);
1846 }
1847 }
1848 if (i + STRLEN(name + llen) < FLEN_FIXED)
1849 {
1850 STRCPY(fname_buf + i, name + llen);
1851 fname = fname_buf;
1852 }
1853 else
1854 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001855 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001857 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 else
1859 {
1860 *tofree = fname;
1861 mch_memmove(fname, fname_buf, (size_t)i);
1862 STRCPY(fname + i, name + llen);
1863 }
1864 }
1865 }
1866 else
1867 fname = name;
1868 return fname;
1869}
1870
1871/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001872 * Find a function "name" in script "sid".
1873 */
1874 static ufunc_T *
1875find_func_with_sid(char_u *name, int sid)
1876{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001877 hashitem_T *hi;
1878 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001879
Bram Moolenaarb8822442022-01-11 15:24:05 +00001880 if (!SCRIPT_ID_VALID(sid))
1881 return NULL; // not in a script
1882
1883 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001884 buffer[0] = K_SPECIAL;
1885 buffer[1] = KS_EXTRA;
1886 buffer[2] = (int)KE_SNR;
1887 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1888 (long)sid, name);
1889 hi = hash_find(&func_hashtab, buffer);
1890 if (!HASHITEM_EMPTY(hi))
1891 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001892 return NULL;
1893}
1894
1895/*
1896 * Find a function "name" in script "sid" prefixing the autoload prefix.
1897 */
1898 static ufunc_T *
1899find_func_with_prefix(char_u *name, int sid)
1900{
1901 hashitem_T *hi;
1902 char_u buffer[200];
1903 scriptitem_T *si;
1904
1905 if (vim_strchr(name, AUTOLOAD_CHAR) != 0)
1906 return NULL; // already has the prefix
1907 if (!SCRIPT_ID_VALID(sid))
1908 return NULL; // not in a script
1909 si = SCRIPT_ITEM(sid);
1910 if (si->sn_autoload_prefix != NULL)
1911 {
1912 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1913 char_u *auto_name;
1914
1915 // An exported function in an autoload script is stored as
1916 // "dir#path#name".
1917 if (len < sizeof(buffer))
1918 auto_name = buffer;
1919 else
1920 auto_name = alloc(len);
1921 if (auto_name != NULL)
1922 {
1923 vim_snprintf((char *)auto_name, len, "%s%s",
1924 si->sn_autoload_prefix, name);
1925 hi = hash_find(&func_hashtab, auto_name);
1926 if (auto_name != buffer)
1927 vim_free(auto_name);
1928 if (!HASHITEM_EMPTY(hi))
1929 return HI2UF(hi);
1930 }
1931 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001932
1933 return NULL;
1934}
1935
1936/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001937 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001938 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001939 * Return NULL for unknown function.
1940 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001941 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001942find_func_even_dead(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943{
1944 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001945 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001946
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001947 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001949 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1950 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001951
Bram Moolenaar95006e32020-08-29 17:47:08 +02001952 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001953 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001954 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001955 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1956 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001957 if (func != NULL)
1958 return func;
1959 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961
Bram Moolenaara26b9702020-04-18 19:53:28 +02001962 hi = hash_find(&func_hashtab,
1963 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001964 if (!HASHITEM_EMPTY(hi))
1965 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001966
Bram Moolenaarb8822442022-01-11 15:24:05 +00001967 // Find autoload function if this is an autoload script.
1968 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1969 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001970}
1971
1972/*
1973 * Find a function by name, return pointer to it in ufuncs.
1974 * "cctx" is passed in a :def function to find imported functions.
1975 * Return NULL for unknown or dead function.
1976 */
1977 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001978find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001979{
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001980 ufunc_T *fp = find_func_even_dead(name, is_global);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001981
1982 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1983 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001984 return NULL;
1985}
1986
1987/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001988 * Return TRUE if "ufunc" is a global function.
1989 */
1990 int
1991func_is_global(ufunc_T *ufunc)
1992{
1993 return ufunc->uf_name[0] != K_SPECIAL;
1994}
1995
1996/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001997 * Copy the function name of "fp" to buffer "buf".
1998 * "buf" must be able to hold the function name plus three bytes.
1999 * Takes care of script-local function names.
2000 */
2001 static void
2002cat_func_name(char_u *buf, ufunc_T *fp)
2003{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002004 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002005 {
2006 STRCPY(buf, "<SNR>");
2007 STRCAT(buf, fp->uf_name + 3);
2008 }
2009 else
2010 STRCPY(buf, fp->uf_name);
2011}
2012
2013/*
2014 * Add a number variable "name" to dict "dp" with value "nr".
2015 */
2016 static void
2017add_nr_var(
2018 dict_T *dp,
2019 dictitem_T *v,
2020 char *name,
2021 varnumber_T nr)
2022{
2023 STRCPY(v->di_key, name);
2024 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2025 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2026 v->di_tv.v_type = VAR_NUMBER;
2027 v->di_tv.v_lock = VAR_FIXED;
2028 v->di_tv.vval.v_number = nr;
2029}
2030
2031/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002032 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002034 static void
2035free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002036{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002037 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002038
2039 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2040 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002041 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002042
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002043 // When garbage collecting a funccall_T may be freed before the
2044 // function that references it, clear its uf_scoped field.
2045 // The function may have been redefined and point to another
2046 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002047 if (fp != NULL && fp->uf_scoped == fc)
2048 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002049 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002050 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002051
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002052 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002053 vim_free(fc);
2054}
2055
2056/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002057 * Free "fc" and what it contains.
2058 * Can be called only when "fc" is kept beyond the period of it called,
2059 * i.e. after cleanup_function_call(fc).
2060 */
2061 static void
2062free_funccal_contents(funccall_T *fc)
2063{
2064 listitem_T *li;
2065
2066 // Free all l: variables.
2067 vars_clear(&fc->l_vars.dv_hashtab);
2068
2069 // Free all a: variables.
2070 vars_clear(&fc->l_avars.dv_hashtab);
2071
2072 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002073 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002074 clear_tv(&li->li_tv);
2075
2076 free_funccal(fc);
2077}
2078
2079/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002080 * Handle the last part of returning from a function: free the local hashtable.
2081 * Unless it is still in use by a closure.
2082 */
2083 static void
2084cleanup_function_call(funccall_T *fc)
2085{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002086 int may_free_fc = fc->fc_refcount <= 0;
2087 int free_fc = TRUE;
2088
Bram Moolenaar6914c642017-04-01 21:21:30 +02002089 current_funccal = fc->caller;
2090
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002091 // Free all l: variables if not referred.
2092 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2093 vars_clear(&fc->l_vars.dv_hashtab);
2094 else
2095 free_fc = FALSE;
2096
2097 // If the a:000 list and the l: and a: dicts are not referenced and
2098 // there is no closure using it, we can free the funccall_T and what's
2099 // in it.
2100 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2101 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002102 else
2103 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002104 int todo;
2105 hashitem_T *hi;
2106 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002107
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002108 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002109
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002110 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002111 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2112 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2113 {
2114 if (!HASHITEM_EMPTY(hi))
2115 {
2116 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002117 di = HI2DI(hi);
2118 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002119 }
2120 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002121 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002122
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002123 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2124 fc->l_varlist.lv_first = NULL;
2125 else
2126 {
2127 listitem_T *li;
2128
2129 free_fc = FALSE;
2130
2131 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002132 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002133 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002134 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002135
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002136 if (free_fc)
2137 free_funccal(fc);
2138 else
2139 {
2140 static int made_copy = 0;
2141
2142 // "fc" is still in use. This can happen when returning "a:000",
2143 // assigning "l:" to a global variable or defining a closure.
2144 // Link "fc" in the list for garbage collection later.
2145 fc->caller = previous_funccal;
2146 previous_funccal = fc;
2147
2148 if (want_garbage_collect)
2149 // If garbage collector is ready, clear count.
2150 made_copy = 0;
2151 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002152 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002153 // We have made a lot of copies, worth 4 Mbyte. This can happen
2154 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002155 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002156 // too much memory.
2157 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002158 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002159 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002160 }
2161}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002162
2163/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002164 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2165 */
2166 static int
2167numbered_function(char_u *name)
2168{
2169 return isdigit(*name)
2170 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2171}
2172
2173/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002174 * There are two kinds of function names:
2175 * 1. ordinary names, function defined with :function or :def
2176 * 2. numbered functions and lambdas
2177 * For the first we only count the name stored in func_hashtab as a reference,
2178 * using function() does not count as a reference, because the function is
2179 * looked up by name.
2180 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002181 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002182func_name_refcount(char_u *name)
2183{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002184 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002185}
2186
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002187/*
2188 * Unreference "fc": decrement the reference count and free it when it
2189 * becomes zero. "fp" is detached from "fc".
2190 * When "force" is TRUE we are exiting.
2191 */
2192 static void
2193funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2194{
2195 funccall_T **pfc;
2196 int i;
2197
2198 if (fc == NULL)
2199 return;
2200
2201 if (--fc->fc_refcount <= 0 && (force || (
2202 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2203 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2204 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2205 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2206 {
2207 if (fc == *pfc)
2208 {
2209 *pfc = fc->caller;
2210 free_funccal_contents(fc);
2211 return;
2212 }
2213 }
2214 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2215 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2216 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2217}
2218
2219/*
2220 * Remove the function from the function hashtable. If the function was
2221 * deleted while it still has references this was already done.
2222 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2223 */
2224 static int
2225func_remove(ufunc_T *fp)
2226{
2227 hashitem_T *hi;
2228
2229 // Return if it was already virtually deleted.
2230 if (fp->uf_flags & FC_DEAD)
2231 return FALSE;
2232
2233 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2234 if (!HASHITEM_EMPTY(hi))
2235 {
2236 // When there is a def-function index do not actually remove the
2237 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002238 // Do remove it when it's a copy.
2239 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002240 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002241 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002242 return FALSE;
2243 }
2244 hash_remove(&func_hashtab, hi);
2245 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002246 return TRUE;
2247 }
2248 return FALSE;
2249}
2250
2251 static void
2252func_clear_items(ufunc_T *fp)
2253{
2254 ga_clear_strings(&(fp->uf_args));
2255 ga_clear_strings(&(fp->uf_def_args));
2256 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002257 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002258 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002259 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002260 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002261
2262 // Increment the refcount of this function to avoid it being freed
2263 // recursively when the partial is freed.
2264 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002265 partial_unref(fp->uf_partial);
2266 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002267 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002268
2269#ifdef FEAT_LUA
2270 if (fp->uf_cb_free != NULL)
2271 {
2272 fp->uf_cb_free(fp->uf_cb_state);
2273 fp->uf_cb_free = NULL;
2274 }
2275
2276 fp->uf_cb_state = NULL;
2277 fp->uf_cb = NULL;
2278#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002279#ifdef FEAT_PROFILE
2280 VIM_CLEAR(fp->uf_tml_count);
2281 VIM_CLEAR(fp->uf_tml_total);
2282 VIM_CLEAR(fp->uf_tml_self);
2283#endif
2284}
2285
2286/*
2287 * Free all things that a function contains. Does not free the function
2288 * itself, use func_free() for that.
2289 * When "force" is TRUE we are exiting.
2290 */
2291 static void
2292func_clear(ufunc_T *fp, int force)
2293{
2294 if (fp->uf_cleared)
2295 return;
2296 fp->uf_cleared = TRUE;
2297
2298 // clear this function
2299 func_clear_items(fp);
2300 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002301 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002302}
2303
2304/*
2305 * Free a function and remove it from the list of functions. Does not free
2306 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002307 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002308 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002309 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002310 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002311func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002312{
2313 // Only remove it when not done already, otherwise we would remove a newer
2314 // version of the function with the same name.
2315 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2316 func_remove(fp);
2317
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002318 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002319 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002320 if (fp->uf_dfunc_idx > 0)
2321 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002322 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002324 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002325 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002326 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002327}
2328
2329/*
2330 * Free all things that a function contains and free the function itself.
2331 * When "force" is TRUE we are exiting.
2332 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002333 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002334func_clear_free(ufunc_T *fp, int force)
2335{
2336 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002337 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2338 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002339 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002340 else
2341 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002342}
2343
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002344/*
2345 * Copy already defined function "lambda" to a new function with name "global".
2346 * This is for when a compiled function defines a global function.
2347 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002348 int
2349copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002350{
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002351 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002352 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002353
2354 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002355 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002356 semsg(_(e_lambda_function_not_found_str), lambda);
2357 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002358 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002359
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002360 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002361 if (fp != NULL)
2362 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002363 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002364 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002365 return FAIL;
2366 }
2367
2368 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2369 if (fp == NULL)
2370 return FAIL;
2371
2372 fp->uf_varargs = ufunc->uf_varargs;
2373 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2374 fp->uf_def_status = ufunc->uf_def_status;
2375 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2376 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2377 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2378 == FAIL
2379 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2380 goto failed;
2381
2382 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2383 : vim_strsave(ufunc->uf_name_exp);
2384 if (ufunc->uf_arg_types != NULL)
2385 {
2386 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2387 if (fp->uf_arg_types == NULL)
2388 goto failed;
2389 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2390 sizeof(type_T *) * fp->uf_args.ga_len);
2391 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002392 if (ufunc->uf_va_name != NULL)
2393 {
2394 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2395 if (fp->uf_va_name == NULL)
2396 goto failed;
2397 }
2398 fp->uf_ret_type = ufunc->uf_ret_type;
2399
2400 fp->uf_refcount = 1;
2401 STRCPY(fp->uf_name, global);
2402 hash_add(&func_hashtab, UF2HIKEY(fp));
2403
2404 // the referenced dfunc_T is now used one more time
2405 link_def_function(fp);
2406
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002407 // Create a partial to store the context of the function where it was
2408 // instantiated. Only needs to be done once. Do this on the original
2409 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002410 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2411 {
2412 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2413
2414 if (pt == NULL)
2415 goto failed;
2416 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002417 {
2418 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002419 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002420 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002421 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002422 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002423 }
2424
2425 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002426
2427failed:
2428 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002429 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002430}
2431
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002432static int funcdepth = 0;
2433
2434/*
2435 * Increment the function call depth count.
2436 * Return FAIL when going over 'maxfuncdepth'.
2437 * Otherwise return OK, must call funcdepth_decrement() later!
2438 */
2439 int
2440funcdepth_increment(void)
2441{
2442 if (funcdepth >= p_mfd)
2443 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002444 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002445 return FAIL;
2446 }
2447 ++funcdepth;
2448 return OK;
2449}
2450
2451 void
2452funcdepth_decrement(void)
2453{
2454 --funcdepth;
2455}
2456
2457/*
2458 * Get the current function call depth.
2459 */
2460 int
2461funcdepth_get(void)
2462{
2463 return funcdepth;
2464}
2465
2466/*
2467 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002468 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002469 * times as funcdepth_increment().
2470 */
2471 void
2472funcdepth_restore(int depth)
2473{
2474 funcdepth = depth;
2475}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002476
2477/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002478 * Call a user function.
2479 */
2480 static void
2481call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002482 ufunc_T *fp, // pointer to function
2483 int argcount, // nr of args
2484 typval_T *argvars, // arguments
2485 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002486 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002487 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002488{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002489 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002490 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 funccall_T *fc;
2492 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002493 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002494 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002495 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496 int i;
2497 int ai;
2498 int islambda = FALSE;
2499 char_u numbuf[NUMBUFLEN];
2500 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002501 typval_T *tv_to_free[MAX_FUNC_ARGS];
2502 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002504 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002506 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507
Bram Moolenaarb2049902021-01-24 12:53:53 +01002508#ifdef FEAT_PROFILE
2509 CLEAR_FIELD(profile_info);
2510#endif
2511
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002512 // If depth of calling is getting too high, don't execute the function.
2513 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515 rettv->v_type = VAR_NUMBER;
2516 rettv->vval.v_number = -1;
2517 return;
2518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002519
Bram Moolenaare38eab22019-12-05 21:50:01 +01002520 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002522 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002523 if (fc == NULL)
2524 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 fc->caller = current_funccal;
2526 current_funccal = fc;
2527 fc->func = fp;
2528 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002530 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2532 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002533 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002534 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002535 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002537 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002538 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002539#ifdef FEAT_PROFILE
2540 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2541#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002542 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002543#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002544 if (do_profiling == PROF_YES)
2545 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002546#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002547 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002548 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002549#ifdef FEAT_PROFILE
2550 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002551 || (caller != NULL && caller->uf_profiling)))
2552 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002553#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002554 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002555 free_funccal(fc);
2556 return;
2557 }
2558
Bram Moolenaar38453522021-11-28 22:00:12 +00002559 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002560
2561 /*
2562 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2563 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2564 * each argument variable and saves a lot of time.
2565 */
2566 /*
2567 * Init l: variables.
2568 */
2569 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2570 if (selfdict != NULL)
2571 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002572 // Set l:self to "selfdict". Use "name" to avoid a warning from
2573 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 v = &fc->fixvar[fixvar_idx++].var;
2575 name = v->di_key;
2576 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002577 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2579 v->di_tv.v_type = VAR_DICT;
2580 v->di_tv.v_lock = 0;
2581 v->di_tv.vval.v_dict = selfdict;
2582 ++selfdict->dv_refcount;
2583 }
2584
2585 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002586 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002587 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588 * Set a:000 to a list with room for the "..." arguments.
2589 */
2590 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002591 if ((fp->uf_flags & FC_NOARGS) == 0)
2592 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002593 (varnumber_T)(argcount >= fp->uf_args.ga_len
2594 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002595 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002596 if ((fp->uf_flags & FC_NOARGS) == 0)
2597 {
2598 // Use "name" to avoid a warning from some compiler that checks the
2599 // destination size.
2600 v = &fc->fixvar[fixvar_idx++].var;
2601 name = v->di_key;
2602 STRCPY(name, "000");
2603 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2604 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2605 v->di_tv.v_type = VAR_LIST;
2606 v->di_tv.v_lock = VAR_FIXED;
2607 v->di_tv.vval.v_list = &fc->l_varlist;
2608 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002609 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2611 fc->l_varlist.lv_lock = VAR_FIXED;
2612
2613 /*
2614 * Set a:firstline to "firstline" and a:lastline to "lastline".
2615 * Set a:name to named arguments.
2616 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002617 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002619 if ((fp->uf_flags & FC_NOARGS) == 0)
2620 {
2621 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002622 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002623 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002624 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002625 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002626 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002627 {
2628 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002629 typval_T def_rettv;
2630 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631
2632 ai = i - fp->uf_args.ga_len;
2633 if (ai < 0)
2634 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002635 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 name = FUNCARG(fp, i);
2637 if (islambda)
2638 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002639
2640 // evaluate named argument default expression
2641 isdefault = ai + fp->uf_def_args.ga_len >= 0
2642 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2643 && argvars[i].vval.v_number == VVAL_NONE));
2644 if (isdefault)
2645 {
2646 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002647
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002648 def_rettv.v_type = VAR_NUMBER;
2649 def_rettv.vval.v_number = -1;
2650
2651 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2652 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002653 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002654 {
2655 default_arg_err = 1;
2656 break;
2657 }
2658 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 }
2660 else
2661 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002662 if ((fp->uf_flags & FC_NOARGS) != 0)
2663 // Bail out if no a: arguments used (in lambda).
2664 break;
2665
Bram Moolenaare38eab22019-12-05 21:50:01 +01002666 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667 sprintf((char *)numbuf, "%d", ai + 1);
2668 name = numbuf;
2669 }
2670 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2671 {
2672 v = &fc->fixvar[fixvar_idx++].var;
2673 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002674 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 }
2676 else
2677 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002678 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679 if (v == NULL)
2680 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002681 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002684 // Note: the values are copied directly to avoid alloc/free.
2685 // "argvars" must have VAR_FIXED for v_lock.
2686 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 v->di_tv.v_lock = VAR_FIXED;
2688
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002689 if (isdefault)
2690 // Need to free this later, no matter where it's stored.
2691 tv_to_free[tv_to_free_len++] = &v->di_tv;
2692
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693 if (addlocal)
2694 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002695 // Named arguments should be accessed without the "a:" prefix in
2696 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002697 copy_tv(&v->di_tv, &v->di_tv);
2698 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002700 else
2701 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702
2703 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2704 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002705 listitem_T *li = &fc->l_listitems[ai];
2706
2707 li->li_tv = argvars[i];
2708 li->li_tv.v_lock = VAR_FIXED;
2709 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 }
2711 }
2712
Bram Moolenaare38eab22019-12-05 21:50:01 +01002713 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002715
2716 if (fp->uf_flags & FC_SANDBOX)
2717 {
2718 using_sandbox = TRUE;
2719 ++sandbox;
2720 }
2721
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002722 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002723 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002724 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002726 ++no_wait_return;
2727 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002729 smsg(_("calling %s"), SOURCING_NAME);
2730 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002732 char_u buf[MSG_BUF_LEN];
2733 char_u numbuf2[NUMBUFLEN];
2734 char_u *tofree;
2735 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002737 msg_puts("(");
2738 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002740 if (i > 0)
2741 msg_puts(", ");
2742 if (argvars[i].v_type == VAR_NUMBER)
2743 msg_outnum((long)argvars[i].vval.v_number);
2744 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002745 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002746 // Do not want errors such as E724 here.
2747 ++emsg_off;
2748 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2749 --emsg_off;
2750 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002752 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002754 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2755 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002757 msg_puts((char *)s);
2758 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002759 }
2760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002762 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002764 msg_puts("\n"); // don't overwrite this either
2765
2766 verbose_leave_scroll();
2767 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768 }
2769#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002770 if (do_profiling == PROF_YES)
2771 profile_may_start_func(&profile_info, fp,
2772 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773#endif
2774
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002775 save_current_sctx = current_sctx;
2776 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 save_did_emsg = did_emsg;
2778 did_emsg = FALSE;
2779
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002780 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2781 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002782 else if (islambda)
2783 {
2784 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2785
2786 // A Lambda always has the command "return {expr}". It is much faster
2787 // to evaluate {expr} directly.
2788 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002789 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002790 --ex_nesting_level;
2791 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002792 else
2793 // call do_cmdline() to execute the lines
2794 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2796
2797 --RedrawingDisabled;
2798
Bram Moolenaare38eab22019-12-05 21:50:01 +01002799 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2801 {
2802 clear_tv(rettv);
2803 rettv->v_type = VAR_NUMBER;
2804 rettv->vval.v_number = -1;
2805 }
2806
2807#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002808 if (do_profiling == PROF_YES)
2809 {
2810 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2811
2812 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2813 profile_may_end_func(&profile_info, fp, caller);
2814 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815#endif
2816
Bram Moolenaare38eab22019-12-05 21:50:01 +01002817 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 if (p_verbose >= 12)
2819 {
2820 ++no_wait_return;
2821 verbose_enter_scroll();
2822
2823 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002824 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002826 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 (long)fc->rettv->vval.v_number);
2828 else
2829 {
2830 char_u buf[MSG_BUF_LEN];
2831 char_u numbuf2[NUMBUFLEN];
2832 char_u *tofree;
2833 char_u *s;
2834
Bram Moolenaare38eab22019-12-05 21:50:01 +01002835 // The value may be very long. Skip the middle part, so that we
2836 // have some idea how it starts and ends. smsg() would always
2837 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 ++emsg_off;
2839 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2840 --emsg_off;
2841 if (s != NULL)
2842 {
2843 if (vim_strsize(s) > MSG_BUF_CLEN)
2844 {
2845 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2846 s = buf;
2847 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002848 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 vim_free(tofree);
2850 }
2851 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002852 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002853
2854 verbose_leave_scroll();
2855 --no_wait_return;
2856 }
2857
Bram Moolenaare31ee862020-01-07 20:59:34 +01002858 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002859 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002860 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861#ifdef FEAT_PROFILE
2862 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002863 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002865 if (using_sandbox)
2866 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002868 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 {
2870 ++no_wait_return;
2871 verbose_enter_scroll();
2872
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002873 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002874 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875
2876 verbose_leave_scroll();
2877 --no_wait_return;
2878 }
2879
2880 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002881 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002882 for (i = 0; i < tv_to_free_len; ++i)
2883 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002884 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002885}
2886
2887/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002888 * Check the argument count for user function "fp".
2889 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2890 */
2891 int
2892check_user_func_argcount(ufunc_T *fp, int argcount)
2893{
2894 int regular_args = fp->uf_args.ga_len;
2895
2896 if (argcount < regular_args - fp->uf_def_args.ga_len)
2897 return FCERR_TOOFEW;
2898 else if (!has_varargs(fp) && argcount > regular_args)
2899 return FCERR_TOOMANY;
2900 return FCERR_UNKNOWN;
2901}
2902
2903/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002904 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002905 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002906 int
2907call_user_func_check(
2908 ufunc_T *fp,
2909 int argcount,
2910 typval_T *argvars,
2911 typval_T *rettv,
2912 funcexe_T *funcexe,
2913 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002914{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002915 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002916
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002917 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2918 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002919 error = check_user_func_argcount(fp, argcount);
2920 if (error != FCERR_UNKNOWN)
2921 return error;
2922 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002923 error = FCERR_DICT;
2924 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002925 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002926 int did_save_redo = FALSE;
2927 save_redo_T save_redo;
2928
2929 /*
2930 * Call the user function.
2931 * Save and restore search patterns, script variables and
2932 * redo buffer.
2933 */
2934 save_search_patterns();
2935 if (!ins_compl_active())
2936 {
2937 saveRedobuff(&save_redo);
2938 did_save_redo = TRUE;
2939 }
2940 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002941 call_user_func(fp, argcount, argvars, rettv, funcexe,
2942 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002943 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2944 // Function was unreferenced while being used, free it now.
2945 func_clear_free(fp, FALSE);
2946 if (did_save_redo)
2947 restoreRedobuff(&save_redo);
2948 restore_search_patterns();
2949 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002950 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002951 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002952}
2953
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002954static funccal_entry_T *funccal_stack = NULL;
2955
2956/*
2957 * Save the current function call pointer, and set it to NULL.
2958 * Used when executing autocommands and for ":source".
2959 */
2960 void
2961save_funccal(funccal_entry_T *entry)
2962{
2963 entry->top_funccal = current_funccal;
2964 entry->next = funccal_stack;
2965 funccal_stack = entry;
2966 current_funccal = NULL;
2967}
2968
2969 void
2970restore_funccal(void)
2971{
2972 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002973 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002974 else
2975 {
2976 current_funccal = funccal_stack->top_funccal;
2977 funccal_stack = funccal_stack->next;
2978 }
2979}
2980
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002981 funccall_T *
2982get_current_funccal(void)
2983{
2984 return current_funccal;
2985}
2986
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002987/*
2988 * Mark all functions of script "sid" as deleted.
2989 */
2990 void
2991delete_script_functions(int sid)
2992{
2993 hashitem_T *hi;
2994 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002995 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002996 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002997 size_t len;
2998
2999 buf[0] = K_SPECIAL;
3000 buf[1] = KS_EXTRA;
3001 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003002 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003003 len = STRLEN(buf);
3004
Bram Moolenaarce658352020-07-31 23:47:12 +02003005 while (todo > 0)
3006 {
3007 todo = func_hashtab.ht_used;
3008 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3009 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003010 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003011 fp = HI2UF(hi);
3012 if (STRNCMP(fp->uf_name, buf, len) == 0)
3013 {
3014 int changed = func_hashtab.ht_changed;
3015
3016 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003017
3018 if (fp->uf_calls > 0)
3019 {
3020 // Function is executing, don't free it but do remove
3021 // it from the hashtable.
3022 if (func_remove(fp))
3023 fp->uf_refcount--;
3024 }
3025 else
3026 {
3027 func_clear(fp, TRUE);
3028 // When clearing a function another function can be
3029 // cleared as a side effect. When that happens start
3030 // over.
3031 if (changed != func_hashtab.ht_changed)
3032 break;
3033 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003034 }
3035 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003036 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003037 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003038}
3039
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003040#if defined(EXITFREE) || defined(PROTO)
3041 void
3042free_all_functions(void)
3043{
3044 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003045 ufunc_T *fp;
3046 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003047 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003048 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049
Bram Moolenaare38eab22019-12-05 21:50:01 +01003050 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003051 while (current_funccal != NULL)
3052 {
3053 clear_tv(current_funccal->rettv);
3054 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003055 if (current_funccal == NULL && funccal_stack != NULL)
3056 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003057 }
3058
Bram Moolenaare38eab22019-12-05 21:50:01 +01003059 // First clear what the functions contain. Since this may lower the
3060 // reference count of a function, it may also free a function and change
3061 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003062 while (todo > 0)
3063 {
3064 todo = func_hashtab.ht_used;
3065 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3066 if (!HASHITEM_EMPTY(hi))
3067 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003068 // clear the def function index now
3069 fp = HI2UF(hi);
3070 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003071 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003072
Bram Moolenaare38eab22019-12-05 21:50:01 +01003073 // Only free functions that are not refcounted, those are
3074 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003075 if (func_name_refcount(fp->uf_name))
3076 ++skipped;
3077 else
3078 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003079 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003080 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003081 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003082 {
3083 skipped = 0;
3084 break;
3085 }
3086 }
3087 --todo;
3088 }
3089 }
3090
Bram Moolenaare38eab22019-12-05 21:50:01 +01003091 // Now actually free the functions. Need to start all over every time,
3092 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003093 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003094 while (func_hashtab.ht_used > skipped)
3095 {
3096 todo = func_hashtab.ht_used;
3097 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003098 if (!HASHITEM_EMPTY(hi))
3099 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003100 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003101 // Only free functions that are not refcounted, those are
3102 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003103 fp = HI2UF(hi);
3104 if (func_name_refcount(fp->uf_name))
3105 ++skipped;
3106 else
3107 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003108 if (func_free(fp, FALSE) == OK)
3109 {
3110 skipped = 0;
3111 break;
3112 }
3113 // did not actually free it
3114 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003115 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003117 }
3118 if (skipped == 0)
3119 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003120
3121 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122}
3123#endif
3124
3125/*
3126 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003127 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3128 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 * "len" is the length of "name", or -1 for NUL terminated.
3130 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003131 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003132builtin_function(char_u *name, int len)
3133{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003134 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135
Bram Moolenaara26b9702020-04-18 19:53:28 +02003136 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003137 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003138 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3139 {
3140 if (name[i] == AUTOLOAD_CHAR)
3141 return FALSE;
3142 if (!eval_isnamec(name[i]))
3143 {
3144 // "name.something" is not a builtin function
3145 if (name[i] == '.')
3146 return FALSE;
3147 break;
3148 }
3149 }
3150 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151}
3152
3153 int
3154func_call(
3155 char_u *name,
3156 typval_T *args,
3157 partial_T *partial,
3158 dict_T *selfdict,
3159 typval_T *rettv)
3160{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003161 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162 listitem_T *item;
3163 typval_T argv[MAX_FUNC_ARGS + 1];
3164 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 int r = 0;
3166
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003167 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003168 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003169 {
3170 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3171 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003172 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003173 break;
3174 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003175 // Make a copy of each argument. This is needed to be able to set
3176 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 copy_tv(&item->li_tv, &argv[argc++]);
3178 }
3179
3180 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003181 {
3182 funcexe_T funcexe;
3183
Bram Moolenaara80faa82020-04-12 19:37:17 +02003184 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003185 funcexe.fe_firstline = curwin->w_cursor.lnum;
3186 funcexe.fe_lastline = curwin->w_cursor.lnum;
3187 funcexe.fe_evaluate = TRUE;
3188 funcexe.fe_partial = partial;
3189 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003190 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3191 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192
Bram Moolenaare38eab22019-12-05 21:50:01 +01003193 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 while (argc > 0)
3195 clear_tv(&argv[--argc]);
3196
3197 return r;
3198}
3199
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003200static int callback_depth = 0;
3201
3202 int
3203get_callback_depth(void)
3204{
3205 return callback_depth;
3206}
3207
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003208/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003209 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003210 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003211 */
3212 int
3213call_callback(
3214 callback_T *callback,
3215 int len, // length of "name" or -1 to use strlen()
3216 typval_T *rettv, // return value goes here
3217 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003218 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003219 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003220{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003221 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003222 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003223
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003224 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3225 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003226 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003227 funcexe.fe_evaluate = TRUE;
3228 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003229 ++callback_depth;
3230 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3231 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003232
3233 // When a :def function was called that uses :try an error would be turned
3234 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003235 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003236 {
3237 need_rethrow = FALSE;
3238 handle_did_throw();
3239 }
3240
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003241 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003242}
3243
3244/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003245 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003246 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003247 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3248 */
3249 varnumber_T
3250call_callback_retnr(
3251 callback_T *callback,
3252 int argcount, // number of "argvars"
3253 typval_T *argvars) // vars for arguments, must have "argcount"
3254 // PLUS ONE elements!
3255{
3256 typval_T rettv;
3257 varnumber_T retval;
3258
3259 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003260 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003261
3262 retval = tv_get_number_chk(&rettv, NULL);
3263 clear_tv(&rettv);
3264 return retval;
3265}
3266
3267/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 * Give an error message for the result of a function.
3269 * Nothing if "error" is FCERR_NONE.
3270 */
3271 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003272user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003273{
3274 switch (error)
3275 {
3276 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003277 if (funcexe->fe_found_var)
3278 semsg(_(e_not_callable_type_str), name);
3279 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003280 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003281 break;
3282 case FCERR_NOTMETHOD:
3283 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003284 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285 break;
3286 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003287 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 break;
3289 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003290 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003291 break;
3292 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003293 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003294 break;
3295 case FCERR_SCRIPT:
3296 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003297 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003298 break;
3299 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003300 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3301 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003302 break;
3303 }
3304}
3305
3306/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003308 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 * Return FAIL when the function can't be called, OK otherwise.
3310 * Also returns OK when an error was encountered while executing the function.
3311 */
3312 int
3313call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003314 char_u *funcname, // name of the function
3315 int len, // length of "name" or -1 to use strlen()
3316 typval_T *rettv, // return value goes here
3317 int argcount_in, // number of "argvars"
3318 typval_T *argvars_in, // vars for arguments, must have "argcount"
3319 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003320 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321{
3322 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003323 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003324 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003325 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003326 char_u fname_buf[FLEN_FIXED + 1];
3327 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003328 char_u *fname = NULL;
3329 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 int argcount = argcount_in;
3331 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003332 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003333 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003334 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003336 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003337 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003338 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003339 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003341 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3342 // even when call_func() returns FAIL.
3343 rettv->v_type = VAR_UNKNOWN;
3344
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003345 if (partial != NULL)
3346 fp = partial->pt_func;
3347 if (fp == NULL)
3348 {
3349 // Make a copy of the name, if it comes from a funcref variable it
3350 // could be changed or deleted in the called function.
3351 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3352 if (name == NULL)
3353 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003355 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3356 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003358 if (funcexe->fe_doesrange != NULL)
3359 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360
3361 if (partial != NULL)
3362 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003363 // When the function has a partial with a dict and there is a dict
3364 // argument, use the dict argument. That is backwards compatible.
3365 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003366 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003367 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003368 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 {
3370 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003371 {
3372 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3373 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003374 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003375 goto theend;
3376 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003378 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003379 for (i = 0; i < argcount_in; ++i)
3380 argv[i + argv_clear] = argvars_in[i];
3381 argvars = argv;
3382 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003383
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003384 if (funcexe->fe_check_type != NULL
3385 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003386 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003387 // Now funcexe->fe_check_type is missing the added arguments,
3388 // make a copy of the type with the correction.
3389 check_type = *funcexe->fe_check_type;
3390 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003391 check_type.tt_args = check_type_args;
3392 CLEAR_FIELD(check_type_args);
3393 for (i = 0; i < check_type.tt_argcount; ++i)
3394 check_type_args[i + partial->pt_argc] =
3395 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003396 check_type.tt_argcount += partial->pt_argc;
3397 check_type.tt_min_argcount += partial->pt_argc;
3398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399 }
3400 }
3401
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003402 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3403 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003404 {
3405 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003406 if (check_argument_types(funcexe->fe_check_type,
3407 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003408 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003409 error = FCERR_OTHER;
3410 }
3411
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003412 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003413 {
3414 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003415 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416
Bram Moolenaar333894b2020-08-01 18:53:07 +02003417 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003418 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003419 {
3420 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003422 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423
Bram Moolenaare38eab22019-12-05 21:50:01 +01003424 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003426 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003428 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 {
3430 /*
3431 * User defined function.
3432 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003433 if (fp == NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003434 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435
Bram Moolenaare38eab22019-12-05 21:50:01 +01003436 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003437 if (fp == NULL
3438 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003439 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 && !aborting())
3441 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003442 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003443 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003445 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003446 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003448 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003449 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003451 if (fp == NULL)
3452 {
3453 char_u *p = untrans_function_name(rfname);
3454
3455 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003456 // Don't do this if the name starts with "s:".
3457 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003458 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003459 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003461 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003462 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003463#ifdef FEAT_LUA
3464 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3465 {
3466 cfunc_T cb = fp->uf_cb;
3467
3468 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3469 }
3470#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003471 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003473 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003474 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003475 argcount = funcexe->fe_argv_func(argcount, argvars,
3476 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003477
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003478 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003479 {
3480 // Method call: base->Method()
3481 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003482 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003483 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003484 argvars = argv;
3485 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003486 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003487
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003488 error = call_user_func_check(fp, argcount, argvars, rettv,
3489 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 }
3491 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003492 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003493 {
3494 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003495 * expr->method(): Find the method name in the table, call its
3496 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003497 */
3498 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003499 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003500 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 else
3502 {
3503 /*
3504 * Find the function name in the table, call its implementation.
3505 */
3506 error = call_internal_func(fname, argcount, argvars, rettv);
3507 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003508
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 /*
3510 * The function call (or "FuncUndefined" autocommand sequence) might
3511 * have been aborted by an error, an interrupt, or an explicitly thrown
3512 * exception that has not been caught so far. This situation can be
3513 * tested for by calling aborting(). For an error in an internal
3514 * function or for the "E132" error in call_user_func(), however, the
3515 * throw point at which the "force_abort" flag (temporarily reset by
3516 * emsg()) is normally updated has not been reached yet. We need to
3517 * update that flag first to make aborting() reliable.
3518 */
3519 update_force_abort();
3520 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003521 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003522 ret = OK;
3523
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003524theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003525 /*
3526 * Report an error unless the argument evaluation or function call has been
3527 * cancelled due to an aborting error, an interrupt, or an exception.
3528 */
3529 if (!aborting())
3530 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003531 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 }
3533
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003534 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003536 clear_tv(&argv[--argv_clear + argv_base]);
3537
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538 vim_free(tofree);
3539 vim_free(name);
3540
3541 return ret;
3542}
3543
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003544 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003545printable_func_name(ufunc_T *fp)
3546{
3547 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3548}
3549
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003551 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 */
3553 static void
3554list_func_head(ufunc_T *fp, int indent)
3555{
3556 int j;
3557
3558 msg_start();
3559 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003560 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003561 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003562 msg_puts("def ");
3563 else
3564 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003565 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566 msg_putchar('(');
3567 for (j = 0; j < fp->uf_args.ga_len; ++j)
3568 {
3569 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003570 msg_puts(", ");
3571 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003572 if (fp->uf_arg_types != NULL)
3573 {
3574 char *tofree;
3575
3576 msg_puts(": ");
3577 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3578 vim_free(tofree);
3579 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003580 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3581 {
3582 msg_puts(" = ");
3583 msg_puts(((char **)(fp->uf_def_args.ga_data))
3584 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3585 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 }
3587 if (fp->uf_varargs)
3588 {
3589 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003590 msg_puts(", ");
3591 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003593 if (fp->uf_va_name != NULL)
3594 {
3595 if (j)
3596 msg_puts(", ");
3597 msg_puts("...");
3598 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003599 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003600 {
3601 char *tofree;
3602
3603 msg_puts(": ");
3604 msg_puts(type_name(fp->uf_va_type, &tofree));
3605 vim_free(tofree);
3606 }
3607 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003609
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003610 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003611 {
3612 if (fp->uf_ret_type != &t_void)
3613 {
3614 char *tofree;
3615
3616 msg_puts(": ");
3617 msg_puts(type_name(fp->uf_ret_type, &tofree));
3618 vim_free(tofree);
3619 }
3620 }
3621 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003622 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003623 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003624 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003626 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003627 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003628 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 msg_clr_eos();
3630 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003631 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003632}
3633
3634/*
3635 * Get a function name, translating "<SID>" and "<SNR>".
3636 * Also handles a Funcref in a List or Dictionary.
3637 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003638 * Set "*is_global" to TRUE when the function must be global, unless
3639 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640 * flags:
3641 * TFN_INT: internal function name OK
3642 * TFN_QUIET: be quiet
3643 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003644 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645 * Advances "pp" to just after the function name (if no error).
3646 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003647 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648trans_function_name(
3649 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003650 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003651 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003653 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003654 partial_T **partial, // return: partial of a FuncRef
3655 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003656{
3657 char_u *name = NULL;
3658 char_u *start;
3659 char_u *end;
3660 int lead;
3661 char_u sid_buf[20];
3662 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003663 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003665 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003666
3667 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003668 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 start = *pp;
3670
Bram Moolenaare38eab22019-12-05 21:50:01 +01003671 // Check for hard coded <SNR>: already translated function ID (from a user
3672 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3674 && (*pp)[2] == (int)KE_SNR)
3675 {
3676 *pp += 3;
3677 len = get_id_len(pp) + 3;
3678 return vim_strnsave(start, len);
3679 }
3680
Bram Moolenaare38eab22019-12-05 21:50:01 +01003681 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3682 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 lead = eval_fname_script(start);
3684 if (lead > 2)
3685 start += lead;
3686
Bram Moolenaare38eab22019-12-05 21:50:01 +01003687 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003688 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 lead > 2 ? 0 : FNE_CHECK_START);
3690 if (end == start)
3691 {
3692 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003693 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 goto theend;
3695 }
3696 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3697 {
3698 /*
3699 * Report an invalid expression in braces, unless the expression
3700 * evaluation has been cancelled due to an aborting error, an
3701 * interrupt, or an exception.
3702 */
3703 if (!aborting())
3704 {
3705 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003706 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 }
3708 else
3709 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3710 goto theend;
3711 }
3712
3713 if (lv.ll_tv != NULL)
3714 {
3715 if (fdp != NULL)
3716 {
3717 fdp->fd_dict = lv.ll_dict;
3718 fdp->fd_newkey = lv.ll_newkey;
3719 lv.ll_newkey = NULL;
3720 fdp->fd_di = lv.ll_di;
3721 }
3722 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3723 {
3724 name = vim_strsave(lv.ll_tv->vval.v_string);
3725 *pp = end;
3726 }
3727 else if (lv.ll_tv->v_type == VAR_PARTIAL
3728 && lv.ll_tv->vval.v_partial != NULL)
3729 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003730 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003731 *pp = end;
3732 if (partial != NULL)
3733 *partial = lv.ll_tv->vval.v_partial;
3734 }
3735 else
3736 {
3737 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3738 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003739 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003740 else
3741 *pp = end;
3742 name = NULL;
3743 }
3744 goto theend;
3745 }
3746
3747 if (lv.ll_name == NULL)
3748 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003749 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 *pp = end;
3751 goto theend;
3752 }
3753
Bram Moolenaare38eab22019-12-05 21:50:01 +01003754 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 if (lv.ll_exp_name != NULL)
3756 {
3757 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003758 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003759 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 if (name == lv.ll_exp_name)
3761 name = NULL;
3762 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003763 else if (lv.ll_sid > 0)
3764 {
3765 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3766 int cc = *lv.ll_name_end;
3767
3768 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3769 *lv.ll_name_end = NUL;
3770 if (si->sn_autoload_prefix != NULL)
3771 {
3772 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3773 }
3774 else
3775 {
3776 sid_buf[0] = K_SPECIAL;
3777 sid_buf[1] = KS_EXTRA;
3778 sid_buf[2] = (int)KE_SNR;
3779 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
3780 "%ld_", (long)current_sctx.sc_sid);
3781 name = concat_str(sid_buf, lv.ll_name);
3782 }
3783 *lv.ll_name_end = cc;
3784 *pp = end;
3785 goto theend;
3786 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003787 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 {
3789 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003790 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003791 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 if (name == *pp)
3793 name = NULL;
3794 }
3795 if (name != NULL)
3796 {
3797 name = vim_strsave(name);
3798 *pp = end;
3799 if (STRNCMP(name, "<SNR>", 5) == 0)
3800 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003801 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802 name[0] = K_SPECIAL;
3803 name[1] = KS_EXTRA;
3804 name[2] = (int)KE_SNR;
3805 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3806 }
3807 goto theend;
3808 }
3809
3810 if (lv.ll_exp_name != NULL)
3811 {
3812 len = (int)STRLEN(lv.ll_exp_name);
3813 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3814 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3815 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003816 // When there was "s:" already or the name expanded to get a
3817 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 lv.ll_name += 2;
3819 len -= 2;
3820 lead = 2;
3821 }
3822 }
3823 else
3824 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003825 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003827 {
3828 if (is_global != NULL && lv.ll_name[0] == 'g')
3829 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003831 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 len = (int)(end - lv.ll_name);
3833 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003834 if (len <= 0)
3835 {
3836 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003837 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003838 goto theend;
3839 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003841 // In Vim9 script a user function is script-local by default, unless it
3842 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003843 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003844 if (vim9script)
3845 {
3846 char_u *p;
3847
3848 // SomeScript#func() is a global function.
3849 for (p = start; *p != NUL && *p != '('; ++p)
3850 if (*p == AUTOLOAD_CHAR)
3851 vim9script = FALSE;
3852 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003853
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 /*
3855 * Copy the function name to allocated memory.
3856 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3857 * Accept <SNR>123_name() outside a script.
3858 */
3859 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003860 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003861 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003862 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003863 if (!vim9script)
3864 lead = 3;
3865 if (vim9script || (lv.ll_exp_name != NULL
3866 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867 || eval_fname_sid(*pp))
3868 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003869 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003870 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003872 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 goto theend;
3874 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003875 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003876 if (vim9script)
3877 extra = 3 + (int)STRLEN(sid_buf);
3878 else
3879 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003880 }
3881 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003882 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3883 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003884 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003885 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003886 goto theend;
3887 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003888 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003889 {
3890 char_u *cp = vim_strchr(lv.ll_name, ':');
3891
3892 if (cp != NULL && cp < end)
3893 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003894 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895 goto theend;
3896 }
3897 }
3898
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003899 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003900 if (name != NULL)
3901 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003902 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003903 {
3904 name[0] = K_SPECIAL;
3905 name[1] = KS_EXTRA;
3906 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003907 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003908 STRCPY(name + 3, sid_buf);
3909 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003910 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3911 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003912 }
3913 *pp = end;
3914
3915theend:
3916 clear_lval(&lv);
3917 return name;
3918}
3919
3920/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003921 * Assuming "name" is the result of trans_function_name() and it was prefixed
3922 * to use the script-local name, return the unmodified name (points into
3923 * "name"). Otherwise return NULL.
3924 * This can be used to first search for a script-local function and fall back
3925 * to the global function if not found.
3926 */
3927 char_u *
3928untrans_function_name(char_u *name)
3929{
3930 char_u *p;
3931
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003932 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003933 {
3934 p = vim_strchr(name, '_');
3935 if (p != NULL)
3936 return p + 1;
3937 }
3938 return NULL;
3939}
3940
3941/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003942 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3943 * current script ID and returns the expanded function name. The caller should
3944 * free the returned name. If not called from a script context or the function
3945 * name doesn't start with these prefixes, then returns NULL.
3946 * This doesn't check whether the script-local function exists or not.
3947 */
3948 char_u *
3949get_scriptlocal_funcname(char_u *funcname)
3950{
3951 char sid_buf[25];
3952 int off;
3953 char_u *newname;
3954
3955 if (funcname == NULL)
3956 return NULL;
3957
3958 if (STRNCMP(funcname, "s:", 2) != 0
3959 && STRNCMP(funcname, "<SID>", 5) != 0)
3960 // The function name is not a script-local function name
3961 return NULL;
3962
3963 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3964 {
3965 emsg(_(e_using_sid_not_in_script_context));
3966 return NULL;
3967 }
3968 // Expand s: prefix into <SNR>nr_<name>
3969 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3970 (long)current_sctx.sc_sid);
3971 off = *funcname == 's' ? 2 : 5;
3972 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3973 if (newname == NULL)
3974 return NULL;
3975 STRCPY(newname, sid_buf);
3976 STRCAT(newname, funcname + off);
3977
3978 return newname;
3979}
3980
3981/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003982 * Call trans_function_name(), except that a lambda is returned as-is.
3983 * Returns the name in allocated memory.
3984 */
3985 char_u *
3986save_function_name(
3987 char_u **name,
3988 int *is_global,
3989 int skip,
3990 int flags,
3991 funcdict_T *fudi)
3992{
3993 char_u *p = *name;
3994 char_u *saved;
3995
3996 if (STRNCMP(p, "<lambda>", 8) == 0)
3997 {
3998 p += 8;
3999 (void)getdigits(&p);
4000 saved = vim_strnsave(*name, p - *name);
4001 if (fudi != NULL)
4002 CLEAR_POINTER(fudi);
4003 }
4004 else
4005 saved = trans_function_name(&p, is_global, skip,
4006 flags, fudi, NULL, NULL);
4007 *name = p;
4008 return saved;
4009}
4010
4011/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004012 * List functions. When "regmatch" is NULL all of then.
4013 * Otherwise functions matching "regmatch".
4014 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004015 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004016list_functions(regmatch_T *regmatch)
4017{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004018 int changed = func_hashtab.ht_changed;
4019 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004020 hashitem_T *hi;
4021
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004022 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004023 {
4024 if (!HASHITEM_EMPTY(hi))
4025 {
4026 ufunc_T *fp = HI2UF(hi);
4027
4028 --todo;
4029 if ((fp->uf_flags & FC_DEAD) == 0
4030 && (regmatch == NULL
4031 ? !message_filtered(fp->uf_name)
4032 && !func_name_refcount(fp->uf_name)
4033 : !isdigit(*fp->uf_name)
4034 && vim_regexec(regmatch, fp->uf_name, 0)))
4035 {
4036 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004037 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004038 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004039 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004040 return;
4041 }
4042 }
4043 }
4044 }
4045}
4046
4047/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004048 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004049 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4050 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004051 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004052 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004054 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004055define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004057 int j;
4058 int c;
4059 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004060 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004061 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 char_u *p;
4063 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004064 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 char_u *line_arg = NULL;
4066 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004067 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004068 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 garray_T newlines;
4070 int varargs = FALSE;
4071 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004072 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004073 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004074 int fp_allocated = FALSE;
4075 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004076 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 dictitem_T *v;
4078 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004079 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004082 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004083 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004084 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085
4086 /*
4087 * ":function" without argument: list functions.
4088 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004089 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090 {
4091 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004092 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004093 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004094 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095 }
4096
4097 /*
4098 * ":function /pat": list functions matching pattern.
4099 */
4100 if (*eap->arg == '/')
4101 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004102 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103 if (!eap->skip)
4104 {
4105 regmatch_T regmatch;
4106
4107 c = *p;
4108 *p = NUL;
4109 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4110 *p = c;
4111 if (regmatch.regprog != NULL)
4112 {
4113 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004114 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115 vim_regfree(regmatch.regprog);
4116 }
4117 }
4118 if (*p == '/')
4119 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004120 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004121 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004122 }
4123
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004124 ga_init(&newargs);
4125 ga_init(&argtypes);
4126 ga_init(&default_args);
4127
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128 /*
4129 * Get the function name. There are these situations:
4130 * func normal function name
4131 * "name" == func, "fudi.fd_dict" == NULL
4132 * dict.func new dictionary entry
4133 * "name" == NULL, "fudi.fd_dict" set,
4134 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4135 * dict.func existing dict entry with a Funcref
4136 * "name" == func, "fudi.fd_dict" set,
4137 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4138 * dict.func existing dict entry that's not a Funcref
4139 * "name" == NULL, "fudi.fd_dict" set,
4140 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4141 * s:func script-local function name
4142 * g:func global function name, same as "func"
4143 */
4144 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004145 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004146 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004147 // nested function, argument is (args).
4148 paren = TRUE;
4149 CLEAR_FIELD(fudi);
4150 }
4151 else
4152 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004153 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004154 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004155 paren = (vim_strchr(p, '(') != NULL);
4156 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004157 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004158 /*
4159 * Return on an invalid expression in braces, unless the expression
4160 * evaluation has been cancelled due to an aborting error, an
4161 * interrupt, or an exception.
4162 */
4163 if (!aborting())
4164 {
4165 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004166 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004167 vim_free(fudi.fd_newkey);
4168 return NULL;
4169 }
4170 else
4171 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004173
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004174 // For "export def FuncName()" in an autoload script the function name
4175 // is stored with the legacy autoload name "dir#script#FuncName" so
4176 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004177 if (is_export && name != NULL)
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004178 name = may_prefix_autoload(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 }
4180
Bram Moolenaare38eab22019-12-05 21:50:01 +01004181 // An error in a function call during evaluation of an expression in magic
4182 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183 saved_did_emsg = did_emsg;
4184 did_emsg = FALSE;
4185
4186 /*
4187 * ":function func" with only function name: list function.
4188 */
4189 if (!paren)
4190 {
4191 if (!ends_excmd(*skipwhite(p)))
4192 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004193 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 goto ret_free;
4195 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004196 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 if (eap->nextcmd != NULL)
4198 *p = NUL;
4199 if (!eap->skip && !got_int)
4200 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004201 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004202 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4203 {
4204 char_u *up = untrans_function_name(name);
4205
4206 // With Vim9 script the name was made script-local, if not
4207 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004208 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004209 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004210 }
4211
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004212 if (fp != NULL)
4213 {
4214 list_func_head(fp, TRUE);
4215 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4216 {
4217 if (FUNCLINE(fp, j) == NULL)
4218 continue;
4219 msg_putchar('\n');
4220 msg_outnum((long)(j + 1));
4221 if (j < 9)
4222 msg_putchar(' ');
4223 if (j < 99)
4224 msg_putchar(' ');
4225 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004226 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 ui_breakcheck();
4228 }
4229 if (!got_int)
4230 {
4231 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004232 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004233 msg_puts(" enddef");
4234 else
4235 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004236 }
4237 }
4238 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004239 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240 }
4241 goto ret_free;
4242 }
4243
4244 /*
4245 * ":function name(arg1, arg2)" Define function.
4246 */
4247 p = skipwhite(p);
4248 if (*p != '(')
4249 {
4250 if (!eap->skip)
4251 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004252 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004253 goto ret_free;
4254 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004255 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256 if (vim_strchr(p, '(') != NULL)
4257 p = vim_strchr(p, '(');
4258 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004260 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4261 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004262 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004263 goto ret_free;
4264 }
4265
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004266 // In Vim9 script only global functions can be redefined.
4267 if (vim9script && eap->forceit && !is_global)
4268 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004269 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004270 goto ret_free;
4271 }
4272
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004273 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274
Bram Moolenaar04b12692020-05-04 23:24:44 +02004275 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004277 // Check the name of the function. Unless it's a dictionary function
4278 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279 if (name != NULL)
4280 arg = name;
4281 else
4282 arg = fudi.fd_newkey;
4283 if (arg != NULL && (fudi.fd_di == NULL
4284 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4285 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4286 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004287 char_u *name_base = arg;
4288 int i;
4289
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004291 {
4292 name_base = vim_strchr(arg, '_');
4293 if (name_base == NULL)
4294 name_base = arg + 3;
4295 else
4296 ++name_base;
4297 }
4298 for (i = 0; name_base[i] != NUL && (i == 0
4299 ? eval_isnamec1(name_base[i])
4300 : eval_isnamec(name_base[i])); ++i)
4301 ;
4302 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004303 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004304
4305 // In Vim9 script a function cannot have the same name as a
4306 // variable.
4307 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004308 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4309 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004310 + EVAL_VAR_NO_FUNC) == OK)
4311 {
4312 semsg(_(e_redefining_script_item_str), name_base);
4313 goto ret_free;
4314 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004316 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004318 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004319 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004320 goto ret_free;
4321 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 }
4323
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004324 // This may get more lines and make the pointers into the first line
4325 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004326 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004327 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004328 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004329 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004330 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004332 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004334 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004336 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004337 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004338 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004339 if (*p != ':')
4340 {
4341 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4342 p = skipwhite(p);
4343 }
4344 else if (!IS_WHITE_OR_NUL(p[1]))
4345 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004346 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004347 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004348 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004349 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004350 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004351 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004352 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004353 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004354 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004355 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004356 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004357 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004358 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004360 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004362 else
4363 // find extra arguments "range", "dict", "abort" and "closure"
4364 for (;;)
4365 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004366 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004367 p = skipwhite(p);
4368 if (STRNCMP(p, "range", 5) == 0)
4369 {
4370 flags |= FC_RANGE;
4371 p += 5;
4372 }
4373 else if (STRNCMP(p, "dict", 4) == 0)
4374 {
4375 flags |= FC_DICT;
4376 p += 4;
4377 }
4378 else if (STRNCMP(p, "abort", 5) == 0)
4379 {
4380 flags |= FC_ABORT;
4381 p += 5;
4382 }
4383 else if (STRNCMP(p, "closure", 7) == 0)
4384 {
4385 flags |= FC_CLOSURE;
4386 p += 7;
4387 if (current_funccal == NULL)
4388 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004389 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004390 name == NULL ? (char_u *)"" : name);
4391 goto erret;
4392 }
4393 }
4394 else
4395 break;
4396 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397
Bram Moolenaare38eab22019-12-05 21:50:01 +01004398 // When there is a line break use what follows for the function body.
4399 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 if (*p == '\n')
4401 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004402 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004403 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4404 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004405 && !(VIM_ISWHITE(*whitep) && *p == '#'
4406 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004407 && !eap->skip
4408 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004409 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410
4411 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004412 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4413 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414 */
4415 if (KeyTyped)
4416 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004417 // Check if the function already exists, don't let the user type the
4418 // whole function before telling him it doesn't work! For a script we
4419 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 if (!eap->skip && !eap->forceit)
4421 {
4422 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004423 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004424 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004425 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426 }
4427
4428 if (!eap->skip && did_emsg)
4429 goto erret;
4430
Bram Moolenaare38eab22019-12-05 21:50:01 +01004431 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004432 cmdline_row = msg_row;
4433 }
4434
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004435 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004436 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004437
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004438 // Do not define the function when getting the body fails and when
4439 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004440 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004441 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 goto erret;
4443
4444 /*
4445 * If there are no errors, add the function
4446 */
4447 if (fudi.fd_dict == NULL)
4448 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004449 hashtab_T *ht;
4450
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004451 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4453 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004454 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 goto erret;
4456 }
4457
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004458 fp = find_func_even_dead(name, is_global);
Bram Moolenaareef21022020-08-01 22:16:43 +02004459 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004460 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004461 char_u *uname = untrans_function_name(name);
4462
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004463 import = find_imported(uname == NULL ? name : uname, 0, FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004464 }
4465
4466 if (fp != NULL || import != NULL)
4467 {
4468 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004469
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004470 // Function can be replaced with "function!" and when sourcing the
4471 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004472 // A name that is used by an import can not be overruled.
4473 if (import != NULL
4474 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004475 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004476 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004478 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004479 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004480 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004481 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004482 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483 goto erret;
4484 }
4485 if (fp->uf_calls > 0)
4486 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004487 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004488 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 goto erret;
4490 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004491 if (fp->uf_refcount > 1)
4492 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004493 // This function is referenced somewhere, don't redefine it but
4494 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004495 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004496 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004497 fp = NULL;
4498 overwrite = TRUE;
4499 }
4500 else
4501 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004502 char_u *exp_name = fp->uf_name_exp;
4503
4504 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004505 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004506 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004507 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004508 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004509 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004510#ifdef FEAT_PROFILE
4511 fp->uf_profiling = FALSE;
4512 fp->uf_prof_initialized = FALSE;
4513#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004514 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004515 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 }
4517 }
4518 else
4519 {
4520 char numbuf[20];
4521
4522 fp = NULL;
4523 if (fudi.fd_newkey == NULL && !eap->forceit)
4524 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004525 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004526 goto erret;
4527 }
4528 if (fudi.fd_di == NULL)
4529 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004530 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004531 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532 goto erret;
4533 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004534 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004535 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 goto erret;
4537
Bram Moolenaare38eab22019-12-05 21:50:01 +01004538 // Give the function a sequential number. Can only be used with a
4539 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004540 vim_free(name);
4541 sprintf(numbuf, "%d", ++func_nr);
4542 name = vim_strsave((char_u *)numbuf);
4543 if (name == NULL)
4544 goto erret;
4545 }
4546
4547 if (fp == NULL)
4548 {
4549 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4550 {
4551 int slen, plen;
4552 char_u *scriptname;
4553
Bram Moolenaare38eab22019-12-05 21:50:01 +01004554 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004556 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557 {
4558 scriptname = autoload_name(name);
4559 if (scriptname != NULL)
4560 {
4561 p = vim_strchr(scriptname, '/');
4562 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004563 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004564 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004565 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004566 j = OK;
4567 vim_free(scriptname);
4568 }
4569 }
4570 if (j == FAIL)
4571 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004572 linenr_T save_lnum = SOURCING_LNUM;
4573
4574 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004575 semsg(_(e_function_name_does_not_match_script_file_name_str),
4576 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004577 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578 goto erret;
4579 }
4580 }
4581
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004582 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 if (fp == NULL)
4584 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004585 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004586
4587 if (fudi.fd_dict != NULL)
4588 {
4589 if (fudi.fd_di == NULL)
4590 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004591 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4593 if (fudi.fd_di == NULL)
4594 {
4595 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004596 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004597 goto erret;
4598 }
4599 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4600 {
4601 vim_free(fudi.fd_di);
4602 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004603 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 goto erret;
4605 }
4606 }
4607 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004608 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 clear_tv(&fudi.fd_di->di_tv);
4610 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004611 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004612
Bram Moolenaare38eab22019-12-05 21:50:01 +01004613 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614 flags |= FC_DICT;
4615 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616 }
4617 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004618 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004619 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004620 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004621
4622 if (eap->cmdidx == CMD_def)
4623 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004624 int lnum_save = SOURCING_LNUM;
4625 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004626
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004627 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004628
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004629 // error messages are for the first function line
4630 SOURCING_LNUM = sourcing_lnum_top;
4631
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004632 // The function may use script variables from the context.
4633 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004634
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004635 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004636 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004637 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004638 free_fp = fp_allocated;
4639 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004640 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004641 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004642
4643 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004644 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004645 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004646 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004647 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004648 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004649 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004650 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004651 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004652 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004653 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004654
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004655 if (fp_allocated)
4656 {
4657 // insert the new function in the function list
4658 set_ufunc_name(fp, name);
4659 if (overwrite)
4660 {
4661 hi = hash_find(&func_hashtab, name);
4662 hi->hi_key = UF2HIKEY(fp);
4663 }
4664 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4665 {
4666 free_fp = TRUE;
4667 goto erret;
4668 }
4669 fp->uf_refcount = 1;
4670 }
4671
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004673 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004674 if ((flags & FC_CLOSURE) != 0)
4675 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004676 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004677 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004678 }
4679 else
4680 fp->uf_scoped = NULL;
4681
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004683 if (prof_def_func())
4684 func_do_profile(fp);
4685#endif
4686 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004687 if (sandbox)
4688 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004689 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004690 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691 fp->uf_flags = flags;
4692 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004693 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004694 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004695 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004696 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004697 if (is_export)
4698 {
4699 fp->uf_flags |= FC_EXPORT;
4700 // let ex_export() know the export worked.
4701 is_export = FALSE;
4702 }
4703
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004704 if (eap->cmdidx == CMD_def)
4705 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004706 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4707 // :func does not use Vim9 script syntax, even in a Vim9 script file
4708 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004709
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004710 goto ret_free;
4711
4712erret:
4713 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004714 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004715 if (fp != NULL)
4716 {
4717 ga_init(&fp->uf_args);
4718 ga_init(&fp->uf_def_args);
4719 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004720errret_2:
4721 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004722 if (fp != NULL)
4723 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004724 if (free_fp)
4725 {
4726 vim_free(fp);
4727 fp = NULL;
4728 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004730 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004732 if (name != name_arg)
4733 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004734 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004736
4737 return fp;
4738}
4739
4740/*
4741 * ":function"
4742 */
4743 void
4744ex_function(exarg_T *eap)
4745{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004746 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004747
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004748 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4749 (void)define_function(eap, NULL, &lines_to_free);
4750 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004751}
4752
4753/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004754 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004755 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004756 */
4757 void
4758ex_defcompile(exarg_T *eap UNUSED)
4759{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004760 long todo = (long)func_hashtab.ht_used;
4761 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004762 hashitem_T *hi;
4763 ufunc_T *ufunc;
4764
4765 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4766 {
4767 if (!HASHITEM_EMPTY(hi))
4768 {
4769 --todo;
4770 ufunc = HI2UF(hi);
4771 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004772 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4773 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004774 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004775 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004776
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004777 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004778 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004779 // a function has been added or removed, need to start over
4780 todo = (long)func_hashtab.ht_used;
4781 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004782 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004783 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004784 }
4785 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004786 }
4787 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788}
4789
4790/*
4791 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4792 * Return 2 if "p" starts with "s:".
4793 * Return 0 otherwise.
4794 */
4795 int
4796eval_fname_script(char_u *p)
4797{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004798 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4799 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4801 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4802 return 5;
4803 if (p[0] == 's' && p[1] == ':')
4804 return 2;
4805 return 0;
4806}
4807
4808 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004809translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810{
4811 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004812 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004813 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004814}
4815
4816/*
4817 * Return TRUE when "ufunc" has old-style "..." varargs
4818 * or named varargs "...name: type".
4819 */
4820 int
4821has_varargs(ufunc_T *ufunc)
4822{
4823 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824}
4825
4826/*
4827 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004828 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 */
4830 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004831function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004832{
4833 char_u *nm = name;
4834 char_u *p;
4835 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004836 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004837 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004839 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4840 if (no_deref)
4841 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004842 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004843 nm = skipwhite(nm);
4844
Bram Moolenaare38eab22019-12-05 21:50:01 +01004845 // Only accept "funcname", "funcname ", "funcname (..." and
4846 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004848 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 vim_free(p);
4850 return n;
4851}
4852
Bram Moolenaar113e1072019-01-20 15:30:40 +01004853#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004854 char_u *
4855get_expanded_name(char_u *name, int check)
4856{
4857 char_u *nm = name;
4858 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004859 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004861 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004862 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004864 if (p != NULL && *nm == NUL
4865 && (!check || translated_function_exists(p, is_global)))
4866 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004867
4868 vim_free(p);
4869 return NULL;
4870}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004871#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004872
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873/*
4874 * Function given to ExpandGeneric() to obtain the list of user defined
4875 * function names.
4876 */
4877 char_u *
4878get_user_func_name(expand_T *xp, int idx)
4879{
4880 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004881 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004882 static hashitem_T *hi;
4883 ufunc_T *fp;
4884
4885 if (idx == 0)
4886 {
4887 done = 0;
4888 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004889 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004890 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004891 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 {
4893 if (done++ > 0)
4894 ++hi;
4895 while (HASHITEM_EMPTY(hi))
4896 ++hi;
4897 fp = HI2UF(hi);
4898
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004899 // don't show dead, dict and lambda functions
4900 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004901 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004902 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903
4904 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004905 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906
4907 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004908 if (xp->xp_context != EXPAND_USER_FUNC
4909 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910 {
4911 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004912 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 STRCAT(IObuff, ")");
4914 }
4915 return IObuff;
4916 }
4917 return NULL;
4918}
4919
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004920/*
4921 * ":delfunction {name}"
4922 */
4923 void
4924ex_delfunction(exarg_T *eap)
4925{
4926 ufunc_T *fp = NULL;
4927 char_u *p;
4928 char_u *name;
4929 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004930 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931
4932 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004933 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4934 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 vim_free(fudi.fd_newkey);
4936 if (name == NULL)
4937 {
4938 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004939 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004940 return;
4941 }
4942 if (!ends_excmd(*skipwhite(p)))
4943 {
4944 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00004945 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 return;
4947 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004948 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004949 if (eap->nextcmd != NULL)
4950 *p = NUL;
4951
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004952 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004953 {
4954 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004955 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004956 vim_free(name);
4957 return;
4958 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004959 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004960 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004961 vim_free(name);
4962
4963 if (!eap->skip)
4964 {
4965 if (fp == NULL)
4966 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004967 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004968 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969 return;
4970 }
4971 if (fp->uf_calls > 0)
4972 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004973 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974 return;
4975 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004976 if (fp->uf_flags & FC_VIM9)
4977 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004978 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004979 return;
4980 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004981
4982 if (fudi.fd_dict != NULL)
4983 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004984 // Delete the dict item that refers to the function, it will
4985 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004986 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4987 }
4988 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004989 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004990 // A normal function (not a numbered function or lambda) has a
4991 // refcount of 1 for the entry in the hashtable. When deleting
4992 // it and the refcount is more than one, it should be kept.
4993 // A numbered function and lambda should be kept if the refcount is
4994 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004995 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004996 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004997 // Function is still referenced somewhere. Don't free it but
4998 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004999 if (func_remove(fp))
5000 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005001 }
5002 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005003 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005004 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005 }
5006}
5007
5008/*
5009 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005010 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011 */
5012 void
5013func_unref(char_u *name)
5014{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005015 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005017 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005018 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005019 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005020 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005021 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005022#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005023 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005024#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005025 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005027 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005028}
5029
5030/*
5031 * Unreference a Function: decrement the reference count and free it when it
5032 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005033 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005034 */
5035 void
5036func_ptr_unref(ufunc_T *fp)
5037{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005038 if (fp != NULL && (--fp->uf_refcount <= 0
5039 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5040 && fp->uf_partial->pt_refcount <= 1
5041 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005042 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005043 // Only delete it when it's not being used. Otherwise it's done
5044 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005045 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005046 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047 }
5048}
5049
5050/*
5051 * Count a reference to a Function.
5052 */
5053 void
5054func_ref(char_u *name)
5055{
5056 ufunc_T *fp;
5057
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005058 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005059 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005060 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005061 if (fp != NULL)
5062 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005063 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005064 // Only give an error for a numbered function.
5065 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005066 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005067}
5068
5069/*
5070 * Count a reference to a Function.
5071 */
5072 void
5073func_ptr_ref(ufunc_T *fp)
5074{
5075 if (fp != NULL)
5076 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005077}
5078
5079/*
5080 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5081 * referenced from anywhere that is in use.
5082 */
5083 static int
5084can_free_funccal(funccall_T *fc, int copyID)
5085{
5086 return (fc->l_varlist.lv_copyID != copyID
5087 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005088 && fc->l_avars.dv_copyID != copyID
5089 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005090}
5091
5092/*
5093 * ":return [expr]"
5094 */
5095 void
5096ex_return(exarg_T *eap)
5097{
5098 char_u *arg = eap->arg;
5099 typval_T rettv;
5100 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005101 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102
5103 if (current_funccal == NULL)
5104 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005105 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106 return;
5107 }
5108
Bram Moolenaar844fb642021-10-23 13:32:30 +01005109 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005110 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5111
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005112 if (eap->skip)
5113 ++emsg_skip;
5114
5115 eap->nextcmd = NULL;
5116 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005117 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005118 {
5119 if (!eap->skip)
5120 returning = do_return(eap, FALSE, TRUE, &rettv);
5121 else
5122 clear_tv(&rettv);
5123 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005124 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005125 else if (!eap->skip)
5126 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005127 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005128 update_force_abort();
5129
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130 /*
5131 * Return unless the expression evaluation has been cancelled due to an
5132 * aborting error, an interrupt, or an exception.
5133 */
5134 if (!aborting())
5135 returning = do_return(eap, FALSE, TRUE, NULL);
5136 }
5137
Bram Moolenaare38eab22019-12-05 21:50:01 +01005138 // When skipping or the return gets pending, advance to the next command
5139 // in this line (!returning). Otherwise, ignore the rest of the line.
5140 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005141 if (returning)
5142 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005143 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005144 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145
5146 if (eap->skip)
5147 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005148 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005149}
5150
5151/*
5152 * ":1,25call func(arg1, arg2)" function call.
5153 */
5154 void
5155ex_call(exarg_T *eap)
5156{
5157 char_u *arg = eap->arg;
5158 char_u *startarg;
5159 char_u *name;
5160 char_u *tofree;
5161 int len;
5162 typval_T rettv;
5163 linenr_T lnum;
5164 int doesrange;
5165 int failed = FALSE;
5166 funcdict_T fudi;
5167 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005168 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005169 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005170 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171
Bram Moolenaare6b53242020-07-01 17:28:33 +02005172 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005173 if (eap->skip)
5174 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005175 // trans_function_name() doesn't work well when skipping, use eval0()
5176 // instead to skip to any following command, e.g. for:
5177 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005178 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005179 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005180 clear_tv(&rettv);
5181 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005182 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005183 return;
5184 }
5185
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005186 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5187 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005188 if (fudi.fd_newkey != NULL)
5189 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005190 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005191 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192 vim_free(fudi.fd_newkey);
5193 }
5194 if (tofree == NULL)
5195 return;
5196
Bram Moolenaare38eab22019-12-05 21:50:01 +01005197 // Increase refcount on dictionary, it could get deleted when evaluating
5198 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005199 if (fudi.fd_dict != NULL)
5200 ++fudi.fd_dict->dv_refcount;
5201
Bram Moolenaare38eab22019-12-05 21:50:01 +01005202 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5203 // contents. For VAR_PARTIAL get its partial, unless we already have one
5204 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005205 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005206 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005207 in_vim9script() && type == NULL ? &type : NULL,
5208 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209
Bram Moolenaare38eab22019-12-05 21:50:01 +01005210 // Skip white space to allow ":call func ()". Not good, but required for
5211 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005213 if (*startarg != '(')
5214 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005215 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 goto end;
5217 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005218 if (in_vim9script() && startarg > arg)
5219 {
5220 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5221 goto end;
5222 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223
5224 /*
5225 * When skipping, evaluate the function once, to find the end of the
5226 * arguments.
5227 * When the function takes a range, this is discovered after the first
5228 * call, and the loop is broken.
5229 */
5230 if (eap->skip)
5231 {
5232 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005233 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005234 }
5235 else
5236 lnum = eap->line1;
5237 for ( ; lnum <= eap->line2; ++lnum)
5238 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005239 funcexe_T funcexe;
5240
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241 if (!eap->skip && eap->addr_count > 0)
5242 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005243 if (lnum > curbuf->b_ml.ml_line_count)
5244 {
5245 // If the function deleted lines or switched to another buffer
5246 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005247 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005248 break;
5249 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005250 curwin->w_cursor.lnum = lnum;
5251 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005252 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005253 }
5254 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005255
Bram Moolenaara80faa82020-04-12 19:37:17 +02005256 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005257 funcexe.fe_firstline = eap->line1;
5258 funcexe.fe_lastline = eap->line2;
5259 funcexe.fe_doesrange = &doesrange;
5260 funcexe.fe_evaluate = !eap->skip;
5261 funcexe.fe_partial = partial;
5262 funcexe.fe_selfdict = fudi.fd_dict;
5263 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005264 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005265 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005266 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005267 {
5268 failed = TRUE;
5269 break;
5270 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005271 if (has_watchexpr())
5272 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005273
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005274 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005275 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005276 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005277 {
5278 failed = TRUE;
5279 break;
5280 }
5281
5282 clear_tv(&rettv);
5283 if (doesrange || eap->skip)
5284 break;
5285
Bram Moolenaare38eab22019-12-05 21:50:01 +01005286 // Stop when immediately aborting on error, or when an interrupt
5287 // occurred or an exception was thrown but not caught.
5288 // get_func_tv() returned OK, so that the check for trailing
5289 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005290 if (aborting())
5291 break;
5292 }
5293 if (eap->skip)
5294 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005295 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005296
Bram Moolenaar1d341892021-09-18 15:25:52 +02005297 // When inside :try we need to check for following "| catch" or "| endtry".
5298 // Not when there was an error, but do check if an exception was thrown.
5299 if ((!aborting() || did_throw)
5300 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005301 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005302 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005303 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005304 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005305 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005306 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005307 {
5308 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005309 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005310 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005311 }
5312 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005313 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 }
5315
5316end:
5317 dict_unref(fudi.fd_dict);
5318 vim_free(tofree);
5319}
5320
5321/*
5322 * Return from a function. Possibly makes the return pending. Also called
5323 * for a pending return at the ":endtry" or after returning from an extra
5324 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5325 * when called due to a ":return" command. "rettv" may point to a typval_T
5326 * with the return rettv. Returns TRUE when the return can be carried out,
5327 * FALSE when the return gets pending.
5328 */
5329 int
5330do_return(
5331 exarg_T *eap,
5332 int reanimate,
5333 int is_cmd,
5334 void *rettv)
5335{
5336 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005337 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005338
5339 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005340 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005341 current_funccal->returned = FALSE;
5342
5343 /*
5344 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5345 * not in its finally clause (which then is to be executed next) is found.
5346 * In this case, make the ":return" pending for execution at the ":endtry".
5347 * Otherwise, return normally.
5348 */
5349 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5350 if (idx >= 0)
5351 {
5352 cstack->cs_pending[idx] = CSTP_RETURN;
5353
5354 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005355 // A pending return again gets pending. "rettv" points to an
5356 // allocated variable with the rettv of the original ":return"'s
5357 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005358 cstack->cs_rettv[idx] = rettv;
5359 else
5360 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005361 // When undoing a return in order to make it pending, get the stored
5362 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005363 if (reanimate)
5364 rettv = current_funccal->rettv;
5365
5366 if (rettv != NULL)
5367 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005368 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005369 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5370 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5371 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005372 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005373 }
5374 else
5375 cstack->cs_rettv[idx] = NULL;
5376
5377 if (reanimate)
5378 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005379 // The pending return value could be overwritten by a ":return"
5380 // without argument in a finally clause; reset the default
5381 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382 current_funccal->rettv->v_type = VAR_NUMBER;
5383 current_funccal->rettv->vval.v_number = 0;
5384 }
5385 }
5386 report_make_pending(CSTP_RETURN, rettv);
5387 }
5388 else
5389 {
5390 current_funccal->returned = TRUE;
5391
Bram Moolenaare38eab22019-12-05 21:50:01 +01005392 // If the return is carried out now, store the return value. For
5393 // a return immediately after reanimation, the value is already
5394 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005395 if (!reanimate && rettv != NULL)
5396 {
5397 clear_tv(current_funccal->rettv);
5398 *current_funccal->rettv = *(typval_T *)rettv;
5399 if (!is_cmd)
5400 vim_free(rettv);
5401 }
5402 }
5403
5404 return idx < 0;
5405}
5406
5407/*
5408 * Free the variable with a pending return value.
5409 */
5410 void
5411discard_pending_return(void *rettv)
5412{
5413 free_tv((typval_T *)rettv);
5414}
5415
5416/*
5417 * Generate a return command for producing the value of "rettv". The result
5418 * is an allocated string. Used by report_pending() for verbose messages.
5419 */
5420 char_u *
5421get_return_cmd(void *rettv)
5422{
5423 char_u *s = NULL;
5424 char_u *tofree = NULL;
5425 char_u numbuf[NUMBUFLEN];
5426
5427 if (rettv != NULL)
5428 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5429 if (s == NULL)
5430 s = (char_u *)"";
5431
5432 STRCPY(IObuff, ":return ");
5433 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5434 if (STRLEN(s) + 8 >= IOSIZE)
5435 STRCPY(IObuff + IOSIZE - 4, "...");
5436 vim_free(tofree);
5437 return vim_strsave(IObuff);
5438}
5439
5440/*
5441 * Get next function line.
5442 * Called by do_cmdline() to get the next line.
5443 * Returns allocated string, or NULL for end of function.
5444 */
5445 char_u *
5446get_func_line(
5447 int c UNUSED,
5448 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005449 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005450 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005451{
5452 funccall_T *fcp = (funccall_T *)cookie;
5453 ufunc_T *fp = fcp->func;
5454 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005455 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005456
Bram Moolenaare38eab22019-12-05 21:50:01 +01005457 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005458 if (fcp->dbg_tick != debug_tick)
5459 {
5460 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005461 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005462 fcp->dbg_tick = debug_tick;
5463 }
5464#ifdef FEAT_PROFILE
5465 if (do_profiling == PROF_YES)
5466 func_line_end(cookie);
5467#endif
5468
5469 gap = &fp->uf_lines;
5470 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5471 || fcp->returned)
5472 retval = NULL;
5473 else
5474 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005475 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476 while (fcp->linenr < gap->ga_len
5477 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5478 ++fcp->linenr;
5479 if (fcp->linenr >= gap->ga_len)
5480 retval = NULL;
5481 else
5482 {
5483 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005484 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005485#ifdef FEAT_PROFILE
5486 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005487 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005488#endif
5489 }
5490 }
5491
Bram Moolenaare38eab22019-12-05 21:50:01 +01005492 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005493 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005494 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005495 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005496 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005497 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005498 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005499 fcp->dbg_tick = debug_tick;
5500 }
5501
5502 return retval;
5503}
5504
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005505/*
5506 * Return TRUE if the currently active function should be ended, because a
5507 * return was encountered or an error occurred. Used inside a ":while".
5508 */
5509 int
5510func_has_ended(void *cookie)
5511{
5512 funccall_T *fcp = (funccall_T *)cookie;
5513
Bram Moolenaare38eab22019-12-05 21:50:01 +01005514 // Ignore the "abort" flag if the abortion behavior has been changed due to
5515 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005516 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5517 || fcp->returned);
5518}
5519
5520/*
5521 * return TRUE if cookie indicates a function which "abort"s on errors.
5522 */
5523 int
5524func_has_abort(
5525 void *cookie)
5526{
5527 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5528}
5529
5530
5531/*
5532 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5533 * Don't do this when "Func" is already a partial that was bound
5534 * explicitly (pt_auto is FALSE).
5535 * Changes "rettv" in-place.
5536 * Returns the updated "selfdict_in".
5537 */
5538 dict_T *
5539make_partial(dict_T *selfdict_in, typval_T *rettv)
5540{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005541 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005542 char_u *tofree = NULL;
5543 ufunc_T *fp;
5544 char_u fname_buf[FLEN_FIXED + 1];
5545 int error;
5546 dict_T *selfdict = selfdict_in;
5547
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005548 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5549 fp = rettv->vval.v_partial->pt_func;
5550 else
5551 {
5552 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5553 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005554 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005555 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005556 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005557 vim_free(tofree);
5558 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005559
5560 if (fp != NULL && (fp->uf_flags & FC_DICT))
5561 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005562 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005563
5564 if (pt != NULL)
5565 {
5566 pt->pt_refcount = 1;
5567 pt->pt_dict = selfdict;
5568 pt->pt_auto = TRUE;
5569 selfdict = NULL;
5570 if (rettv->v_type == VAR_FUNC)
5571 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005572 // Just a function: Take over the function name and use
5573 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005574 pt->pt_name = rettv->vval.v_string;
5575 }
5576 else
5577 {
5578 partial_T *ret_pt = rettv->vval.v_partial;
5579 int i;
5580
Bram Moolenaare38eab22019-12-05 21:50:01 +01005581 // Partial: copy the function name, use selfdict and copy
5582 // args. Can't take over name or args, the partial might
5583 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005584 if (ret_pt->pt_name != NULL)
5585 {
5586 pt->pt_name = vim_strsave(ret_pt->pt_name);
5587 func_ref(pt->pt_name);
5588 }
5589 else
5590 {
5591 pt->pt_func = ret_pt->pt_func;
5592 func_ptr_ref(pt->pt_func);
5593 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005594 if (ret_pt->pt_argc > 0)
5595 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005596 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005597 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005598 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005599 pt->pt_argc = 0;
5600 else
5601 {
5602 pt->pt_argc = ret_pt->pt_argc;
5603 for (i = 0; i < pt->pt_argc; i++)
5604 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5605 }
5606 }
5607 partial_unref(ret_pt);
5608 }
5609 rettv->v_type = VAR_PARTIAL;
5610 rettv->vval.v_partial = pt;
5611 }
5612 }
5613 return selfdict;
5614}
5615
5616/*
5617 * Return the name of the executed function.
5618 */
5619 char_u *
5620func_name(void *cookie)
5621{
5622 return ((funccall_T *)cookie)->func->uf_name;
5623}
5624
5625/*
5626 * Return the address holding the next breakpoint line for a funccall cookie.
5627 */
5628 linenr_T *
5629func_breakpoint(void *cookie)
5630{
5631 return &((funccall_T *)cookie)->breakpoint;
5632}
5633
5634/*
5635 * Return the address holding the debug tick for a funccall cookie.
5636 */
5637 int *
5638func_dbg_tick(void *cookie)
5639{
5640 return &((funccall_T *)cookie)->dbg_tick;
5641}
5642
5643/*
5644 * Return the nesting level for a funccall cookie.
5645 */
5646 int
5647func_level(void *cookie)
5648{
5649 return ((funccall_T *)cookie)->level;
5650}
5651
5652/*
5653 * Return TRUE when a function was ended by a ":return" command.
5654 */
5655 int
5656current_func_returned(void)
5657{
5658 return current_funccal->returned;
5659}
5660
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005661 int
5662free_unref_funccal(int copyID, int testing)
5663{
5664 int did_free = FALSE;
5665 int did_free_funccal = FALSE;
5666 funccall_T *fc, **pfc;
5667
5668 for (pfc = &previous_funccal; *pfc != NULL; )
5669 {
5670 if (can_free_funccal(*pfc, copyID))
5671 {
5672 fc = *pfc;
5673 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005674 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005675 did_free = TRUE;
5676 did_free_funccal = TRUE;
5677 }
5678 else
5679 pfc = &(*pfc)->caller;
5680 }
5681 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005682 // When a funccal was freed some more items might be garbage
5683 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005684 (void)garbage_collect(testing);
5685
5686 return did_free;
5687}
5688
5689/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005690 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005691 */
5692 static funccall_T *
5693get_funccal(void)
5694{
5695 int i;
5696 funccall_T *funccal;
5697 funccall_T *temp_funccal;
5698
5699 funccal = current_funccal;
5700 if (debug_backtrace_level > 0)
5701 {
5702 for (i = 0; i < debug_backtrace_level; i++)
5703 {
5704 temp_funccal = funccal->caller;
5705 if (temp_funccal)
5706 funccal = temp_funccal;
5707 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005708 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005709 debug_backtrace_level = i;
5710 }
5711 }
5712 return funccal;
5713}
5714
5715/*
5716 * Return the hashtable used for local variables in the current funccal.
5717 * Return NULL if there is no current funccal.
5718 */
5719 hashtab_T *
5720get_funccal_local_ht()
5721{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005722 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005723 return NULL;
5724 return &get_funccal()->l_vars.dv_hashtab;
5725}
5726
5727/*
5728 * Return the l: scope variable.
5729 * Return NULL if there is no current funccal.
5730 */
5731 dictitem_T *
5732get_funccal_local_var()
5733{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005734 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005735 return NULL;
5736 return &get_funccal()->l_vars_var;
5737}
5738
5739/*
5740 * Return the hashtable used for argument in the current funccal.
5741 * Return NULL if there is no current funccal.
5742 */
5743 hashtab_T *
5744get_funccal_args_ht()
5745{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005746 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005747 return NULL;
5748 return &get_funccal()->l_avars.dv_hashtab;
5749}
5750
5751/*
5752 * Return the a: scope variable.
5753 * Return NULL if there is no current funccal.
5754 */
5755 dictitem_T *
5756get_funccal_args_var()
5757{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005758 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005759 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005760 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005761}
5762
5763/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005764 * List function variables, if there is a function.
5765 */
5766 void
5767list_func_vars(int *first)
5768{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005769 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005770 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005771 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005772}
5773
5774/*
5775 * If "ht" is the hashtable for local variables in the current funccal, return
5776 * the dict that contains it.
5777 * Otherwise return NULL.
5778 */
5779 dict_T *
5780get_current_funccal_dict(hashtab_T *ht)
5781{
5782 if (current_funccal != NULL
5783 && ht == &current_funccal->l_vars.dv_hashtab)
5784 return &current_funccal->l_vars;
5785 return NULL;
5786}
5787
5788/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005789 * Search hashitem in parent scope.
5790 */
5791 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005792find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005793{
5794 funccall_T *old_current_funccal = current_funccal;
5795 hashtab_T *ht;
5796 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005797 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005798
5799 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5800 return NULL;
5801
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005802 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005803 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005804 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005805 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005806 ht = find_var_ht(name, &varname);
5807 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005808 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005809 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005810 if (!HASHITEM_EMPTY(hi))
5811 {
5812 *pht = ht;
5813 break;
5814 }
5815 }
5816 if (current_funccal == current_funccal->func->uf_scoped)
5817 break;
5818 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005819 }
5820 current_funccal = old_current_funccal;
5821
5822 return hi;
5823}
5824
5825/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005826 * Search variable in parent scope.
5827 */
5828 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005829find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005830{
5831 dictitem_T *v = NULL;
5832 funccall_T *old_current_funccal = current_funccal;
5833 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005834 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005835
5836 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5837 return NULL;
5838
Bram Moolenaare38eab22019-12-05 21:50:01 +01005839 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005840 current_funccal = current_funccal->func->uf_scoped;
5841 while (current_funccal)
5842 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005843 ht = find_var_ht(name, &varname);
5844 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005845 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005846 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005847 if (v != NULL)
5848 break;
5849 }
5850 if (current_funccal == current_funccal->func->uf_scoped)
5851 break;
5852 current_funccal = current_funccal->func->uf_scoped;
5853 }
5854 current_funccal = old_current_funccal;
5855
5856 return v;
5857}
5858
5859/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005860 * Set "copyID + 1" in previous_funccal and callers.
5861 */
5862 int
5863set_ref_in_previous_funccal(int copyID)
5864{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005865 funccall_T *fc;
5866
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005867 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005868 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005869 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005870 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5871 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5872 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5873 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005874 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005875 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005876}
5877
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005878 static int
5879set_ref_in_funccal(funccall_T *fc, int copyID)
5880{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005881 if (fc->fc_copyID != copyID)
5882 {
5883 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005884 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5885 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5886 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5887 || set_ref_in_func(NULL, fc->func, copyID))
5888 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005889 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005890 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005891}
5892
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005893/*
5894 * Set "copyID" in all local vars and arguments in the call stack.
5895 */
5896 int
5897set_ref_in_call_stack(int copyID)
5898{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005899 funccall_T *fc;
5900 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005901
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005902 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5903 if (set_ref_in_funccal(fc, copyID))
5904 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005905
5906 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005907 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5908 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5909 if (set_ref_in_funccal(fc, copyID))
5910 return TRUE;
5911 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005912}
5913
5914/*
5915 * Set "copyID" in all functions available by name.
5916 */
5917 int
5918set_ref_in_functions(int copyID)
5919{
5920 int todo;
5921 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005922 ufunc_T *fp;
5923
5924 todo = (int)func_hashtab.ht_used;
5925 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005926 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005927 if (!HASHITEM_EMPTY(hi))
5928 {
5929 --todo;
5930 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005931 if (!func_name_refcount(fp->uf_name)
5932 && set_ref_in_func(NULL, fp, copyID))
5933 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005934 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005935 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005936 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005937}
5938
5939/*
5940 * Set "copyID" in all function arguments.
5941 */
5942 int
5943set_ref_in_func_args(int copyID)
5944{
5945 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005946
5947 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005948 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5949 copyID, NULL, NULL))
5950 return TRUE;
5951 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005952}
5953
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005954/*
5955 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005956 * Returns TRUE if setting references failed somehow.
5957 */
5958 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005959set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005960{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005961 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005962 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005963 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005964 char_u fname_buf[FLEN_FIXED + 1];
5965 char_u *tofree = NULL;
5966 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005967 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005968
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005969 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005970 return FALSE;
5971
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005972 if (fp_in == NULL)
5973 {
5974 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005975 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005976 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005977 if (fp != NULL)
5978 {
5979 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005980 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005981 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005982
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005983 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005984 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005985}
5986
Bram Moolenaare38eab22019-12-05 21:50:01 +01005987#endif // FEAT_EVAL