blob: 8c204398ca017096634fcf592435a39367bf597b [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;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001914 char_u *namep;
1915
1916 // skip a "<SNR>99_" prefix
1917 namep = untrans_function_name(name);
1918 if (namep == NULL)
1919 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001920
1921 // An exported function in an autoload script is stored as
1922 // "dir#path#name".
1923 if (len < sizeof(buffer))
1924 auto_name = buffer;
1925 else
1926 auto_name = alloc(len);
1927 if (auto_name != NULL)
1928 {
1929 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001930 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001931 hi = hash_find(&func_hashtab, auto_name);
1932 if (auto_name != buffer)
1933 vim_free(auto_name);
1934 if (!HASHITEM_EMPTY(hi))
1935 return HI2UF(hi);
1936 }
1937 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001938
1939 return NULL;
1940}
1941
1942/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001944 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1945 * functions.
1946 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 * Return NULL for unknown function.
1948 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001949 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001950find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951{
1952 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001953 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001955 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001956 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001957 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1958 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001959
Bram Moolenaar95006e32020-08-29 17:47:08 +02001960 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001961 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001962 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001963 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1964 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001965 if (func != NULL)
1966 return func;
1967 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001968 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001969
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001970 if ((flags & FFED_NO_GLOBAL) == 0)
1971 {
1972 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02001973 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001974 if (!HASHITEM_EMPTY(hi))
1975 return HI2UF(hi);
1976 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001977
Bram Moolenaarb8822442022-01-11 15:24:05 +00001978 // Find autoload function if this is an autoload script.
1979 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1980 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001981}
1982
1983/*
1984 * Find a function by name, return pointer to it in ufuncs.
1985 * "cctx" is passed in a :def function to find imported functions.
1986 * Return NULL for unknown or dead function.
1987 */
1988 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001989find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001990{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001991 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001992
1993 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1994 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001995 return NULL;
1996}
1997
1998/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001999 * Return TRUE if "ufunc" is a global function.
2000 */
2001 int
2002func_is_global(ufunc_T *ufunc)
2003{
2004 return ufunc->uf_name[0] != K_SPECIAL;
2005}
2006
2007/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002008 * Copy the function name of "fp" to buffer "buf".
2009 * "buf" must be able to hold the function name plus three bytes.
2010 * Takes care of script-local function names.
2011 */
2012 static void
2013cat_func_name(char_u *buf, ufunc_T *fp)
2014{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002015 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 {
2017 STRCPY(buf, "<SNR>");
2018 STRCAT(buf, fp->uf_name + 3);
2019 }
2020 else
2021 STRCPY(buf, fp->uf_name);
2022}
2023
2024/*
2025 * Add a number variable "name" to dict "dp" with value "nr".
2026 */
2027 static void
2028add_nr_var(
2029 dict_T *dp,
2030 dictitem_T *v,
2031 char *name,
2032 varnumber_T nr)
2033{
2034 STRCPY(v->di_key, name);
2035 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2036 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2037 v->di_tv.v_type = VAR_NUMBER;
2038 v->di_tv.v_lock = VAR_FIXED;
2039 v->di_tv.vval.v_number = nr;
2040}
2041
2042/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002043 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002044 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002045 static void
2046free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002047{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002048 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002049
2050 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2051 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002052 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002053
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002054 // When garbage collecting a funccall_T may be freed before the
2055 // function that references it, clear its uf_scoped field.
2056 // The function may have been redefined and point to another
2057 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002058 if (fp != NULL && fp->uf_scoped == fc)
2059 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002060 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002061 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002062
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002063 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002064 vim_free(fc);
2065}
2066
2067/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002068 * Free "fc" and what it contains.
2069 * Can be called only when "fc" is kept beyond the period of it called,
2070 * i.e. after cleanup_function_call(fc).
2071 */
2072 static void
2073free_funccal_contents(funccall_T *fc)
2074{
2075 listitem_T *li;
2076
2077 // Free all l: variables.
2078 vars_clear(&fc->l_vars.dv_hashtab);
2079
2080 // Free all a: variables.
2081 vars_clear(&fc->l_avars.dv_hashtab);
2082
2083 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002084 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002085 clear_tv(&li->li_tv);
2086
2087 free_funccal(fc);
2088}
2089
2090/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002091 * Handle the last part of returning from a function: free the local hashtable.
2092 * Unless it is still in use by a closure.
2093 */
2094 static void
2095cleanup_function_call(funccall_T *fc)
2096{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002097 int may_free_fc = fc->fc_refcount <= 0;
2098 int free_fc = TRUE;
2099
Bram Moolenaar6914c642017-04-01 21:21:30 +02002100 current_funccal = fc->caller;
2101
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002102 // Free all l: variables if not referred.
2103 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2104 vars_clear(&fc->l_vars.dv_hashtab);
2105 else
2106 free_fc = FALSE;
2107
2108 // If the a:000 list and the l: and a: dicts are not referenced and
2109 // there is no closure using it, we can free the funccall_T and what's
2110 // in it.
2111 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2112 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002113 else
2114 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002115 int todo;
2116 hashitem_T *hi;
2117 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002118
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002119 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002120
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002121 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002122 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2123 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2124 {
2125 if (!HASHITEM_EMPTY(hi))
2126 {
2127 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002128 di = HI2DI(hi);
2129 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002130 }
2131 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002132 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002133
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002134 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2135 fc->l_varlist.lv_first = NULL;
2136 else
2137 {
2138 listitem_T *li;
2139
2140 free_fc = FALSE;
2141
2142 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002143 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002144 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002145 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002146
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002147 if (free_fc)
2148 free_funccal(fc);
2149 else
2150 {
2151 static int made_copy = 0;
2152
2153 // "fc" is still in use. This can happen when returning "a:000",
2154 // assigning "l:" to a global variable or defining a closure.
2155 // Link "fc" in the list for garbage collection later.
2156 fc->caller = previous_funccal;
2157 previous_funccal = fc;
2158
2159 if (want_garbage_collect)
2160 // If garbage collector is ready, clear count.
2161 made_copy = 0;
2162 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002163 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002164 // We have made a lot of copies, worth 4 Mbyte. This can happen
2165 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002166 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002167 // too much memory.
2168 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002169 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002170 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002171 }
2172}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002173
2174/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002175 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2176 */
2177 static int
2178numbered_function(char_u *name)
2179{
2180 return isdigit(*name)
2181 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2182}
2183
2184/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002185 * There are two kinds of function names:
2186 * 1. ordinary names, function defined with :function or :def
2187 * 2. numbered functions and lambdas
2188 * For the first we only count the name stored in func_hashtab as a reference,
2189 * using function() does not count as a reference, because the function is
2190 * looked up by name.
2191 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002192 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002193func_name_refcount(char_u *name)
2194{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002195 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002196}
2197
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002198/*
2199 * Unreference "fc": decrement the reference count and free it when it
2200 * becomes zero. "fp" is detached from "fc".
2201 * When "force" is TRUE we are exiting.
2202 */
2203 static void
2204funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2205{
2206 funccall_T **pfc;
2207 int i;
2208
2209 if (fc == NULL)
2210 return;
2211
2212 if (--fc->fc_refcount <= 0 && (force || (
2213 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2214 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2215 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2216 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2217 {
2218 if (fc == *pfc)
2219 {
2220 *pfc = fc->caller;
2221 free_funccal_contents(fc);
2222 return;
2223 }
2224 }
2225 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2226 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2227 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2228}
2229
2230/*
2231 * Remove the function from the function hashtable. If the function was
2232 * deleted while it still has references this was already done.
2233 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2234 */
2235 static int
2236func_remove(ufunc_T *fp)
2237{
2238 hashitem_T *hi;
2239
2240 // Return if it was already virtually deleted.
2241 if (fp->uf_flags & FC_DEAD)
2242 return FALSE;
2243
2244 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2245 if (!HASHITEM_EMPTY(hi))
2246 {
2247 // When there is a def-function index do not actually remove the
2248 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002249 // Do remove it when it's a copy.
2250 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002251 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002252 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002253 return FALSE;
2254 }
2255 hash_remove(&func_hashtab, hi);
2256 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002257 return TRUE;
2258 }
2259 return FALSE;
2260}
2261
2262 static void
2263func_clear_items(ufunc_T *fp)
2264{
2265 ga_clear_strings(&(fp->uf_args));
2266 ga_clear_strings(&(fp->uf_def_args));
2267 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002268 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002269 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002270 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002271 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002272
2273 // Increment the refcount of this function to avoid it being freed
2274 // recursively when the partial is freed.
2275 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002276 partial_unref(fp->uf_partial);
2277 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002278 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002279
2280#ifdef FEAT_LUA
2281 if (fp->uf_cb_free != NULL)
2282 {
2283 fp->uf_cb_free(fp->uf_cb_state);
2284 fp->uf_cb_free = NULL;
2285 }
2286
2287 fp->uf_cb_state = NULL;
2288 fp->uf_cb = NULL;
2289#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002290#ifdef FEAT_PROFILE
2291 VIM_CLEAR(fp->uf_tml_count);
2292 VIM_CLEAR(fp->uf_tml_total);
2293 VIM_CLEAR(fp->uf_tml_self);
2294#endif
2295}
2296
2297/*
2298 * Free all things that a function contains. Does not free the function
2299 * itself, use func_free() for that.
2300 * When "force" is TRUE we are exiting.
2301 */
2302 static void
2303func_clear(ufunc_T *fp, int force)
2304{
2305 if (fp->uf_cleared)
2306 return;
2307 fp->uf_cleared = TRUE;
2308
2309 // clear this function
2310 func_clear_items(fp);
2311 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002312 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002313}
2314
2315/*
2316 * Free a function and remove it from the list of functions. Does not free
2317 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002318 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002319 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002320 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002321 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002322func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323{
2324 // Only remove it when not done already, otherwise we would remove a newer
2325 // version of the function with the same name.
2326 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2327 func_remove(fp);
2328
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002329 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002330 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002331 if (fp->uf_dfunc_idx > 0)
2332 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002333 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002334 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002335 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002336 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002337 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002338}
2339
2340/*
2341 * Free all things that a function contains and free the function itself.
2342 * When "force" is TRUE we are exiting.
2343 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002344 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002345func_clear_free(ufunc_T *fp, int force)
2346{
2347 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002348 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2349 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002350 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002351 else
2352 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002353}
2354
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002355/*
2356 * Copy already defined function "lambda" to a new function with name "global".
2357 * This is for when a compiled function defines a global function.
2358 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002359 int
2360copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002361{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002362 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002363 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002364
2365 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002366 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002367 semsg(_(e_lambda_function_not_found_str), lambda);
2368 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002369 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002370
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002371 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002372 if (fp != NULL)
2373 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002374 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002375 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002376 return FAIL;
2377 }
2378
2379 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2380 if (fp == NULL)
2381 return FAIL;
2382
2383 fp->uf_varargs = ufunc->uf_varargs;
2384 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2385 fp->uf_def_status = ufunc->uf_def_status;
2386 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2387 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2388 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2389 == FAIL
2390 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2391 goto failed;
2392
2393 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2394 : vim_strsave(ufunc->uf_name_exp);
2395 if (ufunc->uf_arg_types != NULL)
2396 {
2397 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2398 if (fp->uf_arg_types == NULL)
2399 goto failed;
2400 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2401 sizeof(type_T *) * fp->uf_args.ga_len);
2402 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002403 if (ufunc->uf_va_name != NULL)
2404 {
2405 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2406 if (fp->uf_va_name == NULL)
2407 goto failed;
2408 }
2409 fp->uf_ret_type = ufunc->uf_ret_type;
2410
2411 fp->uf_refcount = 1;
2412 STRCPY(fp->uf_name, global);
2413 hash_add(&func_hashtab, UF2HIKEY(fp));
2414
2415 // the referenced dfunc_T is now used one more time
2416 link_def_function(fp);
2417
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002418 // Create a partial to store the context of the function where it was
2419 // instantiated. Only needs to be done once. Do this on the original
2420 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002421 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2422 {
2423 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2424
2425 if (pt == NULL)
2426 goto failed;
2427 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002428 {
2429 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002430 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002431 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002432 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002433 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002434 }
2435
2436 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002437
2438failed:
2439 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002440 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002441}
2442
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002443static int funcdepth = 0;
2444
2445/*
2446 * Increment the function call depth count.
2447 * Return FAIL when going over 'maxfuncdepth'.
2448 * Otherwise return OK, must call funcdepth_decrement() later!
2449 */
2450 int
2451funcdepth_increment(void)
2452{
2453 if (funcdepth >= p_mfd)
2454 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002455 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002456 return FAIL;
2457 }
2458 ++funcdepth;
2459 return OK;
2460}
2461
2462 void
2463funcdepth_decrement(void)
2464{
2465 --funcdepth;
2466}
2467
2468/*
2469 * Get the current function call depth.
2470 */
2471 int
2472funcdepth_get(void)
2473{
2474 return funcdepth;
2475}
2476
2477/*
2478 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002479 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002480 * times as funcdepth_increment().
2481 */
2482 void
2483funcdepth_restore(int depth)
2484{
2485 funcdepth = depth;
2486}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002487
2488/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 * Call a user function.
2490 */
2491 static void
2492call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002493 ufunc_T *fp, // pointer to function
2494 int argcount, // nr of args
2495 typval_T *argvars, // arguments
2496 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002497 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002498 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002499{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002500 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002501 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502 funccall_T *fc;
2503 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002504 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002506 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 int i;
2508 int ai;
2509 int islambda = FALSE;
2510 char_u numbuf[NUMBUFLEN];
2511 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002512 typval_T *tv_to_free[MAX_FUNC_ARGS];
2513 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002515 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002517 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518
Bram Moolenaarb2049902021-01-24 12:53:53 +01002519#ifdef FEAT_PROFILE
2520 CLEAR_FIELD(profile_info);
2521#endif
2522
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002523 // If depth of calling is getting too high, don't execute the function.
2524 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 rettv->v_type = VAR_NUMBER;
2527 rettv->vval.v_number = -1;
2528 return;
2529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530
Bram Moolenaare38eab22019-12-05 21:50:01 +01002531 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002533 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002534 if (fc == NULL)
2535 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536 fc->caller = current_funccal;
2537 current_funccal = fc;
2538 fc->func = fp;
2539 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002541 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2543 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002544 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002545 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002546 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002548 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002549 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002550#ifdef FEAT_PROFILE
2551 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2552#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002553 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002554#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002555 if (do_profiling == PROF_YES)
2556 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002557#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002558 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002559 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002560#ifdef FEAT_PROFILE
2561 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002562 || (caller != NULL && caller->uf_profiling)))
2563 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002564#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002565 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002566 free_funccal(fc);
2567 return;
2568 }
2569
Bram Moolenaar38453522021-11-28 22:00:12 +00002570 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571
2572 /*
2573 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2574 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2575 * each argument variable and saves a lot of time.
2576 */
2577 /*
2578 * Init l: variables.
2579 */
2580 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2581 if (selfdict != NULL)
2582 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002583 // Set l:self to "selfdict". Use "name" to avoid a warning from
2584 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585 v = &fc->fixvar[fixvar_idx++].var;
2586 name = v->di_key;
2587 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002588 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002589 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2590 v->di_tv.v_type = VAR_DICT;
2591 v->di_tv.v_lock = 0;
2592 v->di_tv.vval.v_dict = selfdict;
2593 ++selfdict->dv_refcount;
2594 }
2595
2596 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002597 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002598 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002599 * Set a:000 to a list with room for the "..." arguments.
2600 */
2601 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002602 if ((fp->uf_flags & FC_NOARGS) == 0)
2603 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002604 (varnumber_T)(argcount >= fp->uf_args.ga_len
2605 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002606 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002607 if ((fp->uf_flags & FC_NOARGS) == 0)
2608 {
2609 // Use "name" to avoid a warning from some compiler that checks the
2610 // destination size.
2611 v = &fc->fixvar[fixvar_idx++].var;
2612 name = v->di_key;
2613 STRCPY(name, "000");
2614 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2615 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2616 v->di_tv.v_type = VAR_LIST;
2617 v->di_tv.v_lock = VAR_FIXED;
2618 v->di_tv.vval.v_list = &fc->l_varlist;
2619 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002620 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2622 fc->l_varlist.lv_lock = VAR_FIXED;
2623
2624 /*
2625 * Set a:firstline to "firstline" and a:lastline to "lastline".
2626 * Set a:name to named arguments.
2627 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002628 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002629 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002630 if ((fp->uf_flags & FC_NOARGS) == 0)
2631 {
2632 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002633 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002634 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002635 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002636 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002637 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 {
2639 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002640 typval_T def_rettv;
2641 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642
2643 ai = i - fp->uf_args.ga_len;
2644 if (ai < 0)
2645 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 name = FUNCARG(fp, i);
2648 if (islambda)
2649 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002650
2651 // evaluate named argument default expression
2652 isdefault = ai + fp->uf_def_args.ga_len >= 0
2653 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2654 && argvars[i].vval.v_number == VVAL_NONE));
2655 if (isdefault)
2656 {
2657 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002658
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002659 def_rettv.v_type = VAR_NUMBER;
2660 def_rettv.vval.v_number = -1;
2661
2662 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2663 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002664 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002665 {
2666 default_arg_err = 1;
2667 break;
2668 }
2669 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670 }
2671 else
2672 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002673 if ((fp->uf_flags & FC_NOARGS) != 0)
2674 // Bail out if no a: arguments used (in lambda).
2675 break;
2676
Bram Moolenaare38eab22019-12-05 21:50:01 +01002677 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678 sprintf((char *)numbuf, "%d", ai + 1);
2679 name = numbuf;
2680 }
2681 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2682 {
2683 v = &fc->fixvar[fixvar_idx++].var;
2684 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002685 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 }
2687 else
2688 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002689 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 if (v == NULL)
2691 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002692 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002695 // Note: the values are copied directly to avoid alloc/free.
2696 // "argvars" must have VAR_FIXED for v_lock.
2697 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 v->di_tv.v_lock = VAR_FIXED;
2699
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002700 if (isdefault)
2701 // Need to free this later, no matter where it's stored.
2702 tv_to_free[tv_to_free_len++] = &v->di_tv;
2703
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 if (addlocal)
2705 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002706 // Named arguments should be accessed without the "a:" prefix in
2707 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002708 copy_tv(&v->di_tv, &v->di_tv);
2709 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002711 else
2712 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002713
2714 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2715 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002716 listitem_T *li = &fc->l_listitems[ai];
2717
2718 li->li_tv = argvars[i];
2719 li->li_tv.v_lock = VAR_FIXED;
2720 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 }
2722 }
2723
Bram Moolenaare38eab22019-12-05 21:50:01 +01002724 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002726
2727 if (fp->uf_flags & FC_SANDBOX)
2728 {
2729 using_sandbox = TRUE;
2730 ++sandbox;
2731 }
2732
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002733 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002734 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002735 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002737 ++no_wait_return;
2738 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002740 smsg(_("calling %s"), SOURCING_NAME);
2741 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002743 char_u buf[MSG_BUF_LEN];
2744 char_u numbuf2[NUMBUFLEN];
2745 char_u *tofree;
2746 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002748 msg_puts("(");
2749 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002751 if (i > 0)
2752 msg_puts(", ");
2753 if (argvars[i].v_type == VAR_NUMBER)
2754 msg_outnum((long)argvars[i].vval.v_number);
2755 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002757 // Do not want errors such as E724 here.
2758 ++emsg_off;
2759 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2760 --emsg_off;
2761 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002763 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002765 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2766 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002768 msg_puts((char *)s);
2769 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770 }
2771 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002773 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002775 msg_puts("\n"); // don't overwrite this either
2776
2777 verbose_leave_scroll();
2778 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002779 }
2780#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002781 if (do_profiling == PROF_YES)
2782 profile_may_start_func(&profile_info, fp,
2783 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002784#endif
2785
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002786 save_current_sctx = current_sctx;
2787 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 save_did_emsg = did_emsg;
2789 did_emsg = FALSE;
2790
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002791 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2792 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002793 else if (islambda)
2794 {
2795 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2796
2797 // A Lambda always has the command "return {expr}". It is much faster
2798 // to evaluate {expr} directly.
2799 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002800 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002801 --ex_nesting_level;
2802 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002803 else
2804 // call do_cmdline() to execute the lines
2805 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2807
2808 --RedrawingDisabled;
2809
Bram Moolenaare38eab22019-12-05 21:50:01 +01002810 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002811 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2812 {
2813 clear_tv(rettv);
2814 rettv->v_type = VAR_NUMBER;
2815 rettv->vval.v_number = -1;
2816 }
2817
2818#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002819 if (do_profiling == PROF_YES)
2820 {
2821 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2822
2823 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2824 profile_may_end_func(&profile_info, fp, caller);
2825 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826#endif
2827
Bram Moolenaare38eab22019-12-05 21:50:01 +01002828 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829 if (p_verbose >= 12)
2830 {
2831 ++no_wait_return;
2832 verbose_enter_scroll();
2833
2834 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002835 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002837 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 (long)fc->rettv->vval.v_number);
2839 else
2840 {
2841 char_u buf[MSG_BUF_LEN];
2842 char_u numbuf2[NUMBUFLEN];
2843 char_u *tofree;
2844 char_u *s;
2845
Bram Moolenaare38eab22019-12-05 21:50:01 +01002846 // The value may be very long. Skip the middle part, so that we
2847 // have some idea how it starts and ends. smsg() would always
2848 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 ++emsg_off;
2850 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2851 --emsg_off;
2852 if (s != NULL)
2853 {
2854 if (vim_strsize(s) > MSG_BUF_CLEN)
2855 {
2856 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2857 s = buf;
2858 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002859 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 vim_free(tofree);
2861 }
2862 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002863 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864
2865 verbose_leave_scroll();
2866 --no_wait_return;
2867 }
2868
Bram Moolenaare31ee862020-01-07 20:59:34 +01002869 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002870 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002871 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002872#ifdef FEAT_PROFILE
2873 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002874 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002876 if (using_sandbox)
2877 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002879 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880 {
2881 ++no_wait_return;
2882 verbose_enter_scroll();
2883
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002884 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002885 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002886
2887 verbose_leave_scroll();
2888 --no_wait_return;
2889 }
2890
2891 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002892 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002893 for (i = 0; i < tv_to_free_len; ++i)
2894 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002895 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896}
2897
2898/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002899 * Check the argument count for user function "fp".
2900 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2901 */
2902 int
2903check_user_func_argcount(ufunc_T *fp, int argcount)
2904{
2905 int regular_args = fp->uf_args.ga_len;
2906
2907 if (argcount < regular_args - fp->uf_def_args.ga_len)
2908 return FCERR_TOOFEW;
2909 else if (!has_varargs(fp) && argcount > regular_args)
2910 return FCERR_TOOMANY;
2911 return FCERR_UNKNOWN;
2912}
2913
2914/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002915 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002916 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002917 int
2918call_user_func_check(
2919 ufunc_T *fp,
2920 int argcount,
2921 typval_T *argvars,
2922 typval_T *rettv,
2923 funcexe_T *funcexe,
2924 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002925{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002926 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002927
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002928 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2929 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002930 error = check_user_func_argcount(fp, argcount);
2931 if (error != FCERR_UNKNOWN)
2932 return error;
2933 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002934 error = FCERR_DICT;
2935 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002936 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002937 int did_save_redo = FALSE;
2938 save_redo_T save_redo;
2939
2940 /*
2941 * Call the user function.
2942 * Save and restore search patterns, script variables and
2943 * redo buffer.
2944 */
2945 save_search_patterns();
2946 if (!ins_compl_active())
2947 {
2948 saveRedobuff(&save_redo);
2949 did_save_redo = TRUE;
2950 }
2951 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002952 call_user_func(fp, argcount, argvars, rettv, funcexe,
2953 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002954 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2955 // Function was unreferenced while being used, free it now.
2956 func_clear_free(fp, FALSE);
2957 if (did_save_redo)
2958 restoreRedobuff(&save_redo);
2959 restore_search_patterns();
2960 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002961 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002962 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002963}
2964
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002965static funccal_entry_T *funccal_stack = NULL;
2966
2967/*
2968 * Save the current function call pointer, and set it to NULL.
2969 * Used when executing autocommands and for ":source".
2970 */
2971 void
2972save_funccal(funccal_entry_T *entry)
2973{
2974 entry->top_funccal = current_funccal;
2975 entry->next = funccal_stack;
2976 funccal_stack = entry;
2977 current_funccal = NULL;
2978}
2979
2980 void
2981restore_funccal(void)
2982{
2983 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002984 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002985 else
2986 {
2987 current_funccal = funccal_stack->top_funccal;
2988 funccal_stack = funccal_stack->next;
2989 }
2990}
2991
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002992 funccall_T *
2993get_current_funccal(void)
2994{
2995 return current_funccal;
2996}
2997
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002998/*
2999 * Mark all functions of script "sid" as deleted.
3000 */
3001 void
3002delete_script_functions(int sid)
3003{
3004 hashitem_T *hi;
3005 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003006 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003007 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003008 size_t len;
3009
3010 buf[0] = K_SPECIAL;
3011 buf[1] = KS_EXTRA;
3012 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003013 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003014 len = STRLEN(buf);
3015
Bram Moolenaarce658352020-07-31 23:47:12 +02003016 while (todo > 0)
3017 {
3018 todo = func_hashtab.ht_used;
3019 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3020 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003021 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003022 fp = HI2UF(hi);
3023 if (STRNCMP(fp->uf_name, buf, len) == 0)
3024 {
3025 int changed = func_hashtab.ht_changed;
3026
3027 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003028
3029 if (fp->uf_calls > 0)
3030 {
3031 // Function is executing, don't free it but do remove
3032 // it from the hashtable.
3033 if (func_remove(fp))
3034 fp->uf_refcount--;
3035 }
3036 else
3037 {
3038 func_clear(fp, TRUE);
3039 // When clearing a function another function can be
3040 // cleared as a side effect. When that happens start
3041 // over.
3042 if (changed != func_hashtab.ht_changed)
3043 break;
3044 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003045 }
3046 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003047 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003048 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003049}
3050
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051#if defined(EXITFREE) || defined(PROTO)
3052 void
3053free_all_functions(void)
3054{
3055 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003056 ufunc_T *fp;
3057 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003058 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003059 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060
Bram Moolenaare38eab22019-12-05 21:50:01 +01003061 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003062 while (current_funccal != NULL)
3063 {
3064 clear_tv(current_funccal->rettv);
3065 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003066 if (current_funccal == NULL && funccal_stack != NULL)
3067 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003068 }
3069
Bram Moolenaare38eab22019-12-05 21:50:01 +01003070 // First clear what the functions contain. Since this may lower the
3071 // reference count of a function, it may also free a function and change
3072 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003073 while (todo > 0)
3074 {
3075 todo = func_hashtab.ht_used;
3076 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3077 if (!HASHITEM_EMPTY(hi))
3078 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003079 // clear the def function index now
3080 fp = HI2UF(hi);
3081 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003082 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003083
Bram Moolenaare38eab22019-12-05 21:50:01 +01003084 // Only free functions that are not refcounted, those are
3085 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003086 if (func_name_refcount(fp->uf_name))
3087 ++skipped;
3088 else
3089 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003090 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003091 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003092 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003093 {
3094 skipped = 0;
3095 break;
3096 }
3097 }
3098 --todo;
3099 }
3100 }
3101
Bram Moolenaare38eab22019-12-05 21:50:01 +01003102 // Now actually free the functions. Need to start all over every time,
3103 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003104 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003105 while (func_hashtab.ht_used > skipped)
3106 {
3107 todo = func_hashtab.ht_used;
3108 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109 if (!HASHITEM_EMPTY(hi))
3110 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003111 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003112 // Only free functions that are not refcounted, those are
3113 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003114 fp = HI2UF(hi);
3115 if (func_name_refcount(fp->uf_name))
3116 ++skipped;
3117 else
3118 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003119 if (func_free(fp, FALSE) == OK)
3120 {
3121 skipped = 0;
3122 break;
3123 }
3124 // did not actually free it
3125 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003126 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003128 }
3129 if (skipped == 0)
3130 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003131
3132 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133}
3134#endif
3135
3136/*
3137 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003138 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3139 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003140 * "len" is the length of "name", or -1 for NUL terminated.
3141 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003142 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143builtin_function(char_u *name, int len)
3144{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003145 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003146
Bram Moolenaara26b9702020-04-18 19:53:28 +02003147 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003149 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3150 {
3151 if (name[i] == AUTOLOAD_CHAR)
3152 return FALSE;
3153 if (!eval_isnamec(name[i]))
3154 {
3155 // "name.something" is not a builtin function
3156 if (name[i] == '.')
3157 return FALSE;
3158 break;
3159 }
3160 }
3161 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162}
3163
3164 int
3165func_call(
3166 char_u *name,
3167 typval_T *args,
3168 partial_T *partial,
3169 dict_T *selfdict,
3170 typval_T *rettv)
3171{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003172 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003173 listitem_T *item;
3174 typval_T argv[MAX_FUNC_ARGS + 1];
3175 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003176 int r = 0;
3177
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003178 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003179 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180 {
3181 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3182 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003183 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 break;
3185 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003186 // Make a copy of each argument. This is needed to be able to set
3187 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003188 copy_tv(&item->li_tv, &argv[argc++]);
3189 }
3190
3191 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003192 {
3193 funcexe_T funcexe;
3194
Bram Moolenaara80faa82020-04-12 19:37:17 +02003195 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003196 funcexe.fe_firstline = curwin->w_cursor.lnum;
3197 funcexe.fe_lastline = curwin->w_cursor.lnum;
3198 funcexe.fe_evaluate = TRUE;
3199 funcexe.fe_partial = partial;
3200 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003201 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3202 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203
Bram Moolenaare38eab22019-12-05 21:50:01 +01003204 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003205 while (argc > 0)
3206 clear_tv(&argv[--argc]);
3207
3208 return r;
3209}
3210
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003211static int callback_depth = 0;
3212
3213 int
3214get_callback_depth(void)
3215{
3216 return callback_depth;
3217}
3218
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003219/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003220 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003221 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003222 */
3223 int
3224call_callback(
3225 callback_T *callback,
3226 int len, // length of "name" or -1 to use strlen()
3227 typval_T *rettv, // return value goes here
3228 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003229 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003230 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003231{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003232 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003233 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003234
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003235 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3236 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003237 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003238 funcexe.fe_evaluate = TRUE;
3239 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003240 ++callback_depth;
3241 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3242 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003243
3244 // When a :def function was called that uses :try an error would be turned
3245 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003246 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003247 {
3248 need_rethrow = FALSE;
3249 handle_did_throw();
3250 }
3251
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003252 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003253}
3254
3255/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003256 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003257 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003258 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3259 */
3260 varnumber_T
3261call_callback_retnr(
3262 callback_T *callback,
3263 int argcount, // number of "argvars"
3264 typval_T *argvars) // vars for arguments, must have "argcount"
3265 // PLUS ONE elements!
3266{
3267 typval_T rettv;
3268 varnumber_T retval;
3269
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003270 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003271 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003272
3273 retval = tv_get_number_chk(&rettv, NULL);
3274 clear_tv(&rettv);
3275 return retval;
3276}
3277
3278/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 * Give an error message for the result of a function.
3280 * Nothing if "error" is FCERR_NONE.
3281 */
3282 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003283user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003284{
3285 switch (error)
3286 {
3287 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003288 if (funcexe->fe_found_var)
3289 semsg(_(e_not_callable_type_str), name);
3290 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003291 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003292 break;
3293 case FCERR_NOTMETHOD:
3294 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003295 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003296 break;
3297 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003298 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299 break;
3300 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003301 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003302 break;
3303 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003304 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003305 break;
3306 case FCERR_SCRIPT:
3307 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003308 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003309 break;
3310 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003311 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3312 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003313 break;
3314 }
3315}
3316
3317/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003319 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320 * Return FAIL when the function can't be called, OK otherwise.
3321 * Also returns OK when an error was encountered while executing the function.
3322 */
3323 int
3324call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003325 char_u *funcname, // name of the function
3326 int len, // length of "name" or -1 to use strlen()
3327 typval_T *rettv, // return value goes here
3328 int argcount_in, // number of "argvars"
3329 typval_T *argvars_in, // vars for arguments, must have "argcount"
3330 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003331 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332{
3333 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003334 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003336 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337 char_u fname_buf[FLEN_FIXED + 1];
3338 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003339 char_u *fname = NULL;
3340 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 int argcount = argcount_in;
3342 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003343 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003344 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003345 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003347 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003348 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003349 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003350 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003352 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3353 // even when call_func() returns FAIL.
3354 rettv->v_type = VAR_UNKNOWN;
3355
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003356 if (partial != NULL)
3357 fp = partial->pt_func;
3358 if (fp == NULL)
3359 {
3360 // Make a copy of the name, if it comes from a funcref variable it
3361 // could be changed or deleted in the called function.
3362 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3363 if (name == NULL)
3364 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003366 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3367 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003369 if (funcexe->fe_doesrange != NULL)
3370 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371
3372 if (partial != NULL)
3373 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003374 // When the function has a partial with a dict and there is a dict
3375 // argument, use the dict argument. That is backwards compatible.
3376 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003377 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003379 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 {
3381 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003382 {
3383 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3384 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003385 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003386 goto theend;
3387 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003389 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 for (i = 0; i < argcount_in; ++i)
3391 argv[i + argv_clear] = argvars_in[i];
3392 argvars = argv;
3393 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003394
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003395 if (funcexe->fe_check_type != NULL
3396 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003397 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003398 // Now funcexe->fe_check_type is missing the added arguments,
3399 // make a copy of the type with the correction.
3400 check_type = *funcexe->fe_check_type;
3401 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003402 check_type.tt_args = check_type_args;
3403 CLEAR_FIELD(check_type_args);
3404 for (i = 0; i < check_type.tt_argcount; ++i)
3405 check_type_args[i + partial->pt_argc] =
3406 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003407 check_type.tt_argcount += partial->pt_argc;
3408 check_type.tt_min_argcount += partial->pt_argc;
3409 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 }
3411 }
3412
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003413 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3414 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003415 {
3416 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003417 if (check_argument_types(funcexe->fe_check_type,
3418 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003419 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003420 error = FCERR_OTHER;
3421 }
3422
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003423 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 {
3425 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003426 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427
Bram Moolenaar333894b2020-08-01 18:53:07 +02003428 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003429 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003430 {
3431 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003432 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434
Bram Moolenaare38eab22019-12-05 21:50:01 +01003435 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003437 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003439 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 {
3441 /*
3442 * User defined function.
3443 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003444 if (fp == NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003445 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003446
Bram Moolenaare38eab22019-12-05 21:50:01 +01003447 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 if (fp == NULL
3449 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003450 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003451 && !aborting())
3452 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003453 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003454 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003456 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3458 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003459 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003460 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003462 if (fp == NULL)
3463 {
3464 char_u *p = untrans_function_name(rfname);
3465
3466 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003467 // Don't do this if the name starts with "s:".
3468 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003469 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003470 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003472 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003473 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003474#ifdef FEAT_LUA
3475 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3476 {
3477 cfunc_T cb = fp->uf_cb;
3478
3479 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3480 }
3481#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003482 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003483 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003484 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003485 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003486 argcount = funcexe->fe_argv_func(argcount, argvars,
3487 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003488
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003489 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003490 {
3491 // Method call: base->Method()
3492 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003493 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003494 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003495 argvars = argv;
3496 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003497 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003498
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003499 error = call_user_func_check(fp, argcount, argvars, rettv,
3500 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 }
3502 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003503 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003504 {
3505 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003506 * expr->method(): Find the method name in the table, call its
3507 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003508 */
3509 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003510 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003511 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512 else
3513 {
3514 /*
3515 * Find the function name in the table, call its implementation.
3516 */
3517 error = call_internal_func(fname, argcount, argvars, rettv);
3518 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003519
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 /*
3521 * The function call (or "FuncUndefined" autocommand sequence) might
3522 * have been aborted by an error, an interrupt, or an explicitly thrown
3523 * exception that has not been caught so far. This situation can be
3524 * tested for by calling aborting(). For an error in an internal
3525 * function or for the "E132" error in call_user_func(), however, the
3526 * throw point at which the "force_abort" flag (temporarily reset by
3527 * emsg()) is normally updated has not been reached yet. We need to
3528 * update that flag first to make aborting() reliable.
3529 */
3530 update_force_abort();
3531 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003532 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 ret = OK;
3534
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003535theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 /*
3537 * Report an error unless the argument evaluation or function call has been
3538 * cancelled due to an aborting error, an interrupt, or an exception.
3539 */
3540 if (!aborting())
3541 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003542 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 }
3544
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003545 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003547 clear_tv(&argv[--argv_clear + argv_base]);
3548
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 vim_free(tofree);
3550 vim_free(name);
3551
3552 return ret;
3553}
3554
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003555 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003556printable_func_name(ufunc_T *fp)
3557{
3558 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3559}
3560
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003562 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 */
3564 static void
3565list_func_head(ufunc_T *fp, int indent)
3566{
3567 int j;
3568
3569 msg_start();
3570 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003571 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003572 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003573 msg_puts("def ");
3574 else
3575 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003576 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 msg_putchar('(');
3578 for (j = 0; j < fp->uf_args.ga_len; ++j)
3579 {
3580 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003581 msg_puts(", ");
3582 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003583 if (fp->uf_arg_types != NULL)
3584 {
3585 char *tofree;
3586
3587 msg_puts(": ");
3588 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3589 vim_free(tofree);
3590 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003591 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3592 {
3593 msg_puts(" = ");
3594 msg_puts(((char **)(fp->uf_def_args.ga_data))
3595 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3596 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 }
3598 if (fp->uf_varargs)
3599 {
3600 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003601 msg_puts(", ");
3602 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003604 if (fp->uf_va_name != NULL)
3605 {
3606 if (j)
3607 msg_puts(", ");
3608 msg_puts("...");
3609 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003610 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003611 {
3612 char *tofree;
3613
3614 msg_puts(": ");
3615 msg_puts(type_name(fp->uf_va_type, &tofree));
3616 vim_free(tofree);
3617 }
3618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003620
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003621 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003622 {
3623 if (fp->uf_ret_type != &t_void)
3624 {
3625 char *tofree;
3626
3627 msg_puts(": ");
3628 msg_puts(type_name(fp->uf_ret_type, &tofree));
3629 vim_free(tofree);
3630 }
3631 }
3632 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003633 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003635 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003637 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003638 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003639 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640 msg_clr_eos();
3641 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003642 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003643}
3644
3645/*
3646 * Get a function name, translating "<SID>" and "<SNR>".
3647 * Also handles a Funcref in a List or Dictionary.
3648 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003649 * Set "*is_global" to TRUE when the function must be global, unless
3650 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 * flags:
3652 * TFN_INT: internal function name OK
3653 * TFN_QUIET: be quiet
3654 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003655 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003656 * Advances "pp" to just after the function name (if no error).
3657 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003658 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659trans_function_name(
3660 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003661 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003662 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003664 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003665 partial_T **partial, // return: partial of a FuncRef
3666 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667{
3668 char_u *name = NULL;
3669 char_u *start;
3670 char_u *end;
3671 int lead;
3672 char_u sid_buf[20];
3673 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003674 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003676 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677
3678 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003679 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680 start = *pp;
3681
Bram Moolenaare38eab22019-12-05 21:50:01 +01003682 // Check for hard coded <SNR>: already translated function ID (from a user
3683 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3685 && (*pp)[2] == (int)KE_SNR)
3686 {
3687 *pp += 3;
3688 len = get_id_len(pp) + 3;
3689 return vim_strnsave(start, len);
3690 }
3691
Bram Moolenaare38eab22019-12-05 21:50:01 +01003692 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3693 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 lead = eval_fname_script(start);
3695 if (lead > 2)
3696 start += lead;
3697
Bram Moolenaare38eab22019-12-05 21:50:01 +01003698 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003699 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaare6a42002022-01-21 10:32:58 +00003701 if (end == start || (in_vim9script() && end != NULL
3702 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 {
3704 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003705 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003706 goto theend;
3707 }
3708 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3709 {
3710 /*
3711 * Report an invalid expression in braces, unless the expression
3712 * evaluation has been cancelled due to an aborting error, an
3713 * interrupt, or an exception.
3714 */
3715 if (!aborting())
3716 {
3717 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003718 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719 }
3720 else
3721 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3722 goto theend;
3723 }
3724
3725 if (lv.ll_tv != NULL)
3726 {
3727 if (fdp != NULL)
3728 {
3729 fdp->fd_dict = lv.ll_dict;
3730 fdp->fd_newkey = lv.ll_newkey;
3731 lv.ll_newkey = NULL;
3732 fdp->fd_di = lv.ll_di;
3733 }
3734 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3735 {
3736 name = vim_strsave(lv.ll_tv->vval.v_string);
3737 *pp = end;
3738 }
3739 else if (lv.ll_tv->v_type == VAR_PARTIAL
3740 && lv.ll_tv->vval.v_partial != NULL)
3741 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003742 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 *pp = end;
3744 if (partial != NULL)
3745 *partial = lv.ll_tv->vval.v_partial;
3746 }
3747 else
3748 {
3749 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3750 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003751 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752 else
3753 *pp = end;
3754 name = NULL;
3755 }
3756 goto theend;
3757 }
3758
3759 if (lv.ll_name == NULL)
3760 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003761 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003762 *pp = end;
3763 goto theend;
3764 }
3765
Bram Moolenaare38eab22019-12-05 21:50:01 +01003766 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 if (lv.ll_exp_name != NULL)
3768 {
3769 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003770 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003771 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 if (name == lv.ll_exp_name)
3773 name = NULL;
3774 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003775 else if (lv.ll_sid > 0)
3776 {
3777 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3778 int cc = *lv.ll_name_end;
3779
3780 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3781 *lv.ll_name_end = NUL;
3782 if (si->sn_autoload_prefix != NULL)
3783 {
3784 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3785 }
3786 else
3787 {
3788 sid_buf[0] = K_SPECIAL;
3789 sid_buf[1] = KS_EXTRA;
3790 sid_buf[2] = (int)KE_SNR;
3791 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
3792 "%ld_", (long)current_sctx.sc_sid);
3793 name = concat_str(sid_buf, lv.ll_name);
3794 }
3795 *lv.ll_name_end = cc;
3796 *pp = end;
3797 goto theend;
3798 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003799 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 {
3801 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003802 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003803 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 if (name == *pp)
3805 name = NULL;
3806 }
3807 if (name != NULL)
3808 {
3809 name = vim_strsave(name);
3810 *pp = end;
3811 if (STRNCMP(name, "<SNR>", 5) == 0)
3812 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003813 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 name[0] = K_SPECIAL;
3815 name[1] = KS_EXTRA;
3816 name[2] = (int)KE_SNR;
3817 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3818 }
3819 goto theend;
3820 }
3821
3822 if (lv.ll_exp_name != NULL)
3823 {
3824 len = (int)STRLEN(lv.ll_exp_name);
3825 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3826 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3827 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003828 // When there was "s:" already or the name expanded to get a
3829 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 lv.ll_name += 2;
3831 len -= 2;
3832 lead = 2;
3833 }
3834 }
3835 else
3836 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003837 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003839 {
3840 if (is_global != NULL && lv.ll_name[0] == 'g')
3841 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003843 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 len = (int)(end - lv.ll_name);
3845 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003846 if (len <= 0)
3847 {
3848 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003849 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003850 goto theend;
3851 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003853 // In Vim9 script a user function is script-local by default, unless it
3854 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003855 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003856 if (vim9script)
3857 {
3858 char_u *p;
3859
3860 // SomeScript#func() is a global function.
3861 for (p = start; *p != NUL && *p != '('; ++p)
3862 if (*p == AUTOLOAD_CHAR)
3863 vim9script = FALSE;
3864 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003865
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866 /*
3867 * Copy the function name to allocated memory.
3868 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3869 * Accept <SNR>123_name() outside a script.
3870 */
3871 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003872 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003873 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003874 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003875 if (!vim9script)
3876 lead = 3;
3877 if (vim9script || (lv.ll_exp_name != NULL
3878 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879 || eval_fname_sid(*pp))
3880 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003881 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003882 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003883 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003884 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885 goto theend;
3886 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003887 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003888 if (vim9script)
3889 extra = 3 + (int)STRLEN(sid_buf);
3890 else
3891 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 }
3893 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003894 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3895 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003896 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003897 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003898 goto theend;
3899 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003900 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901 {
3902 char_u *cp = vim_strchr(lv.ll_name, ':');
3903
3904 if (cp != NULL && cp < end)
3905 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003906 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907 goto theend;
3908 }
3909 }
3910
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003911 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003912 if (name != NULL)
3913 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003914 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 {
3916 name[0] = K_SPECIAL;
3917 name[1] = KS_EXTRA;
3918 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003919 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 STRCPY(name + 3, sid_buf);
3921 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003922 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3923 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924 }
3925 *pp = end;
3926
3927theend:
3928 clear_lval(&lv);
3929 return name;
3930}
3931
3932/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003933 * Assuming "name" is the result of trans_function_name() and it was prefixed
3934 * to use the script-local name, return the unmodified name (points into
3935 * "name"). Otherwise return NULL.
3936 * This can be used to first search for a script-local function and fall back
3937 * to the global function if not found.
3938 */
3939 char_u *
3940untrans_function_name(char_u *name)
3941{
3942 char_u *p;
3943
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003944 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003945 {
3946 p = vim_strchr(name, '_');
3947 if (p != NULL)
3948 return p + 1;
3949 }
3950 return NULL;
3951}
3952
3953/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003954 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3955 * current script ID and returns the expanded function name. The caller should
3956 * free the returned name. If not called from a script context or the function
3957 * name doesn't start with these prefixes, then returns NULL.
3958 * This doesn't check whether the script-local function exists or not.
3959 */
3960 char_u *
3961get_scriptlocal_funcname(char_u *funcname)
3962{
3963 char sid_buf[25];
3964 int off;
3965 char_u *newname;
3966
3967 if (funcname == NULL)
3968 return NULL;
3969
3970 if (STRNCMP(funcname, "s:", 2) != 0
3971 && STRNCMP(funcname, "<SID>", 5) != 0)
3972 // The function name is not a script-local function name
3973 return NULL;
3974
3975 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3976 {
3977 emsg(_(e_using_sid_not_in_script_context));
3978 return NULL;
3979 }
3980 // Expand s: prefix into <SNR>nr_<name>
3981 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3982 (long)current_sctx.sc_sid);
3983 off = *funcname == 's' ? 2 : 5;
3984 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3985 if (newname == NULL)
3986 return NULL;
3987 STRCPY(newname, sid_buf);
3988 STRCAT(newname, funcname + off);
3989
3990 return newname;
3991}
3992
3993/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003994 * Call trans_function_name(), except that a lambda is returned as-is.
3995 * Returns the name in allocated memory.
3996 */
3997 char_u *
3998save_function_name(
3999 char_u **name,
4000 int *is_global,
4001 int skip,
4002 int flags,
4003 funcdict_T *fudi)
4004{
4005 char_u *p = *name;
4006 char_u *saved;
4007
4008 if (STRNCMP(p, "<lambda>", 8) == 0)
4009 {
4010 p += 8;
4011 (void)getdigits(&p);
4012 saved = vim_strnsave(*name, p - *name);
4013 if (fudi != NULL)
4014 CLEAR_POINTER(fudi);
4015 }
4016 else
4017 saved = trans_function_name(&p, is_global, skip,
4018 flags, fudi, NULL, NULL);
4019 *name = p;
4020 return saved;
4021}
4022
4023/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004024 * List functions. When "regmatch" is NULL all of then.
4025 * Otherwise functions matching "regmatch".
4026 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004027 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004028list_functions(regmatch_T *regmatch)
4029{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004030 int changed = func_hashtab.ht_changed;
4031 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004032 hashitem_T *hi;
4033
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004034 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004035 {
4036 if (!HASHITEM_EMPTY(hi))
4037 {
4038 ufunc_T *fp = HI2UF(hi);
4039
4040 --todo;
4041 if ((fp->uf_flags & FC_DEAD) == 0
4042 && (regmatch == NULL
4043 ? !message_filtered(fp->uf_name)
4044 && !func_name_refcount(fp->uf_name)
4045 : !isdigit(*fp->uf_name)
4046 && vim_regexec(regmatch, fp->uf_name, 0)))
4047 {
4048 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004049 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004050 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004051 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004052 return;
4053 }
4054 }
4055 }
4056 }
4057}
4058
4059/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004060 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004061 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4062 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004063 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004064 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004066 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004067define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 int j;
4070 int c;
4071 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004072 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004073 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 char_u *p;
4075 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004076 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 char_u *line_arg = NULL;
4078 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004079 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004080 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 garray_T newlines;
4082 int varargs = FALSE;
4083 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004084 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004085 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004086 int fp_allocated = FALSE;
4087 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004088 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089 dictitem_T *v;
4090 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004091 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004094 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004095 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004096 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097
4098 /*
4099 * ":function" without argument: list functions.
4100 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004101 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 {
4103 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004104 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004105 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004106 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 }
4108
4109 /*
4110 * ":function /pat": list functions matching pattern.
4111 */
4112 if (*eap->arg == '/')
4113 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004114 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115 if (!eap->skip)
4116 {
4117 regmatch_T regmatch;
4118
4119 c = *p;
4120 *p = NUL;
4121 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4122 *p = c;
4123 if (regmatch.regprog != NULL)
4124 {
4125 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004126 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004127 vim_regfree(regmatch.regprog);
4128 }
4129 }
4130 if (*p == '/')
4131 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004132 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004133 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134 }
4135
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004136 ga_init(&newargs);
4137 ga_init(&argtypes);
4138 ga_init(&default_args);
4139
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140 /*
4141 * Get the function name. There are these situations:
4142 * func normal function name
4143 * "name" == func, "fudi.fd_dict" == NULL
4144 * dict.func new dictionary entry
4145 * "name" == NULL, "fudi.fd_dict" set,
4146 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4147 * dict.func existing dict entry with a Funcref
4148 * "name" == func, "fudi.fd_dict" set,
4149 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4150 * dict.func existing dict entry that's not a Funcref
4151 * "name" == NULL, "fudi.fd_dict" set,
4152 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4153 * s:func script-local function name
4154 * g:func global function name, same as "func"
4155 */
4156 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004157 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004159 // nested function, argument is (args).
4160 paren = TRUE;
4161 CLEAR_FIELD(fudi);
4162 }
4163 else
4164 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004165 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004166 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004167 paren = (vim_strchr(p, '(') != NULL);
4168 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004170 /*
4171 * Return on an invalid expression in braces, unless the expression
4172 * evaluation has been cancelled due to an aborting error, an
4173 * interrupt, or an exception.
4174 */
4175 if (!aborting())
4176 {
4177 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004178 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004179 vim_free(fudi.fd_newkey);
4180 return NULL;
4181 }
4182 else
4183 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004185
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004186 // For "export def FuncName()" in an autoload script the function name
4187 // is stored with the legacy autoload name "dir#script#FuncName" so
4188 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004189 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004190 {
4191 char_u *prefixed = may_prefix_autoload(name);
4192
4193 if (prefixed != NULL && prefixed != name)
4194 {
4195 vim_free(name);
4196 name = prefixed;
4197 }
4198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199 }
4200
Bram Moolenaare38eab22019-12-05 21:50:01 +01004201 // An error in a function call during evaluation of an expression in magic
4202 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203 saved_did_emsg = did_emsg;
4204 did_emsg = FALSE;
4205
4206 /*
4207 * ":function func" with only function name: list function.
4208 */
4209 if (!paren)
4210 {
4211 if (!ends_excmd(*skipwhite(p)))
4212 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004213 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 goto ret_free;
4215 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004216 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217 if (eap->nextcmd != NULL)
4218 *p = NUL;
4219 if (!eap->skip && !got_int)
4220 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004221 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004222 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4223 {
4224 char_u *up = untrans_function_name(name);
4225
4226 // With Vim9 script the name was made script-local, if not
4227 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004228 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004229 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004230 }
4231
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232 if (fp != NULL)
4233 {
4234 list_func_head(fp, TRUE);
4235 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4236 {
4237 if (FUNCLINE(fp, j) == NULL)
4238 continue;
4239 msg_putchar('\n');
4240 msg_outnum((long)(j + 1));
4241 if (j < 9)
4242 msg_putchar(' ');
4243 if (j < 99)
4244 msg_putchar(' ');
4245 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004246 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247 ui_breakcheck();
4248 }
4249 if (!got_int)
4250 {
4251 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004252 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004253 msg_puts(" enddef");
4254 else
4255 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256 }
4257 }
4258 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004259 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260 }
4261 goto ret_free;
4262 }
4263
4264 /*
4265 * ":function name(arg1, arg2)" Define function.
4266 */
4267 p = skipwhite(p);
4268 if (*p != '(')
4269 {
4270 if (!eap->skip)
4271 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004272 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 goto ret_free;
4274 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004275 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276 if (vim_strchr(p, '(') != NULL)
4277 p = vim_strchr(p, '(');
4278 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004280 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4281 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004282 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004283 goto ret_free;
4284 }
4285
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004286 // In Vim9 script only global functions can be redefined.
4287 if (vim9script && eap->forceit && !is_global)
4288 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004289 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004290 goto ret_free;
4291 }
4292
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004293 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294
Bram Moolenaar04b12692020-05-04 23:24:44 +02004295 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004297 // Check the name of the function. Unless it's a dictionary function
4298 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 if (name != NULL)
4300 arg = name;
4301 else
4302 arg = fudi.fd_newkey;
4303 if (arg != NULL && (fudi.fd_di == NULL
4304 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4305 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4306 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004307 char_u *name_base = arg;
4308 int i;
4309
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004311 {
4312 name_base = vim_strchr(arg, '_');
4313 if (name_base == NULL)
4314 name_base = arg + 3;
4315 else
4316 ++name_base;
4317 }
4318 for (i = 0; name_base[i] != NUL && (i == 0
4319 ? eval_isnamec1(name_base[i])
4320 : eval_isnamec(name_base[i])); ++i)
4321 ;
4322 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004323 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004324
4325 // In Vim9 script a function cannot have the same name as a
4326 // variable.
4327 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004328 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4329 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004330 + EVAL_VAR_NO_FUNC) == OK)
4331 {
4332 semsg(_(e_redefining_script_item_str), name_base);
4333 goto ret_free;
4334 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004336 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004338 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004339 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004340 goto ret_free;
4341 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004342 }
4343
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004344 // This may get more lines and make the pointers into the first line
4345 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004346 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004347 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004348 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004349 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004350 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004352 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004354 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004356 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004357 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004359 if (*p != ':')
4360 {
4361 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4362 p = skipwhite(p);
4363 }
4364 else if (!IS_WHITE_OR_NUL(p[1]))
4365 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004366 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004367 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004368 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004369 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004370 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004371 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004372 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004373 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004374 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004375 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004376 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004377 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004378 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004379 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004380 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004381 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004382 else
4383 // find extra arguments "range", "dict", "abort" and "closure"
4384 for (;;)
4385 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004386 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004387 p = skipwhite(p);
4388 if (STRNCMP(p, "range", 5) == 0)
4389 {
4390 flags |= FC_RANGE;
4391 p += 5;
4392 }
4393 else if (STRNCMP(p, "dict", 4) == 0)
4394 {
4395 flags |= FC_DICT;
4396 p += 4;
4397 }
4398 else if (STRNCMP(p, "abort", 5) == 0)
4399 {
4400 flags |= FC_ABORT;
4401 p += 5;
4402 }
4403 else if (STRNCMP(p, "closure", 7) == 0)
4404 {
4405 flags |= FC_CLOSURE;
4406 p += 7;
4407 if (current_funccal == NULL)
4408 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004409 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004410 name == NULL ? (char_u *)"" : name);
4411 goto erret;
4412 }
4413 }
4414 else
4415 break;
4416 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004417
Bram Moolenaare38eab22019-12-05 21:50:01 +01004418 // When there is a line break use what follows for the function body.
4419 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 if (*p == '\n')
4421 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004422 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004423 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4424 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004425 && !(VIM_ISWHITE(*whitep) && *p == '#'
4426 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004427 && !eap->skip
4428 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004429 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004430
4431 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004432 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4433 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 */
4435 if (KeyTyped)
4436 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004437 // Check if the function already exists, don't let the user type the
4438 // whole function before telling him it doesn't work! For a script we
4439 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 if (!eap->skip && !eap->forceit)
4441 {
4442 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004443 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004444 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004445 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 }
4447
4448 if (!eap->skip && did_emsg)
4449 goto erret;
4450
Bram Moolenaare38eab22019-12-05 21:50:01 +01004451 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 cmdline_row = msg_row;
4453 }
4454
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004455 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004456 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004457
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004458 // Do not define the function when getting the body fails and when
4459 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004460 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004461 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462 goto erret;
4463
4464 /*
4465 * If there are no errors, add the function
4466 */
4467 if (fudi.fd_dict == NULL)
4468 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004469 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004470 char_u *find_name = name;
4471 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004472 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004473
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004474 v = find_var(name, &ht, TRUE);
Bram Moolenaar6f0ddbf2022-01-20 19:56:49 +00004475 if (v != NULL && (in_vim9script() || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004476 var_conflict = TRUE;
4477
4478 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4479 {
4480 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4481
4482 if (si->sn_autoload_prefix != NULL)
4483 {
4484 if (is_export)
4485 {
4486 find_name = name + STRLEN(si->sn_autoload_prefix);
4487 v = find_var(find_name, &ht, TRUE);
4488 if (v != NULL)
4489 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004490 // Only check if the function already exists in the script,
4491 // global functions can be shadowed.
4492 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004493 }
4494 else
4495 {
4496 char_u *prefixed = may_prefix_autoload(name);
4497
4498 if (prefixed != NULL)
4499 {
4500 v = find_var(prefixed, &ht, TRUE);
4501 if (v != NULL)
4502 var_conflict = TRUE;
4503 vim_free(prefixed);
4504 }
4505 }
4506 }
Bram Moolenaar19e69a62022-01-21 20:37:05 +00004507 else if (vim9script && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4508 {
4509 semsg(_(e_using_autoload_name_in_non_autoload_script_str),
4510 name);
4511 goto erret;
4512 }
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004513 }
4514 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004516 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517 goto erret;
4518 }
4519
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004520 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004521 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004522 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004523 char_u *uname = untrans_function_name(name);
4524
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004525 import = find_imported(uname == NULL ? name : uname, 0,
4526 FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004527 }
4528
4529 if (fp != NULL || import != NULL)
4530 {
4531 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004532
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004533 // Function can be replaced with "function!" and when sourcing the
4534 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004535 // A name that is used by an import can not be overruled.
4536 if (import != NULL
4537 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004538 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004539 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004540 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004541 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004542 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004543 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004544 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004545 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546 goto erret;
4547 }
4548 if (fp->uf_calls > 0)
4549 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004550 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004551 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 goto erret;
4553 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004554 if (fp->uf_refcount > 1)
4555 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004556 // This function is referenced somewhere, don't redefine it but
4557 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004558 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004559 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004560 fp = NULL;
4561 overwrite = TRUE;
4562 }
4563 else
4564 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004565 char_u *exp_name = fp->uf_name_exp;
4566
4567 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004568 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004569 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004570 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004571 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004572 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004573#ifdef FEAT_PROFILE
4574 fp->uf_profiling = FALSE;
4575 fp->uf_prof_initialized = FALSE;
4576#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004577 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004578 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579 }
4580 }
4581 else
4582 {
4583 char numbuf[20];
4584
4585 fp = NULL;
4586 if (fudi.fd_newkey == NULL && !eap->forceit)
4587 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004588 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004589 goto erret;
4590 }
4591 if (fudi.fd_di == NULL)
4592 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004593 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004594 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595 goto erret;
4596 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004597 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004598 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599 goto erret;
4600
Bram Moolenaare38eab22019-12-05 21:50:01 +01004601 // Give the function a sequential number. Can only be used with a
4602 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 vim_free(name);
4604 sprintf(numbuf, "%d", ++func_nr);
4605 name = vim_strsave((char_u *)numbuf);
4606 if (name == NULL)
4607 goto erret;
4608 }
4609
4610 if (fp == NULL)
4611 {
4612 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4613 {
4614 int slen, plen;
4615 char_u *scriptname;
4616
Bram Moolenaare38eab22019-12-05 21:50:01 +01004617 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004618 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004619 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004620 {
4621 scriptname = autoload_name(name);
4622 if (scriptname != NULL)
4623 {
4624 p = vim_strchr(scriptname, '/');
4625 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004626 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004628 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004629 j = OK;
4630 vim_free(scriptname);
4631 }
4632 }
4633 if (j == FAIL)
4634 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004635 linenr_T save_lnum = SOURCING_LNUM;
4636
4637 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004638 semsg(_(e_function_name_does_not_match_script_file_name_str),
4639 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004640 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004641 goto erret;
4642 }
4643 }
4644
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004645 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004646 if (fp == NULL)
4647 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004648 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649
4650 if (fudi.fd_dict != NULL)
4651 {
4652 if (fudi.fd_di == NULL)
4653 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004654 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4656 if (fudi.fd_di == NULL)
4657 {
4658 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004659 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004660 goto erret;
4661 }
4662 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4663 {
4664 vim_free(fudi.fd_di);
4665 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004666 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 goto erret;
4668 }
4669 }
4670 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004671 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 clear_tv(&fudi.fd_di->di_tv);
4673 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675
Bram Moolenaare38eab22019-12-05 21:50:01 +01004676 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004677 flags |= FC_DICT;
4678 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679 }
4680 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004681 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004682 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004683 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004684
4685 if (eap->cmdidx == CMD_def)
4686 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004687 int lnum_save = SOURCING_LNUM;
4688 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004689
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004690 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004691
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004692 // error messages are for the first function line
4693 SOURCING_LNUM = sourcing_lnum_top;
4694
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004695 // The function may use script variables from the context.
4696 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004697
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004698 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004699 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004700 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004701 free_fp = fp_allocated;
4702 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004703 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004704 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004705
4706 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004707 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004708 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004709 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004710 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004711 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004712 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004713 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004714 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004715 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004716 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004717
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004718 if (fp_allocated)
4719 {
4720 // insert the new function in the function list
4721 set_ufunc_name(fp, name);
4722 if (overwrite)
4723 {
4724 hi = hash_find(&func_hashtab, name);
4725 hi->hi_key = UF2HIKEY(fp);
4726 }
4727 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4728 {
4729 free_fp = TRUE;
4730 goto erret;
4731 }
4732 fp->uf_refcount = 1;
4733 }
4734
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004736 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004737 if ((flags & FC_CLOSURE) != 0)
4738 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004739 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004740 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004741 }
4742 else
4743 fp->uf_scoped = NULL;
4744
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 if (prof_def_func())
4747 func_do_profile(fp);
4748#endif
4749 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004750 if (sandbox)
4751 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004752 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004753 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 fp->uf_flags = flags;
4755 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004756 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004757 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004758 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004759 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004760 if (is_export)
4761 {
4762 fp->uf_flags |= FC_EXPORT;
4763 // let ex_export() know the export worked.
4764 is_export = FALSE;
4765 }
4766
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004767 if (eap->cmdidx == CMD_def)
4768 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004769 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4770 // :func does not use Vim9 script syntax, even in a Vim9 script file
4771 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004772
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773 goto ret_free;
4774
4775erret:
4776 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004777 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004778 if (fp != NULL)
4779 {
4780 ga_init(&fp->uf_args);
4781 ga_init(&fp->uf_def_args);
4782 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783errret_2:
4784 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004785 if (fp != NULL)
4786 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004787 if (free_fp)
4788 {
4789 vim_free(fp);
4790 fp = NULL;
4791 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004792ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004793 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004794 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004795 if (name != name_arg)
4796 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004797 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004798 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004799
4800 return fp;
4801}
4802
4803/*
4804 * ":function"
4805 */
4806 void
4807ex_function(exarg_T *eap)
4808{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004809 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004810
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004811 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4812 (void)define_function(eap, NULL, &lines_to_free);
4813 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004814}
4815
4816/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004817 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004818 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004819 */
4820 void
4821ex_defcompile(exarg_T *eap UNUSED)
4822{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004823 long todo = (long)func_hashtab.ht_used;
4824 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004825 hashitem_T *hi;
4826 ufunc_T *ufunc;
4827
4828 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4829 {
4830 if (!HASHITEM_EMPTY(hi))
4831 {
4832 --todo;
4833 ufunc = HI2UF(hi);
4834 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004835 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4836 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004837 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004838 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004839
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004840 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004841 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004842 // a function has been added or removed, need to start over
4843 todo = (long)func_hashtab.ht_used;
4844 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004845 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004846 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004847 }
4848 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004849 }
4850 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004851}
4852
4853/*
4854 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4855 * Return 2 if "p" starts with "s:".
4856 * Return 0 otherwise.
4857 */
4858 int
4859eval_fname_script(char_u *p)
4860{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004861 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4862 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4864 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4865 return 5;
4866 if (p[0] == 's' && p[1] == ':')
4867 return 2;
4868 return 0;
4869}
4870
4871 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004872translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873{
4874 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004875 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004876 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004877}
4878
4879/*
4880 * Return TRUE when "ufunc" has old-style "..." varargs
4881 * or named varargs "...name: type".
4882 */
4883 int
4884has_varargs(ufunc_T *ufunc)
4885{
4886 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004887}
4888
4889/*
4890 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004891 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 */
4893 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004894function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895{
4896 char_u *nm = name;
4897 char_u *p;
4898 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004899 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004900 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004902 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4903 if (no_deref)
4904 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004905 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906 nm = skipwhite(nm);
4907
Bram Moolenaare38eab22019-12-05 21:50:01 +01004908 // Only accept "funcname", "funcname ", "funcname (..." and
4909 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004911 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912 vim_free(p);
4913 return n;
4914}
4915
Bram Moolenaar113e1072019-01-20 15:30:40 +01004916#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004917 char_u *
4918get_expanded_name(char_u *name, int check)
4919{
4920 char_u *nm = name;
4921 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004922 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004924 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004925 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004926
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004927 if (p != NULL && *nm == NUL
4928 && (!check || translated_function_exists(p, is_global)))
4929 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930
4931 vim_free(p);
4932 return NULL;
4933}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004934#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936/*
4937 * Function given to ExpandGeneric() to obtain the list of user defined
4938 * function names.
4939 */
4940 char_u *
4941get_user_func_name(expand_T *xp, int idx)
4942{
4943 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004944 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 static hashitem_T *hi;
4946 ufunc_T *fp;
4947
4948 if (idx == 0)
4949 {
4950 done = 0;
4951 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004952 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004954 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955 {
4956 if (done++ > 0)
4957 ++hi;
4958 while (HASHITEM_EMPTY(hi))
4959 ++hi;
4960 fp = HI2UF(hi);
4961
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004962 // don't show dead, dict and lambda functions
4963 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004964 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004965 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966
4967 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004968 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969
4970 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004971 if (xp->xp_context != EXPAND_USER_FUNC
4972 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973 {
4974 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004975 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004976 STRCAT(IObuff, ")");
4977 }
4978 return IObuff;
4979 }
4980 return NULL;
4981}
4982
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004983/*
4984 * ":delfunction {name}"
4985 */
4986 void
4987ex_delfunction(exarg_T *eap)
4988{
4989 ufunc_T *fp = NULL;
4990 char_u *p;
4991 char_u *name;
4992 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004993 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004994
4995 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004996 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4997 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004998 vim_free(fudi.fd_newkey);
4999 if (name == NULL)
5000 {
5001 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005002 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005003 return;
5004 }
5005 if (!ends_excmd(*skipwhite(p)))
5006 {
5007 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005008 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005009 return;
5010 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005011 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005012 if (eap->nextcmd != NULL)
5013 *p = NUL;
5014
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005015 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005016 {
5017 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005018 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005019 vim_free(name);
5020 return;
5021 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005022 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005023 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005024 vim_free(name);
5025
5026 if (!eap->skip)
5027 {
5028 if (fp == NULL)
5029 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005030 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005031 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032 return;
5033 }
5034 if (fp->uf_calls > 0)
5035 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005036 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037 return;
5038 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005039 if (fp->uf_flags & FC_VIM9)
5040 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005041 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005042 return;
5043 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005044
5045 if (fudi.fd_dict != NULL)
5046 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005047 // Delete the dict item that refers to the function, it will
5048 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005049 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5050 }
5051 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005052 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005053 // A normal function (not a numbered function or lambda) has a
5054 // refcount of 1 for the entry in the hashtable. When deleting
5055 // it and the refcount is more than one, it should be kept.
5056 // A numbered function and lambda should be kept if the refcount is
5057 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005058 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005059 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005060 // Function is still referenced somewhere. Don't free it but
5061 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005062 if (func_remove(fp))
5063 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005064 }
5065 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005066 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005067 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068 }
5069}
5070
5071/*
5072 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005073 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074 */
5075 void
5076func_unref(char_u *name)
5077{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005078 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005079
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005080 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005081 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005082 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005083 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005084 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005086 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005087#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005088 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005089 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005090 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005091}
5092
5093/*
5094 * Unreference a Function: decrement the reference count and free it when it
5095 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005096 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005097 */
5098 void
5099func_ptr_unref(ufunc_T *fp)
5100{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005101 if (fp != NULL && (--fp->uf_refcount <= 0
5102 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5103 && fp->uf_partial->pt_refcount <= 1
5104 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005105 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005106 // Only delete it when it's not being used. Otherwise it's done
5107 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005108 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005109 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005110 }
5111}
5112
5113/*
5114 * Count a reference to a Function.
5115 */
5116 void
5117func_ref(char_u *name)
5118{
5119 ufunc_T *fp;
5120
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005121 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005123 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005124 if (fp != NULL)
5125 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005126 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005127 // Only give an error for a numbered function.
5128 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005129 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005130}
5131
5132/*
5133 * Count a reference to a Function.
5134 */
5135 void
5136func_ptr_ref(ufunc_T *fp)
5137{
5138 if (fp != NULL)
5139 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005140}
5141
5142/*
5143 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5144 * referenced from anywhere that is in use.
5145 */
5146 static int
5147can_free_funccal(funccall_T *fc, int copyID)
5148{
5149 return (fc->l_varlist.lv_copyID != copyID
5150 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005151 && fc->l_avars.dv_copyID != copyID
5152 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153}
5154
5155/*
5156 * ":return [expr]"
5157 */
5158 void
5159ex_return(exarg_T *eap)
5160{
5161 char_u *arg = eap->arg;
5162 typval_T rettv;
5163 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005164 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165
5166 if (current_funccal == NULL)
5167 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005168 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169 return;
5170 }
5171
Bram Moolenaar844fb642021-10-23 13:32:30 +01005172 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005173 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5174
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175 if (eap->skip)
5176 ++emsg_skip;
5177
5178 eap->nextcmd = NULL;
5179 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005180 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005181 {
5182 if (!eap->skip)
5183 returning = do_return(eap, FALSE, TRUE, &rettv);
5184 else
5185 clear_tv(&rettv);
5186 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005187 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005188 else if (!eap->skip)
5189 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005190 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005191 update_force_abort();
5192
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005193 /*
5194 * Return unless the expression evaluation has been cancelled due to an
5195 * aborting error, an interrupt, or an exception.
5196 */
5197 if (!aborting())
5198 returning = do_return(eap, FALSE, TRUE, NULL);
5199 }
5200
Bram Moolenaare38eab22019-12-05 21:50:01 +01005201 // When skipping or the return gets pending, advance to the next command
5202 // in this line (!returning). Otherwise, ignore the rest of the line.
5203 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005204 if (returning)
5205 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005206 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005207 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208
5209 if (eap->skip)
5210 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005211 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212}
5213
5214/*
5215 * ":1,25call func(arg1, arg2)" function call.
5216 */
5217 void
5218ex_call(exarg_T *eap)
5219{
5220 char_u *arg = eap->arg;
5221 char_u *startarg;
5222 char_u *name;
5223 char_u *tofree;
5224 int len;
5225 typval_T rettv;
5226 linenr_T lnum;
5227 int doesrange;
5228 int failed = FALSE;
5229 funcdict_T fudi;
5230 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005231 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005232 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005233 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005234
Bram Moolenaare6b53242020-07-01 17:28:33 +02005235 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 if (eap->skip)
5237 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005238 // trans_function_name() doesn't work well when skipping, use eval0()
5239 // instead to skip to any following command, e.g. for:
5240 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005242 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005243 clear_tv(&rettv);
5244 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005245 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005246 return;
5247 }
5248
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005249 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5250 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005251 if (fudi.fd_newkey != NULL)
5252 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005253 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005254 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005255 vim_free(fudi.fd_newkey);
5256 }
5257 if (tofree == NULL)
5258 return;
5259
Bram Moolenaare38eab22019-12-05 21:50:01 +01005260 // Increase refcount on dictionary, it could get deleted when evaluating
5261 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005262 if (fudi.fd_dict != NULL)
5263 ++fudi.fd_dict->dv_refcount;
5264
Bram Moolenaare38eab22019-12-05 21:50:01 +01005265 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5266 // contents. For VAR_PARTIAL get its partial, unless we already have one
5267 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005268 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005269 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005270 in_vim9script() && type == NULL ? &type : NULL,
5271 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005272
Bram Moolenaare38eab22019-12-05 21:50:01 +01005273 // Skip white space to allow ":call func ()". Not good, but required for
5274 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005275 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005276 if (*startarg != '(')
5277 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005278 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005279 goto end;
5280 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005281 if (in_vim9script() && startarg > arg)
5282 {
5283 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5284 goto end;
5285 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005286
5287 /*
5288 * When skipping, evaluate the function once, to find the end of the
5289 * arguments.
5290 * When the function takes a range, this is discovered after the first
5291 * call, and the loop is broken.
5292 */
5293 if (eap->skip)
5294 {
5295 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005296 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 }
5298 else
5299 lnum = eap->line1;
5300 for ( ; lnum <= eap->line2; ++lnum)
5301 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005302 funcexe_T funcexe;
5303
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005304 if (!eap->skip && eap->addr_count > 0)
5305 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005306 if (lnum > curbuf->b_ml.ml_line_count)
5307 {
5308 // If the function deleted lines or switched to another buffer
5309 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005310 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005311 break;
5312 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005313 curwin->w_cursor.lnum = lnum;
5314 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005315 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005316 }
5317 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005318
Bram Moolenaara80faa82020-04-12 19:37:17 +02005319 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005320 funcexe.fe_firstline = eap->line1;
5321 funcexe.fe_lastline = eap->line2;
5322 funcexe.fe_doesrange = &doesrange;
5323 funcexe.fe_evaluate = !eap->skip;
5324 funcexe.fe_partial = partial;
5325 funcexe.fe_selfdict = fudi.fd_dict;
5326 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005327 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005328 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005329 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005330 {
5331 failed = TRUE;
5332 break;
5333 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005334 if (has_watchexpr())
5335 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005336
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005337 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005338 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005339 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005340 {
5341 failed = TRUE;
5342 break;
5343 }
5344
5345 clear_tv(&rettv);
5346 if (doesrange || eap->skip)
5347 break;
5348
Bram Moolenaare38eab22019-12-05 21:50:01 +01005349 // Stop when immediately aborting on error, or when an interrupt
5350 // occurred or an exception was thrown but not caught.
5351 // get_func_tv() returned OK, so that the check for trailing
5352 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005353 if (aborting())
5354 break;
5355 }
5356 if (eap->skip)
5357 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005358 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359
Bram Moolenaar1d341892021-09-18 15:25:52 +02005360 // When inside :try we need to check for following "| catch" or "| endtry".
5361 // Not when there was an error, but do check if an exception was thrown.
5362 if ((!aborting() || did_throw)
5363 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005364 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005365 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005366 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005367 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005368 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005369 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005370 {
5371 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005372 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005373 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005374 }
5375 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005376 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005377 }
5378
5379end:
5380 dict_unref(fudi.fd_dict);
5381 vim_free(tofree);
5382}
5383
5384/*
5385 * Return from a function. Possibly makes the return pending. Also called
5386 * for a pending return at the ":endtry" or after returning from an extra
5387 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5388 * when called due to a ":return" command. "rettv" may point to a typval_T
5389 * with the return rettv. Returns TRUE when the return can be carried out,
5390 * FALSE when the return gets pending.
5391 */
5392 int
5393do_return(
5394 exarg_T *eap,
5395 int reanimate,
5396 int is_cmd,
5397 void *rettv)
5398{
5399 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005400 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005401
5402 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005403 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005404 current_funccal->returned = FALSE;
5405
5406 /*
5407 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5408 * not in its finally clause (which then is to be executed next) is found.
5409 * In this case, make the ":return" pending for execution at the ":endtry".
5410 * Otherwise, return normally.
5411 */
5412 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5413 if (idx >= 0)
5414 {
5415 cstack->cs_pending[idx] = CSTP_RETURN;
5416
5417 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005418 // A pending return again gets pending. "rettv" points to an
5419 // allocated variable with the rettv of the original ":return"'s
5420 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005421 cstack->cs_rettv[idx] = rettv;
5422 else
5423 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005424 // When undoing a return in order to make it pending, get the stored
5425 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005426 if (reanimate)
5427 rettv = current_funccal->rettv;
5428
5429 if (rettv != NULL)
5430 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005431 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005432 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5433 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5434 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005435 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005436 }
5437 else
5438 cstack->cs_rettv[idx] = NULL;
5439
5440 if (reanimate)
5441 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005442 // The pending return value could be overwritten by a ":return"
5443 // without argument in a finally clause; reset the default
5444 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005445 current_funccal->rettv->v_type = VAR_NUMBER;
5446 current_funccal->rettv->vval.v_number = 0;
5447 }
5448 }
5449 report_make_pending(CSTP_RETURN, rettv);
5450 }
5451 else
5452 {
5453 current_funccal->returned = TRUE;
5454
Bram Moolenaare38eab22019-12-05 21:50:01 +01005455 // If the return is carried out now, store the return value. For
5456 // a return immediately after reanimation, the value is already
5457 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005458 if (!reanimate && rettv != NULL)
5459 {
5460 clear_tv(current_funccal->rettv);
5461 *current_funccal->rettv = *(typval_T *)rettv;
5462 if (!is_cmd)
5463 vim_free(rettv);
5464 }
5465 }
5466
5467 return idx < 0;
5468}
5469
5470/*
5471 * Free the variable with a pending return value.
5472 */
5473 void
5474discard_pending_return(void *rettv)
5475{
5476 free_tv((typval_T *)rettv);
5477}
5478
5479/*
5480 * Generate a return command for producing the value of "rettv". The result
5481 * is an allocated string. Used by report_pending() for verbose messages.
5482 */
5483 char_u *
5484get_return_cmd(void *rettv)
5485{
5486 char_u *s = NULL;
5487 char_u *tofree = NULL;
5488 char_u numbuf[NUMBUFLEN];
5489
5490 if (rettv != NULL)
5491 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5492 if (s == NULL)
5493 s = (char_u *)"";
5494
5495 STRCPY(IObuff, ":return ");
5496 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5497 if (STRLEN(s) + 8 >= IOSIZE)
5498 STRCPY(IObuff + IOSIZE - 4, "...");
5499 vim_free(tofree);
5500 return vim_strsave(IObuff);
5501}
5502
5503/*
5504 * Get next function line.
5505 * Called by do_cmdline() to get the next line.
5506 * Returns allocated string, or NULL for end of function.
5507 */
5508 char_u *
5509get_func_line(
5510 int c UNUSED,
5511 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005512 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005513 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005514{
5515 funccall_T *fcp = (funccall_T *)cookie;
5516 ufunc_T *fp = fcp->func;
5517 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005518 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519
Bram Moolenaare38eab22019-12-05 21:50:01 +01005520 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005521 if (fcp->dbg_tick != debug_tick)
5522 {
5523 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005524 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005525 fcp->dbg_tick = debug_tick;
5526 }
5527#ifdef FEAT_PROFILE
5528 if (do_profiling == PROF_YES)
5529 func_line_end(cookie);
5530#endif
5531
5532 gap = &fp->uf_lines;
5533 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5534 || fcp->returned)
5535 retval = NULL;
5536 else
5537 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005538 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005539 while (fcp->linenr < gap->ga_len
5540 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5541 ++fcp->linenr;
5542 if (fcp->linenr >= gap->ga_len)
5543 retval = NULL;
5544 else
5545 {
5546 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005547 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005548#ifdef FEAT_PROFILE
5549 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005550 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005551#endif
5552 }
5553 }
5554
Bram Moolenaare38eab22019-12-05 21:50:01 +01005555 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005556 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005557 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005558 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005559 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005560 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005561 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005562 fcp->dbg_tick = debug_tick;
5563 }
5564
5565 return retval;
5566}
5567
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005568/*
5569 * Return TRUE if the currently active function should be ended, because a
5570 * return was encountered or an error occurred. Used inside a ":while".
5571 */
5572 int
5573func_has_ended(void *cookie)
5574{
5575 funccall_T *fcp = (funccall_T *)cookie;
5576
Bram Moolenaare38eab22019-12-05 21:50:01 +01005577 // Ignore the "abort" flag if the abortion behavior has been changed due to
5578 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005579 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5580 || fcp->returned);
5581}
5582
5583/*
5584 * return TRUE if cookie indicates a function which "abort"s on errors.
5585 */
5586 int
5587func_has_abort(
5588 void *cookie)
5589{
5590 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5591}
5592
5593
5594/*
5595 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5596 * Don't do this when "Func" is already a partial that was bound
5597 * explicitly (pt_auto is FALSE).
5598 * Changes "rettv" in-place.
5599 * Returns the updated "selfdict_in".
5600 */
5601 dict_T *
5602make_partial(dict_T *selfdict_in, typval_T *rettv)
5603{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005604 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005605 char_u *tofree = NULL;
5606 ufunc_T *fp;
5607 char_u fname_buf[FLEN_FIXED + 1];
5608 int error;
5609 dict_T *selfdict = selfdict_in;
5610
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005611 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5612 fp = rettv->vval.v_partial->pt_func;
5613 else
5614 {
5615 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5616 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005617 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005618 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005619 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005620 vim_free(tofree);
5621 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005622
5623 if (fp != NULL && (fp->uf_flags & FC_DICT))
5624 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005625 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005626
5627 if (pt != NULL)
5628 {
5629 pt->pt_refcount = 1;
5630 pt->pt_dict = selfdict;
5631 pt->pt_auto = TRUE;
5632 selfdict = NULL;
5633 if (rettv->v_type == VAR_FUNC)
5634 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005635 // Just a function: Take over the function name and use
5636 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005637 pt->pt_name = rettv->vval.v_string;
5638 }
5639 else
5640 {
5641 partial_T *ret_pt = rettv->vval.v_partial;
5642 int i;
5643
Bram Moolenaare38eab22019-12-05 21:50:01 +01005644 // Partial: copy the function name, use selfdict and copy
5645 // args. Can't take over name or args, the partial might
5646 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005647 if (ret_pt->pt_name != NULL)
5648 {
5649 pt->pt_name = vim_strsave(ret_pt->pt_name);
5650 func_ref(pt->pt_name);
5651 }
5652 else
5653 {
5654 pt->pt_func = ret_pt->pt_func;
5655 func_ptr_ref(pt->pt_func);
5656 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005657 if (ret_pt->pt_argc > 0)
5658 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005659 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005660 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005661 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005662 pt->pt_argc = 0;
5663 else
5664 {
5665 pt->pt_argc = ret_pt->pt_argc;
5666 for (i = 0; i < pt->pt_argc; i++)
5667 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5668 }
5669 }
5670 partial_unref(ret_pt);
5671 }
5672 rettv->v_type = VAR_PARTIAL;
5673 rettv->vval.v_partial = pt;
5674 }
5675 }
5676 return selfdict;
5677}
5678
5679/*
5680 * Return the name of the executed function.
5681 */
5682 char_u *
5683func_name(void *cookie)
5684{
5685 return ((funccall_T *)cookie)->func->uf_name;
5686}
5687
5688/*
5689 * Return the address holding the next breakpoint line for a funccall cookie.
5690 */
5691 linenr_T *
5692func_breakpoint(void *cookie)
5693{
5694 return &((funccall_T *)cookie)->breakpoint;
5695}
5696
5697/*
5698 * Return the address holding the debug tick for a funccall cookie.
5699 */
5700 int *
5701func_dbg_tick(void *cookie)
5702{
5703 return &((funccall_T *)cookie)->dbg_tick;
5704}
5705
5706/*
5707 * Return the nesting level for a funccall cookie.
5708 */
5709 int
5710func_level(void *cookie)
5711{
5712 return ((funccall_T *)cookie)->level;
5713}
5714
5715/*
5716 * Return TRUE when a function was ended by a ":return" command.
5717 */
5718 int
5719current_func_returned(void)
5720{
5721 return current_funccal->returned;
5722}
5723
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005724 int
5725free_unref_funccal(int copyID, int testing)
5726{
5727 int did_free = FALSE;
5728 int did_free_funccal = FALSE;
5729 funccall_T *fc, **pfc;
5730
5731 for (pfc = &previous_funccal; *pfc != NULL; )
5732 {
5733 if (can_free_funccal(*pfc, copyID))
5734 {
5735 fc = *pfc;
5736 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005737 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005738 did_free = TRUE;
5739 did_free_funccal = TRUE;
5740 }
5741 else
5742 pfc = &(*pfc)->caller;
5743 }
5744 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005745 // When a funccal was freed some more items might be garbage
5746 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005747 (void)garbage_collect(testing);
5748
5749 return did_free;
5750}
5751
5752/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005753 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005754 */
5755 static funccall_T *
5756get_funccal(void)
5757{
5758 int i;
5759 funccall_T *funccal;
5760 funccall_T *temp_funccal;
5761
5762 funccal = current_funccal;
5763 if (debug_backtrace_level > 0)
5764 {
5765 for (i = 0; i < debug_backtrace_level; i++)
5766 {
5767 temp_funccal = funccal->caller;
5768 if (temp_funccal)
5769 funccal = temp_funccal;
5770 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005771 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005772 debug_backtrace_level = i;
5773 }
5774 }
5775 return funccal;
5776}
5777
5778/*
5779 * Return the hashtable used for local variables in the current funccal.
5780 * Return NULL if there is no current funccal.
5781 */
5782 hashtab_T *
5783get_funccal_local_ht()
5784{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005785 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005786 return NULL;
5787 return &get_funccal()->l_vars.dv_hashtab;
5788}
5789
5790/*
5791 * Return the l: scope variable.
5792 * Return NULL if there is no current funccal.
5793 */
5794 dictitem_T *
5795get_funccal_local_var()
5796{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005797 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005798 return NULL;
5799 return &get_funccal()->l_vars_var;
5800}
5801
5802/*
5803 * Return the hashtable used for argument in the current funccal.
5804 * Return NULL if there is no current funccal.
5805 */
5806 hashtab_T *
5807get_funccal_args_ht()
5808{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005809 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005810 return NULL;
5811 return &get_funccal()->l_avars.dv_hashtab;
5812}
5813
5814/*
5815 * Return the a: scope variable.
5816 * Return NULL if there is no current funccal.
5817 */
5818 dictitem_T *
5819get_funccal_args_var()
5820{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005821 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005822 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005823 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005824}
5825
5826/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005827 * List function variables, if there is a function.
5828 */
5829 void
5830list_func_vars(int *first)
5831{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005832 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005833 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005834 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005835}
5836
5837/*
5838 * If "ht" is the hashtable for local variables in the current funccal, return
5839 * the dict that contains it.
5840 * Otherwise return NULL.
5841 */
5842 dict_T *
5843get_current_funccal_dict(hashtab_T *ht)
5844{
5845 if (current_funccal != NULL
5846 && ht == &current_funccal->l_vars.dv_hashtab)
5847 return &current_funccal->l_vars;
5848 return NULL;
5849}
5850
5851/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005852 * Search hashitem in parent scope.
5853 */
5854 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005855find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005856{
5857 funccall_T *old_current_funccal = current_funccal;
5858 hashtab_T *ht;
5859 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005860 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005861
5862 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5863 return NULL;
5864
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005865 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005866 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005867 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005868 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005869 ht = find_var_ht(name, &varname);
5870 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005871 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005872 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005873 if (!HASHITEM_EMPTY(hi))
5874 {
5875 *pht = ht;
5876 break;
5877 }
5878 }
5879 if (current_funccal == current_funccal->func->uf_scoped)
5880 break;
5881 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005882 }
5883 current_funccal = old_current_funccal;
5884
5885 return hi;
5886}
5887
5888/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005889 * Search variable in parent scope.
5890 */
5891 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005892find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005893{
5894 dictitem_T *v = NULL;
5895 funccall_T *old_current_funccal = current_funccal;
5896 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005897 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005898
5899 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5900 return NULL;
5901
Bram Moolenaare38eab22019-12-05 21:50:01 +01005902 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005903 current_funccal = current_funccal->func->uf_scoped;
5904 while (current_funccal)
5905 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005906 ht = find_var_ht(name, &varname);
5907 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005908 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005909 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005910 if (v != NULL)
5911 break;
5912 }
5913 if (current_funccal == current_funccal->func->uf_scoped)
5914 break;
5915 current_funccal = current_funccal->func->uf_scoped;
5916 }
5917 current_funccal = old_current_funccal;
5918
5919 return v;
5920}
5921
5922/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005923 * Set "copyID + 1" in previous_funccal and callers.
5924 */
5925 int
5926set_ref_in_previous_funccal(int copyID)
5927{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005928 funccall_T *fc;
5929
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005930 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005931 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005932 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005933 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5934 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5935 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5936 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005937 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005938 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005939}
5940
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005941 static int
5942set_ref_in_funccal(funccall_T *fc, int copyID)
5943{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005944 if (fc->fc_copyID != copyID)
5945 {
5946 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005947 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5948 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5949 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5950 || set_ref_in_func(NULL, fc->func, copyID))
5951 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005952 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005953 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005954}
5955
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005956/*
5957 * Set "copyID" in all local vars and arguments in the call stack.
5958 */
5959 int
5960set_ref_in_call_stack(int copyID)
5961{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005962 funccall_T *fc;
5963 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005964
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005965 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5966 if (set_ref_in_funccal(fc, copyID))
5967 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005968
5969 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005970 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5971 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5972 if (set_ref_in_funccal(fc, copyID))
5973 return TRUE;
5974 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005975}
5976
5977/*
5978 * Set "copyID" in all functions available by name.
5979 */
5980 int
5981set_ref_in_functions(int copyID)
5982{
5983 int todo;
5984 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005985 ufunc_T *fp;
5986
5987 todo = (int)func_hashtab.ht_used;
5988 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005989 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005990 if (!HASHITEM_EMPTY(hi))
5991 {
5992 --todo;
5993 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005994 if (!func_name_refcount(fp->uf_name)
5995 && set_ref_in_func(NULL, fp, copyID))
5996 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005997 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005998 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005999 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006000}
6001
6002/*
6003 * Set "copyID" in all function arguments.
6004 */
6005 int
6006set_ref_in_func_args(int copyID)
6007{
6008 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006009
6010 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006011 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6012 copyID, NULL, NULL))
6013 return TRUE;
6014 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006015}
6016
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006017/*
6018 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006019 * Returns TRUE if setting references failed somehow.
6020 */
6021 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006022set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006023{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006024 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006025 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006026 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006027 char_u fname_buf[FLEN_FIXED + 1];
6028 char_u *tofree = NULL;
6029 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006030 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006031
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006032 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006033 return FALSE;
6034
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006035 if (fp_in == NULL)
6036 {
6037 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006038 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006039 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006040 if (fp != NULL)
6041 {
6042 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006043 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006044 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006045
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006046 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006047 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006048}
6049
Bram Moolenaare38eab22019-12-05 21:50:01 +01006050#endif // FEAT_EVAL