blob: a227700dc02578234be06ffa2bc725298003dc2d [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 Moolenaar2ef91562021-12-11 16:14:07 +00001570 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001571 */
1572 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001573deref_func_name(
1574 char_u *name,
1575 int *lenp,
1576 partial_T **partialp,
1577 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001578 int no_autoload,
1579 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580{
1581 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001582 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001583 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001584 char_u *s = NULL;
1585 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001586 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587
1588 if (partialp != NULL)
1589 *partialp = NULL;
1590
1591 cc = name[*lenp];
1592 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001593
Bram Moolenaar71f21932022-01-07 18:20:55 +00001594 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001596 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001598 tv = &v->di_tv;
1599 }
1600 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1601 {
1602 imported_T *import;
1603 char_u *p = name;
1604 int len = *lenp;
1605
1606 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001608 p = name + 2;
1609 len -= 2;
1610 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001611 import = find_imported(p, len, FALSE, NULL);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001612
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001613 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001614 if (import != NULL)
1615 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001616 name[len] = NUL;
1617 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
1618 name[len] = cc;
1619 *lenp = 0;
1620 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001621 }
1622 }
1623
1624 if (tv != NULL)
1625 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001626 if (found_var != NULL)
1627 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001628 if (tv->v_type == VAR_FUNC)
1629 {
1630 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001631 {
1632 *lenp = 0;
1633 return (char_u *)""; // just in case
1634 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001635 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001639 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001641 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001642
1643 if (pt == NULL)
1644 {
1645 *lenp = 0;
1646 return (char_u *)""; // just in case
1647 }
1648 if (partialp != NULL)
1649 *partialp = pt;
1650 s = partial_name(pt);
1651 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001653
1654 if (s != NULL)
1655 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001656 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001657 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001658 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001659
1660 if (sv != NULL)
1661 *type = sv->sv_type;
1662 }
1663 return s;
1664 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001665 }
1666
1667 return name;
1668}
1669
1670/*
1671 * Give an error message with a function name. Handle <SNR> things.
1672 * "ermsg" is to be passed without translation, use N_() instead of _().
1673 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001674 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675emsg_funcname(char *ermsg, char_u *name)
1676{
1677 char_u *p;
1678
1679 if (*name == K_SPECIAL)
1680 p = concat_str((char_u *)"<SNR>", name + 3);
1681 else
1682 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001683 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684 if (p != name)
1685 vim_free(p);
1686}
1687
1688/*
1689 * Allocate a variable for the result of a function.
1690 * Return OK or FAIL.
1691 */
1692 int
1693get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001694 char_u *name, // name of the function
1695 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001697 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001698 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001699 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700{
1701 char_u *argp;
1702 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001703 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1704 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001705 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001706 int evaluate = evalarg == NULL
1707 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708
1709 /*
1710 * Get the arguments.
1711 */
1712 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001713 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1714 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001716 // skip the '(' or ',' and possibly line breaks
1717 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1718
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 if (*argp == ')' || *argp == ',' || *argp == NUL)
1720 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001721 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 {
1723 ret = FAIL;
1724 break;
1725 }
1726 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001727 // The comma should come right after the argument, but this wasn't
1728 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001729 if (vim9script)
1730 {
1731 if (*argp != ',' && *skipwhite(argp) == ',')
1732 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001733 if (evaluate)
1734 semsg(_(e_no_white_space_allowed_before_str_str),
1735 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001736 ret = FAIL;
1737 break;
1738 }
1739 }
1740 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001741 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001742 if (*argp != ',')
1743 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001744 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1745 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001746 if (evaluate)
1747 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001748 ret = FAIL;
1749 break;
1750 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001752 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753 if (*argp == ')')
1754 ++argp;
1755 else
1756 ret = FAIL;
1757
1758 if (ret == OK)
1759 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001760 int i = 0;
1761 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001762
1763 if (get_vim_var_nr(VV_TESTING))
1764 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001765 // Prepare for calling test_garbagecollect_now(), need to know
1766 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001768 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 for (i = 0; i < argcount; ++i)
1770 if (ga_grow(&funcargs, 1) == OK)
1771 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1772 &argvars[i];
1773 }
1774
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001775 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001776 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001777 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001778 // An error in a builtin function does not return FAIL, but we do
1779 // want to abort further processing if an error was given.
1780 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001781 clear_tv(rettv);
1782 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783
1784 funcargs.ga_len -= i;
1785 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001786 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 {
1788 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001789 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001791 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 }
1793
1794 while (--argcount >= 0)
1795 clear_tv(&argvars[argcount]);
1796
Bram Moolenaar8294d492020-08-10 22:40:56 +02001797 if (in_vim9script())
1798 *arg = argp;
1799 else
1800 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001801 return ret;
1802}
1803
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804/*
1805 * Return TRUE if "p" starts with "<SID>" or "s:".
1806 * Only works if eval_fname_script() returned non-zero for "p"!
1807 */
1808 static int
1809eval_fname_sid(char_u *p)
1810{
1811 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1812}
1813
1814/*
1815 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1816 * Change <SNR>123_name() to K_SNR 123_name().
1817 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1818 * (slow).
1819 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001820 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1822{
1823 int llen;
1824 char_u *fname;
1825 int i;
1826
1827 llen = eval_fname_script(name);
1828 if (llen > 0)
1829 {
1830 fname_buf[0] = K_SPECIAL;
1831 fname_buf[1] = KS_EXTRA;
1832 fname_buf[2] = (int)KE_SNR;
1833 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001834 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001835 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001836 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001837 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 else
1839 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001840 sprintf((char *)fname_buf + 3, "%ld_",
1841 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001842 i = (int)STRLEN(fname_buf);
1843 }
1844 }
1845 if (i + STRLEN(name + llen) < FLEN_FIXED)
1846 {
1847 STRCPY(fname_buf + i, name + llen);
1848 fname = fname_buf;
1849 }
1850 else
1851 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001852 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001854 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 else
1856 {
1857 *tofree = fname;
1858 mch_memmove(fname, fname_buf, (size_t)i);
1859 STRCPY(fname + i, name + llen);
1860 }
1861 }
1862 }
1863 else
1864 fname = name;
1865 return fname;
1866}
1867
1868/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001869 * Find a function "name" in script "sid".
1870 */
1871 static ufunc_T *
1872find_func_with_sid(char_u *name, int sid)
1873{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001874 hashitem_T *hi;
1875 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001876
Bram Moolenaarb8822442022-01-11 15:24:05 +00001877 if (!SCRIPT_ID_VALID(sid))
1878 return NULL; // not in a script
1879
1880 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001881 buffer[0] = K_SPECIAL;
1882 buffer[1] = KS_EXTRA;
1883 buffer[2] = (int)KE_SNR;
1884 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1885 (long)sid, name);
1886 hi = hash_find(&func_hashtab, buffer);
1887 if (!HASHITEM_EMPTY(hi))
1888 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001889 return NULL;
1890}
1891
1892/*
1893 * Find a function "name" in script "sid" prefixing the autoload prefix.
1894 */
1895 static ufunc_T *
1896find_func_with_prefix(char_u *name, int sid)
1897{
1898 hashitem_T *hi;
1899 char_u buffer[200];
1900 scriptitem_T *si;
1901
1902 if (vim_strchr(name, AUTOLOAD_CHAR) != 0)
1903 return NULL; // already has the prefix
1904 if (!SCRIPT_ID_VALID(sid))
1905 return NULL; // not in a script
1906 si = SCRIPT_ITEM(sid);
1907 if (si->sn_autoload_prefix != NULL)
1908 {
1909 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1910 char_u *auto_name;
1911
1912 // An exported function in an autoload script is stored as
1913 // "dir#path#name".
1914 if (len < sizeof(buffer))
1915 auto_name = buffer;
1916 else
1917 auto_name = alloc(len);
1918 if (auto_name != NULL)
1919 {
1920 vim_snprintf((char *)auto_name, len, "%s%s",
1921 si->sn_autoload_prefix, name);
1922 hi = hash_find(&func_hashtab, auto_name);
1923 if (auto_name != buffer)
1924 vim_free(auto_name);
1925 if (!HASHITEM_EMPTY(hi))
1926 return HI2UF(hi);
1927 }
1928 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001929
1930 return NULL;
1931}
1932
1933/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001935 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001936 * Return NULL for unknown function.
1937 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001938 ufunc_T *
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001939find_func_even_dead(char_u *name, int is_global, cctx_T *cctx UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001940{
1941 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001943
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001944 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001945 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001946 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1947 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948
Bram Moolenaar95006e32020-08-29 17:47:08 +02001949 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001950 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001951 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001952 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1953 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001954 if (func != NULL)
1955 return func;
1956 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001958
Bram Moolenaara26b9702020-04-18 19:53:28 +02001959 hi = hash_find(&func_hashtab,
1960 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961 if (!HASHITEM_EMPTY(hi))
1962 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001963
Bram Moolenaarb8822442022-01-11 15:24:05 +00001964 // Find autoload function if this is an autoload script.
1965 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1966 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001967}
1968
1969/*
1970 * Find a function by name, return pointer to it in ufuncs.
1971 * "cctx" is passed in a :def function to find imported functions.
1972 * Return NULL for unknown or dead function.
1973 */
1974 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001975find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001976{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001977 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001978
1979 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1980 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001981 return NULL;
1982}
1983
1984/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001985 * Return TRUE if "ufunc" is a global function.
1986 */
1987 int
1988func_is_global(ufunc_T *ufunc)
1989{
1990 return ufunc->uf_name[0] != K_SPECIAL;
1991}
1992
1993/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001994 * Copy the function name of "fp" to buffer "buf".
1995 * "buf" must be able to hold the function name plus three bytes.
1996 * Takes care of script-local function names.
1997 */
1998 static void
1999cat_func_name(char_u *buf, ufunc_T *fp)
2000{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002001 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002002 {
2003 STRCPY(buf, "<SNR>");
2004 STRCAT(buf, fp->uf_name + 3);
2005 }
2006 else
2007 STRCPY(buf, fp->uf_name);
2008}
2009
2010/*
2011 * Add a number variable "name" to dict "dp" with value "nr".
2012 */
2013 static void
2014add_nr_var(
2015 dict_T *dp,
2016 dictitem_T *v,
2017 char *name,
2018 varnumber_T nr)
2019{
2020 STRCPY(v->di_key, name);
2021 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2022 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2023 v->di_tv.v_type = VAR_NUMBER;
2024 v->di_tv.v_lock = VAR_FIXED;
2025 v->di_tv.vval.v_number = nr;
2026}
2027
2028/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002029 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002030 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002031 static void
2032free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002034 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002035
2036 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2037 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002038 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002039
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002040 // When garbage collecting a funccall_T may be freed before the
2041 // function that references it, clear its uf_scoped field.
2042 // The function may have been redefined and point to another
2043 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002044 if (fp != NULL && fp->uf_scoped == fc)
2045 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002046 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002047 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002048
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002049 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002050 vim_free(fc);
2051}
2052
2053/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002054 * Free "fc" and what it contains.
2055 * Can be called only when "fc" is kept beyond the period of it called,
2056 * i.e. after cleanup_function_call(fc).
2057 */
2058 static void
2059free_funccal_contents(funccall_T *fc)
2060{
2061 listitem_T *li;
2062
2063 // Free all l: variables.
2064 vars_clear(&fc->l_vars.dv_hashtab);
2065
2066 // Free all a: variables.
2067 vars_clear(&fc->l_avars.dv_hashtab);
2068
2069 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002070 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002071 clear_tv(&li->li_tv);
2072
2073 free_funccal(fc);
2074}
2075
2076/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002077 * Handle the last part of returning from a function: free the local hashtable.
2078 * Unless it is still in use by a closure.
2079 */
2080 static void
2081cleanup_function_call(funccall_T *fc)
2082{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002083 int may_free_fc = fc->fc_refcount <= 0;
2084 int free_fc = TRUE;
2085
Bram Moolenaar6914c642017-04-01 21:21:30 +02002086 current_funccal = fc->caller;
2087
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002088 // Free all l: variables if not referred.
2089 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2090 vars_clear(&fc->l_vars.dv_hashtab);
2091 else
2092 free_fc = FALSE;
2093
2094 // If the a:000 list and the l: and a: dicts are not referenced and
2095 // there is no closure using it, we can free the funccall_T and what's
2096 // in it.
2097 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2098 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002099 else
2100 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002101 int todo;
2102 hashitem_T *hi;
2103 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002104
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002105 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002106
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002107 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002108 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2109 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2110 {
2111 if (!HASHITEM_EMPTY(hi))
2112 {
2113 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002114 di = HI2DI(hi);
2115 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002116 }
2117 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002118 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002119
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002120 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2121 fc->l_varlist.lv_first = NULL;
2122 else
2123 {
2124 listitem_T *li;
2125
2126 free_fc = FALSE;
2127
2128 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002129 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002130 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002131 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002132
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002133 if (free_fc)
2134 free_funccal(fc);
2135 else
2136 {
2137 static int made_copy = 0;
2138
2139 // "fc" is still in use. This can happen when returning "a:000",
2140 // assigning "l:" to a global variable or defining a closure.
2141 // Link "fc" in the list for garbage collection later.
2142 fc->caller = previous_funccal;
2143 previous_funccal = fc;
2144
2145 if (want_garbage_collect)
2146 // If garbage collector is ready, clear count.
2147 made_copy = 0;
2148 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002149 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002150 // We have made a lot of copies, worth 4 Mbyte. This can happen
2151 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002152 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002153 // too much memory.
2154 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002155 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002156 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002157 }
2158}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002159
2160/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002161 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2162 */
2163 static int
2164numbered_function(char_u *name)
2165{
2166 return isdigit(*name)
2167 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2168}
2169
2170/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002171 * There are two kinds of function names:
2172 * 1. ordinary names, function defined with :function or :def
2173 * 2. numbered functions and lambdas
2174 * For the first we only count the name stored in func_hashtab as a reference,
2175 * using function() does not count as a reference, because the function is
2176 * looked up by name.
2177 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002178 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002179func_name_refcount(char_u *name)
2180{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002181 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002182}
2183
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002184/*
2185 * Unreference "fc": decrement the reference count and free it when it
2186 * becomes zero. "fp" is detached from "fc".
2187 * When "force" is TRUE we are exiting.
2188 */
2189 static void
2190funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2191{
2192 funccall_T **pfc;
2193 int i;
2194
2195 if (fc == NULL)
2196 return;
2197
2198 if (--fc->fc_refcount <= 0 && (force || (
2199 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2200 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2201 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2202 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2203 {
2204 if (fc == *pfc)
2205 {
2206 *pfc = fc->caller;
2207 free_funccal_contents(fc);
2208 return;
2209 }
2210 }
2211 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2212 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2213 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2214}
2215
2216/*
2217 * Remove the function from the function hashtable. If the function was
2218 * deleted while it still has references this was already done.
2219 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2220 */
2221 static int
2222func_remove(ufunc_T *fp)
2223{
2224 hashitem_T *hi;
2225
2226 // Return if it was already virtually deleted.
2227 if (fp->uf_flags & FC_DEAD)
2228 return FALSE;
2229
2230 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2231 if (!HASHITEM_EMPTY(hi))
2232 {
2233 // When there is a def-function index do not actually remove the
2234 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002235 // Do remove it when it's a copy.
2236 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002237 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002238 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002239 return FALSE;
2240 }
2241 hash_remove(&func_hashtab, hi);
2242 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002243 return TRUE;
2244 }
2245 return FALSE;
2246}
2247
2248 static void
2249func_clear_items(ufunc_T *fp)
2250{
2251 ga_clear_strings(&(fp->uf_args));
2252 ga_clear_strings(&(fp->uf_def_args));
2253 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002254 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002255 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002256 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002257 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002258
2259 // Increment the refcount of this function to avoid it being freed
2260 // recursively when the partial is freed.
2261 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002262 partial_unref(fp->uf_partial);
2263 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002264 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002265
2266#ifdef FEAT_LUA
2267 if (fp->uf_cb_free != NULL)
2268 {
2269 fp->uf_cb_free(fp->uf_cb_state);
2270 fp->uf_cb_free = NULL;
2271 }
2272
2273 fp->uf_cb_state = NULL;
2274 fp->uf_cb = NULL;
2275#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002276#ifdef FEAT_PROFILE
2277 VIM_CLEAR(fp->uf_tml_count);
2278 VIM_CLEAR(fp->uf_tml_total);
2279 VIM_CLEAR(fp->uf_tml_self);
2280#endif
2281}
2282
2283/*
2284 * Free all things that a function contains. Does not free the function
2285 * itself, use func_free() for that.
2286 * When "force" is TRUE we are exiting.
2287 */
2288 static void
2289func_clear(ufunc_T *fp, int force)
2290{
2291 if (fp->uf_cleared)
2292 return;
2293 fp->uf_cleared = TRUE;
2294
2295 // clear this function
2296 func_clear_items(fp);
2297 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002298 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002299}
2300
2301/*
2302 * Free a function and remove it from the list of functions. Does not free
2303 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002304 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002305 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002306 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002307 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002308func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002309{
2310 // Only remove it when not done already, otherwise we would remove a newer
2311 // version of the function with the same name.
2312 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2313 func_remove(fp);
2314
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002315 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002316 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002317 if (fp->uf_dfunc_idx > 0)
2318 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002319 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002320 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002321 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002322 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002323 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002324}
2325
2326/*
2327 * Free all things that a function contains and free the function itself.
2328 * When "force" is TRUE we are exiting.
2329 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002330 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002331func_clear_free(ufunc_T *fp, int force)
2332{
2333 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002334 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2335 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002336 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002337 else
2338 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002339}
2340
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002341/*
2342 * Copy already defined function "lambda" to a new function with name "global".
2343 * This is for when a compiled function defines a global function.
2344 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002345 int
2346copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002347{
2348 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002349 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002350
2351 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002352 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002353 semsg(_(e_lambda_function_not_found_str), lambda);
2354 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002355 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002356
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002357 fp = find_func(global, TRUE, NULL);
2358 if (fp != NULL)
2359 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002360 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002361 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002362 return FAIL;
2363 }
2364
2365 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2366 if (fp == NULL)
2367 return FAIL;
2368
2369 fp->uf_varargs = ufunc->uf_varargs;
2370 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2371 fp->uf_def_status = ufunc->uf_def_status;
2372 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2373 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2374 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2375 == FAIL
2376 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2377 goto failed;
2378
2379 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2380 : vim_strsave(ufunc->uf_name_exp);
2381 if (ufunc->uf_arg_types != NULL)
2382 {
2383 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2384 if (fp->uf_arg_types == NULL)
2385 goto failed;
2386 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2387 sizeof(type_T *) * fp->uf_args.ga_len);
2388 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002389 if (ufunc->uf_va_name != NULL)
2390 {
2391 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2392 if (fp->uf_va_name == NULL)
2393 goto failed;
2394 }
2395 fp->uf_ret_type = ufunc->uf_ret_type;
2396
2397 fp->uf_refcount = 1;
2398 STRCPY(fp->uf_name, global);
2399 hash_add(&func_hashtab, UF2HIKEY(fp));
2400
2401 // the referenced dfunc_T is now used one more time
2402 link_def_function(fp);
2403
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002404 // Create a partial to store the context of the function where it was
2405 // instantiated. Only needs to be done once. Do this on the original
2406 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002407 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2408 {
2409 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2410
2411 if (pt == NULL)
2412 goto failed;
2413 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002414 {
2415 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002416 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002417 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002418 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002419 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002420 }
2421
2422 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002423
2424failed:
2425 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002426 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002427}
2428
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002429static int funcdepth = 0;
2430
2431/*
2432 * Increment the function call depth count.
2433 * Return FAIL when going over 'maxfuncdepth'.
2434 * Otherwise return OK, must call funcdepth_decrement() later!
2435 */
2436 int
2437funcdepth_increment(void)
2438{
2439 if (funcdepth >= p_mfd)
2440 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002441 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002442 return FAIL;
2443 }
2444 ++funcdepth;
2445 return OK;
2446}
2447
2448 void
2449funcdepth_decrement(void)
2450{
2451 --funcdepth;
2452}
2453
2454/*
2455 * Get the current function call depth.
2456 */
2457 int
2458funcdepth_get(void)
2459{
2460 return funcdepth;
2461}
2462
2463/*
2464 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002465 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002466 * times as funcdepth_increment().
2467 */
2468 void
2469funcdepth_restore(int depth)
2470{
2471 funcdepth = depth;
2472}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002473
2474/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 * Call a user function.
2476 */
2477 static void
2478call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002479 ufunc_T *fp, // pointer to function
2480 int argcount, // nr of args
2481 typval_T *argvars, // arguments
2482 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002483 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002484 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002486 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002487 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002488 funccall_T *fc;
2489 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002490 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002492 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002493 int i;
2494 int ai;
2495 int islambda = FALSE;
2496 char_u numbuf[NUMBUFLEN];
2497 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002498 typval_T *tv_to_free[MAX_FUNC_ARGS];
2499 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002501 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002503 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504
Bram Moolenaarb2049902021-01-24 12:53:53 +01002505#ifdef FEAT_PROFILE
2506 CLEAR_FIELD(profile_info);
2507#endif
2508
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002509 // If depth of calling is getting too high, don't execute the function.
2510 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 rettv->v_type = VAR_NUMBER;
2513 rettv->vval.v_number = -1;
2514 return;
2515 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516
Bram Moolenaare38eab22019-12-05 21:50:01 +01002517 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002519 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002520 if (fc == NULL)
2521 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 fc->caller = current_funccal;
2523 current_funccal = fc;
2524 fc->func = fp;
2525 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002527 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2529 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002530 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002531 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002532 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002534 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002535 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002536#ifdef FEAT_PROFILE
2537 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2538#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002539 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002540#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002541 if (do_profiling == PROF_YES)
2542 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002543#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002544 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002545 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002546#ifdef FEAT_PROFILE
2547 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002548 || (caller != NULL && caller->uf_profiling)))
2549 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002550#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002551 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002552 free_funccal(fc);
2553 return;
2554 }
2555
Bram Moolenaar38453522021-11-28 22:00:12 +00002556 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557
2558 /*
2559 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2560 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2561 * each argument variable and saves a lot of time.
2562 */
2563 /*
2564 * Init l: variables.
2565 */
2566 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2567 if (selfdict != NULL)
2568 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002569 // Set l:self to "selfdict". Use "name" to avoid a warning from
2570 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571 v = &fc->fixvar[fixvar_idx++].var;
2572 name = v->di_key;
2573 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002574 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2576 v->di_tv.v_type = VAR_DICT;
2577 v->di_tv.v_lock = 0;
2578 v->di_tv.vval.v_dict = selfdict;
2579 ++selfdict->dv_refcount;
2580 }
2581
2582 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002583 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002584 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585 * Set a:000 to a list with room for the "..." arguments.
2586 */
2587 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002588 if ((fp->uf_flags & FC_NOARGS) == 0)
2589 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002590 (varnumber_T)(argcount >= fp->uf_args.ga_len
2591 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002592 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002593 if ((fp->uf_flags & FC_NOARGS) == 0)
2594 {
2595 // Use "name" to avoid a warning from some compiler that checks the
2596 // destination size.
2597 v = &fc->fixvar[fixvar_idx++].var;
2598 name = v->di_key;
2599 STRCPY(name, "000");
2600 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2601 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2602 v->di_tv.v_type = VAR_LIST;
2603 v->di_tv.v_lock = VAR_FIXED;
2604 v->di_tv.vval.v_list = &fc->l_varlist;
2605 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002606 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2608 fc->l_varlist.lv_lock = VAR_FIXED;
2609
2610 /*
2611 * Set a:firstline to "firstline" and a:lastline to "lastline".
2612 * Set a:name to named arguments.
2613 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002614 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002616 if ((fp->uf_flags & FC_NOARGS) == 0)
2617 {
2618 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002619 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002620 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002621 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002622 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002623 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624 {
2625 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002626 typval_T def_rettv;
2627 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628
2629 ai = i - fp->uf_args.ga_len;
2630 if (ai < 0)
2631 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002632 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 name = FUNCARG(fp, i);
2634 if (islambda)
2635 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002636
2637 // evaluate named argument default expression
2638 isdefault = ai + fp->uf_def_args.ga_len >= 0
2639 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2640 && argvars[i].vval.v_number == VVAL_NONE));
2641 if (isdefault)
2642 {
2643 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002644
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002645 def_rettv.v_type = VAR_NUMBER;
2646 def_rettv.vval.v_number = -1;
2647
2648 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2649 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002650 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002651 {
2652 default_arg_err = 1;
2653 break;
2654 }
2655 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 }
2657 else
2658 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002659 if ((fp->uf_flags & FC_NOARGS) != 0)
2660 // Bail out if no a: arguments used (in lambda).
2661 break;
2662
Bram Moolenaare38eab22019-12-05 21:50:01 +01002663 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664 sprintf((char *)numbuf, "%d", ai + 1);
2665 name = numbuf;
2666 }
2667 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2668 {
2669 v = &fc->fixvar[fixvar_idx++].var;
2670 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002671 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672 }
2673 else
2674 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002675 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676 if (v == NULL)
2677 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002678 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002681 // Note: the values are copied directly to avoid alloc/free.
2682 // "argvars" must have VAR_FIXED for v_lock.
2683 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002684 v->di_tv.v_lock = VAR_FIXED;
2685
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002686 if (isdefault)
2687 // Need to free this later, no matter where it's stored.
2688 tv_to_free[tv_to_free_len++] = &v->di_tv;
2689
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 if (addlocal)
2691 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002692 // Named arguments should be accessed without the "a:" prefix in
2693 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002694 copy_tv(&v->di_tv, &v->di_tv);
2695 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002697 else
2698 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699
2700 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2701 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002702 listitem_T *li = &fc->l_listitems[ai];
2703
2704 li->li_tv = argvars[i];
2705 li->li_tv.v_lock = VAR_FIXED;
2706 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 }
2708 }
2709
Bram Moolenaare38eab22019-12-05 21:50:01 +01002710 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002712
2713 if (fp->uf_flags & FC_SANDBOX)
2714 {
2715 using_sandbox = TRUE;
2716 ++sandbox;
2717 }
2718
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002719 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002720 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002721 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002723 ++no_wait_return;
2724 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002725
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002726 smsg(_("calling %s"), SOURCING_NAME);
2727 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002729 char_u buf[MSG_BUF_LEN];
2730 char_u numbuf2[NUMBUFLEN];
2731 char_u *tofree;
2732 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002734 msg_puts("(");
2735 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002737 if (i > 0)
2738 msg_puts(", ");
2739 if (argvars[i].v_type == VAR_NUMBER)
2740 msg_outnum((long)argvars[i].vval.v_number);
2741 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002743 // Do not want errors such as E724 here.
2744 ++emsg_off;
2745 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2746 --emsg_off;
2747 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002749 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002751 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2752 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002754 msg_puts((char *)s);
2755 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 }
2757 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002759 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002761 msg_puts("\n"); // don't overwrite this either
2762
2763 verbose_leave_scroll();
2764 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 }
2766#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002767 if (do_profiling == PROF_YES)
2768 profile_may_start_func(&profile_info, fp,
2769 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770#endif
2771
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002772 save_current_sctx = current_sctx;
2773 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 save_did_emsg = did_emsg;
2775 did_emsg = FALSE;
2776
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002777 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2778 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002779 else if (islambda)
2780 {
2781 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2782
2783 // A Lambda always has the command "return {expr}". It is much faster
2784 // to evaluate {expr} directly.
2785 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002786 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002787 --ex_nesting_level;
2788 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002789 else
2790 // call do_cmdline() to execute the lines
2791 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2793
2794 --RedrawingDisabled;
2795
Bram Moolenaare38eab22019-12-05 21:50:01 +01002796 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2798 {
2799 clear_tv(rettv);
2800 rettv->v_type = VAR_NUMBER;
2801 rettv->vval.v_number = -1;
2802 }
2803
2804#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002805 if (do_profiling == PROF_YES)
2806 {
2807 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2808
2809 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2810 profile_may_end_func(&profile_info, fp, caller);
2811 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812#endif
2813
Bram Moolenaare38eab22019-12-05 21:50:01 +01002814 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 if (p_verbose >= 12)
2816 {
2817 ++no_wait_return;
2818 verbose_enter_scroll();
2819
2820 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002821 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002823 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 (long)fc->rettv->vval.v_number);
2825 else
2826 {
2827 char_u buf[MSG_BUF_LEN];
2828 char_u numbuf2[NUMBUFLEN];
2829 char_u *tofree;
2830 char_u *s;
2831
Bram Moolenaare38eab22019-12-05 21:50:01 +01002832 // The value may be very long. Skip the middle part, so that we
2833 // have some idea how it starts and ends. smsg() would always
2834 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 ++emsg_off;
2836 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2837 --emsg_off;
2838 if (s != NULL)
2839 {
2840 if (vim_strsize(s) > MSG_BUF_CLEN)
2841 {
2842 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2843 s = buf;
2844 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002845 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002846 vim_free(tofree);
2847 }
2848 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002849 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850
2851 verbose_leave_scroll();
2852 --no_wait_return;
2853 }
2854
Bram Moolenaare31ee862020-01-07 20:59:34 +01002855 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002856 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002857 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858#ifdef FEAT_PROFILE
2859 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002860 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002862 if (using_sandbox)
2863 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002865 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 {
2867 ++no_wait_return;
2868 verbose_enter_scroll();
2869
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002870 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002871 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002872
2873 verbose_leave_scroll();
2874 --no_wait_return;
2875 }
2876
2877 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002878 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002879 for (i = 0; i < tv_to_free_len; ++i)
2880 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002881 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002882}
2883
2884/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002885 * Check the argument count for user function "fp".
2886 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2887 */
2888 int
2889check_user_func_argcount(ufunc_T *fp, int argcount)
2890{
2891 int regular_args = fp->uf_args.ga_len;
2892
2893 if (argcount < regular_args - fp->uf_def_args.ga_len)
2894 return FCERR_TOOFEW;
2895 else if (!has_varargs(fp) && argcount > regular_args)
2896 return FCERR_TOOMANY;
2897 return FCERR_UNKNOWN;
2898}
2899
2900/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002902 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002903 int
2904call_user_func_check(
2905 ufunc_T *fp,
2906 int argcount,
2907 typval_T *argvars,
2908 typval_T *rettv,
2909 funcexe_T *funcexe,
2910 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002911{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002912 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002913
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002914 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2915 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002916 error = check_user_func_argcount(fp, argcount);
2917 if (error != FCERR_UNKNOWN)
2918 return error;
2919 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002920 error = FCERR_DICT;
2921 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002922 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002923 int did_save_redo = FALSE;
2924 save_redo_T save_redo;
2925
2926 /*
2927 * Call the user function.
2928 * Save and restore search patterns, script variables and
2929 * redo buffer.
2930 */
2931 save_search_patterns();
2932 if (!ins_compl_active())
2933 {
2934 saveRedobuff(&save_redo);
2935 did_save_redo = TRUE;
2936 }
2937 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002938 call_user_func(fp, argcount, argvars, rettv, funcexe,
2939 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002940 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2941 // Function was unreferenced while being used, free it now.
2942 func_clear_free(fp, FALSE);
2943 if (did_save_redo)
2944 restoreRedobuff(&save_redo);
2945 restore_search_patterns();
2946 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002947 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002948 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002949}
2950
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002951static funccal_entry_T *funccal_stack = NULL;
2952
2953/*
2954 * Save the current function call pointer, and set it to NULL.
2955 * Used when executing autocommands and for ":source".
2956 */
2957 void
2958save_funccal(funccal_entry_T *entry)
2959{
2960 entry->top_funccal = current_funccal;
2961 entry->next = funccal_stack;
2962 funccal_stack = entry;
2963 current_funccal = NULL;
2964}
2965
2966 void
2967restore_funccal(void)
2968{
2969 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002970 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002971 else
2972 {
2973 current_funccal = funccal_stack->top_funccal;
2974 funccal_stack = funccal_stack->next;
2975 }
2976}
2977
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002978 funccall_T *
2979get_current_funccal(void)
2980{
2981 return current_funccal;
2982}
2983
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002984/*
2985 * Mark all functions of script "sid" as deleted.
2986 */
2987 void
2988delete_script_functions(int sid)
2989{
2990 hashitem_T *hi;
2991 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002992 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002993 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002994 size_t len;
2995
2996 buf[0] = K_SPECIAL;
2997 buf[1] = KS_EXTRA;
2998 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002999 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003000 len = STRLEN(buf);
3001
Bram Moolenaarce658352020-07-31 23:47:12 +02003002 while (todo > 0)
3003 {
3004 todo = func_hashtab.ht_used;
3005 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3006 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003007 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003008 fp = HI2UF(hi);
3009 if (STRNCMP(fp->uf_name, buf, len) == 0)
3010 {
3011 int changed = func_hashtab.ht_changed;
3012
3013 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003014
3015 if (fp->uf_calls > 0)
3016 {
3017 // Function is executing, don't free it but do remove
3018 // it from the hashtable.
3019 if (func_remove(fp))
3020 fp->uf_refcount--;
3021 }
3022 else
3023 {
3024 func_clear(fp, TRUE);
3025 // When clearing a function another function can be
3026 // cleared as a side effect. When that happens start
3027 // over.
3028 if (changed != func_hashtab.ht_changed)
3029 break;
3030 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003031 }
3032 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003033 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003034 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003035}
3036
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003037#if defined(EXITFREE) || defined(PROTO)
3038 void
3039free_all_functions(void)
3040{
3041 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003042 ufunc_T *fp;
3043 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003044 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003045 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046
Bram Moolenaare38eab22019-12-05 21:50:01 +01003047 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003048 while (current_funccal != NULL)
3049 {
3050 clear_tv(current_funccal->rettv);
3051 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003052 if (current_funccal == NULL && funccal_stack != NULL)
3053 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003054 }
3055
Bram Moolenaare38eab22019-12-05 21:50:01 +01003056 // First clear what the functions contain. Since this may lower the
3057 // reference count of a function, it may also free a function and change
3058 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003059 while (todo > 0)
3060 {
3061 todo = func_hashtab.ht_used;
3062 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3063 if (!HASHITEM_EMPTY(hi))
3064 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003065 // clear the def function index now
3066 fp = HI2UF(hi);
3067 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003068 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003069
Bram Moolenaare38eab22019-12-05 21:50:01 +01003070 // Only free functions that are not refcounted, those are
3071 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003072 if (func_name_refcount(fp->uf_name))
3073 ++skipped;
3074 else
3075 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003076 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003077 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003078 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003079 {
3080 skipped = 0;
3081 break;
3082 }
3083 }
3084 --todo;
3085 }
3086 }
3087
Bram Moolenaare38eab22019-12-05 21:50:01 +01003088 // Now actually free the functions. Need to start all over every time,
3089 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003090 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003091 while (func_hashtab.ht_used > skipped)
3092 {
3093 todo = func_hashtab.ht_used;
3094 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003095 if (!HASHITEM_EMPTY(hi))
3096 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003097 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003098 // Only free functions that are not refcounted, those are
3099 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003100 fp = HI2UF(hi);
3101 if (func_name_refcount(fp->uf_name))
3102 ++skipped;
3103 else
3104 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003105 if (func_free(fp, FALSE) == OK)
3106 {
3107 skipped = 0;
3108 break;
3109 }
3110 // did not actually free it
3111 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003112 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003114 }
3115 if (skipped == 0)
3116 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003117
3118 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119}
3120#endif
3121
3122/*
3123 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003124 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125 * "len" is the length of "name", or -1 for NUL terminated.
3126 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003127 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128builtin_function(char_u *name, int len)
3129{
3130 char_u *p;
3131
Bram Moolenaara26b9702020-04-18 19:53:28 +02003132 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133 return FALSE;
3134 p = vim_strchr(name, AUTOLOAD_CHAR);
3135 return p == NULL || (len > 0 && p > name + len);
3136}
3137
3138 int
3139func_call(
3140 char_u *name,
3141 typval_T *args,
3142 partial_T *partial,
3143 dict_T *selfdict,
3144 typval_T *rettv)
3145{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003146 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147 listitem_T *item;
3148 typval_T argv[MAX_FUNC_ARGS + 1];
3149 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003150 int r = 0;
3151
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003152 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003153 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003154 {
3155 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3156 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003157 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003158 break;
3159 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003160 // Make a copy of each argument. This is needed to be able to set
3161 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162 copy_tv(&item->li_tv, &argv[argc++]);
3163 }
3164
3165 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003166 {
3167 funcexe_T funcexe;
3168
Bram Moolenaara80faa82020-04-12 19:37:17 +02003169 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003170 funcexe.fe_firstline = curwin->w_cursor.lnum;
3171 funcexe.fe_lastline = curwin->w_cursor.lnum;
3172 funcexe.fe_evaluate = TRUE;
3173 funcexe.fe_partial = partial;
3174 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003175 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3176 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177
Bram Moolenaare38eab22019-12-05 21:50:01 +01003178 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179 while (argc > 0)
3180 clear_tv(&argv[--argc]);
3181
3182 return r;
3183}
3184
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003185static int callback_depth = 0;
3186
3187 int
3188get_callback_depth(void)
3189{
3190 return callback_depth;
3191}
3192
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003193/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003194 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003195 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003196 */
3197 int
3198call_callback(
3199 callback_T *callback,
3200 int len, // length of "name" or -1 to use strlen()
3201 typval_T *rettv, // return value goes here
3202 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003203 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003204 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003205{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003206 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003207 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003208
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003209 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3210 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003211 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003212 funcexe.fe_evaluate = TRUE;
3213 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003214 ++callback_depth;
3215 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3216 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003217
3218 // When a :def function was called that uses :try an error would be turned
3219 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003220 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003221 {
3222 need_rethrow = FALSE;
3223 handle_did_throw();
3224 }
3225
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003226 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003227}
3228
3229/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003230 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003231 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003232 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3233 */
3234 varnumber_T
3235call_callback_retnr(
3236 callback_T *callback,
3237 int argcount, // number of "argvars"
3238 typval_T *argvars) // vars for arguments, must have "argcount"
3239 // PLUS ONE elements!
3240{
3241 typval_T rettv;
3242 varnumber_T retval;
3243
3244 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003245 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003246
3247 retval = tv_get_number_chk(&rettv, NULL);
3248 clear_tv(&rettv);
3249 return retval;
3250}
3251
3252/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003253 * Give an error message for the result of a function.
3254 * Nothing if "error" is FCERR_NONE.
3255 */
3256 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003257user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003258{
3259 switch (error)
3260 {
3261 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003262 if (funcexe->fe_found_var)
3263 semsg(_(e_not_callable_type_str), name);
3264 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003265 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003266 break;
3267 case FCERR_NOTMETHOD:
3268 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003269 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 break;
3271 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003272 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003273 break;
3274 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003275 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003276 break;
3277 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003278 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 break;
3280 case FCERR_SCRIPT:
3281 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003282 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003283 break;
3284 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003285 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3286 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003287 break;
3288 }
3289}
3290
3291/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003293 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 * Return FAIL when the function can't be called, OK otherwise.
3295 * Also returns OK when an error was encountered while executing the function.
3296 */
3297 int
3298call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003299 char_u *funcname, // name of the function
3300 int len, // length of "name" or -1 to use strlen()
3301 typval_T *rettv, // return value goes here
3302 int argcount_in, // number of "argvars"
3303 typval_T *argvars_in, // vars for arguments, must have "argcount"
3304 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003305 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306{
3307 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003308 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003310 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 char_u fname_buf[FLEN_FIXED + 1];
3312 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003313 char_u *fname = NULL;
3314 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315 int argcount = argcount_in;
3316 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003317 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003318 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003319 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003321 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003322 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003323 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003324 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003326 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3327 // even when call_func() returns FAIL.
3328 rettv->v_type = VAR_UNKNOWN;
3329
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003330 if (partial != NULL)
3331 fp = partial->pt_func;
3332 if (fp == NULL)
3333 {
3334 // Make a copy of the name, if it comes from a funcref variable it
3335 // could be changed or deleted in the called function.
3336 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3337 if (name == NULL)
3338 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003340 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3341 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003343 if (funcexe->fe_doesrange != NULL)
3344 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345
3346 if (partial != NULL)
3347 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003348 // When the function has a partial with a dict and there is a dict
3349 // argument, use the dict argument. That is backwards compatible.
3350 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003351 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003353 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 {
3355 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003356 {
3357 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3358 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003359 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003360 goto theend;
3361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003363 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 for (i = 0; i < argcount_in; ++i)
3365 argv[i + argv_clear] = argvars_in[i];
3366 argvars = argv;
3367 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003368
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003369 if (funcexe->fe_check_type != NULL
3370 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003371 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003372 // Now funcexe->fe_check_type is missing the added arguments,
3373 // make a copy of the type with the correction.
3374 check_type = *funcexe->fe_check_type;
3375 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003376 check_type.tt_args = check_type_args;
3377 CLEAR_FIELD(check_type_args);
3378 for (i = 0; i < check_type.tt_argcount; ++i)
3379 check_type_args[i + partial->pt_argc] =
3380 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003381 check_type.tt_argcount += partial->pt_argc;
3382 check_type.tt_min_argcount += partial->pt_argc;
3383 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 }
3385 }
3386
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003387 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3388 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003389 {
3390 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003391 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003392 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003393 error = FCERR_OTHER;
3394 }
3395
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003396 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 {
3398 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003399 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400
Bram Moolenaar333894b2020-08-01 18:53:07 +02003401 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003402 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003403 {
3404 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003406 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407
Bram Moolenaare38eab22019-12-05 21:50:01 +01003408 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003410 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003412 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003413 {
3414 /*
3415 * User defined function.
3416 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003417 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003418 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419
Bram Moolenaare38eab22019-12-05 21:50:01 +01003420 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 if (fp == NULL
3422 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003423 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 && !aborting())
3425 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003426 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003427 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003429 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3431 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003432 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003433 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003435 if (fp == NULL)
3436 {
3437 char_u *p = untrans_function_name(rfname);
3438
3439 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003440 // Don't do this if the name starts with "s:".
3441 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003442 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003443 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003445 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003446 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003447#ifdef FEAT_LUA
3448 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3449 {
3450 cfunc_T cb = fp->uf_cb;
3451
3452 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3453 }
3454#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003455 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003457 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003458 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003459 argcount = funcexe->fe_argv_func(argcount, argvars,
3460 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003461
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003462 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003463 {
3464 // Method call: base->Method()
3465 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003466 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003467 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003468 argvars = argv;
3469 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003470 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003471
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003472 error = call_user_func_check(fp, argcount, argvars, rettv,
3473 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003474 }
3475 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003476 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003477 {
3478 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003479 * expr->method(): Find the method name in the table, call its
3480 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003481 */
3482 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003483 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003484 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 else
3486 {
3487 /*
3488 * Find the function name in the table, call its implementation.
3489 */
3490 error = call_internal_func(fname, argcount, argvars, rettv);
3491 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003492
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493 /*
3494 * The function call (or "FuncUndefined" autocommand sequence) might
3495 * have been aborted by an error, an interrupt, or an explicitly thrown
3496 * exception that has not been caught so far. This situation can be
3497 * tested for by calling aborting(). For an error in an internal
3498 * function or for the "E132" error in call_user_func(), however, the
3499 * throw point at which the "force_abort" flag (temporarily reset by
3500 * emsg()) is normally updated has not been reached yet. We need to
3501 * update that flag first to make aborting() reliable.
3502 */
3503 update_force_abort();
3504 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003505 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003506 ret = OK;
3507
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003508theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 /*
3510 * Report an error unless the argument evaluation or function call has been
3511 * cancelled due to an aborting error, an interrupt, or an exception.
3512 */
3513 if (!aborting())
3514 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003515 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 }
3517
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003518 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003519 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003520 clear_tv(&argv[--argv_clear + argv_base]);
3521
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003522 vim_free(tofree);
3523 vim_free(name);
3524
3525 return ret;
3526}
3527
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003528 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003529printable_func_name(ufunc_T *fp)
3530{
3531 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3532}
3533
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003535 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 */
3537 static void
3538list_func_head(ufunc_T *fp, int indent)
3539{
3540 int j;
3541
3542 msg_start();
3543 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003544 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003545 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003546 msg_puts("def ");
3547 else
3548 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003549 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 msg_putchar('(');
3551 for (j = 0; j < fp->uf_args.ga_len; ++j)
3552 {
3553 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003554 msg_puts(", ");
3555 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003556 if (fp->uf_arg_types != NULL)
3557 {
3558 char *tofree;
3559
3560 msg_puts(": ");
3561 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3562 vim_free(tofree);
3563 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003564 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3565 {
3566 msg_puts(" = ");
3567 msg_puts(((char **)(fp->uf_def_args.ga_data))
3568 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3569 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 }
3571 if (fp->uf_varargs)
3572 {
3573 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003574 msg_puts(", ");
3575 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003577 if (fp->uf_va_name != NULL)
3578 {
3579 if (j)
3580 msg_puts(", ");
3581 msg_puts("...");
3582 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003583 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003584 {
3585 char *tofree;
3586
3587 msg_puts(": ");
3588 msg_puts(type_name(fp->uf_va_type, &tofree));
3589 vim_free(tofree);
3590 }
3591 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003593
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003594 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003595 {
3596 if (fp->uf_ret_type != &t_void)
3597 {
3598 char *tofree;
3599
3600 msg_puts(": ");
3601 msg_puts(type_name(fp->uf_ret_type, &tofree));
3602 vim_free(tofree);
3603 }
3604 }
3605 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003606 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003608 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003610 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003611 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003612 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003613 msg_clr_eos();
3614 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003615 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616}
3617
3618/*
3619 * Get a function name, translating "<SID>" and "<SNR>".
3620 * Also handles a Funcref in a List or Dictionary.
3621 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003622 * Set "*is_global" to TRUE when the function must be global, unless
3623 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 * flags:
3625 * TFN_INT: internal function name OK
3626 * TFN_QUIET: be quiet
3627 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003628 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 * Advances "pp" to just after the function name (if no error).
3630 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003631 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003632trans_function_name(
3633 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003634 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003635 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003637 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003638 partial_T **partial, // return: partial of a FuncRef
3639 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640{
3641 char_u *name = NULL;
3642 char_u *start;
3643 char_u *end;
3644 int lead;
3645 char_u sid_buf[20];
3646 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003647 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003649 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650
3651 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003652 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 start = *pp;
3654
Bram Moolenaare38eab22019-12-05 21:50:01 +01003655 // Check for hard coded <SNR>: already translated function ID (from a user
3656 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3658 && (*pp)[2] == (int)KE_SNR)
3659 {
3660 *pp += 3;
3661 len = get_id_len(pp) + 3;
3662 return vim_strnsave(start, len);
3663 }
3664
Bram Moolenaare38eab22019-12-05 21:50:01 +01003665 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3666 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667 lead = eval_fname_script(start);
3668 if (lead > 2)
3669 start += lead;
3670
Bram Moolenaare38eab22019-12-05 21:50:01 +01003671 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003672 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 lead > 2 ? 0 : FNE_CHECK_START);
3674 if (end == start)
3675 {
3676 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003677 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 goto theend;
3679 }
3680 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3681 {
3682 /*
3683 * Report an invalid expression in braces, unless the expression
3684 * evaluation has been cancelled due to an aborting error, an
3685 * interrupt, or an exception.
3686 */
3687 if (!aborting())
3688 {
3689 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003690 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003691 }
3692 else
3693 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3694 goto theend;
3695 }
3696
3697 if (lv.ll_tv != NULL)
3698 {
3699 if (fdp != NULL)
3700 {
3701 fdp->fd_dict = lv.ll_dict;
3702 fdp->fd_newkey = lv.ll_newkey;
3703 lv.ll_newkey = NULL;
3704 fdp->fd_di = lv.ll_di;
3705 }
3706 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3707 {
3708 name = vim_strsave(lv.ll_tv->vval.v_string);
3709 *pp = end;
3710 }
3711 else if (lv.ll_tv->v_type == VAR_PARTIAL
3712 && lv.ll_tv->vval.v_partial != NULL)
3713 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003714 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 *pp = end;
3716 if (partial != NULL)
3717 *partial = lv.ll_tv->vval.v_partial;
3718 }
3719 else
3720 {
3721 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3722 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003723 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724 else
3725 *pp = end;
3726 name = NULL;
3727 }
3728 goto theend;
3729 }
3730
3731 if (lv.ll_name == NULL)
3732 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003733 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 *pp = end;
3735 goto theend;
3736 }
3737
Bram Moolenaare38eab22019-12-05 21:50:01 +01003738 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 if (lv.ll_exp_name != NULL)
3740 {
3741 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003742 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003743 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744 if (name == lv.ll_exp_name)
3745 name = NULL;
3746 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003747 else if (lv.ll_sid > 0)
3748 {
3749 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3750 int cc = *lv.ll_name_end;
3751
3752 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3753 *lv.ll_name_end = NUL;
3754 if (si->sn_autoload_prefix != NULL)
3755 {
3756 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3757 }
3758 else
3759 {
3760 sid_buf[0] = K_SPECIAL;
3761 sid_buf[1] = KS_EXTRA;
3762 sid_buf[2] = (int)KE_SNR;
3763 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
3764 "%ld_", (long)current_sctx.sc_sid);
3765 name = concat_str(sid_buf, lv.ll_name);
3766 }
3767 *lv.ll_name_end = cc;
3768 *pp = end;
3769 goto theend;
3770 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003771 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 {
3773 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003774 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003775 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 if (name == *pp)
3777 name = NULL;
3778 }
3779 if (name != NULL)
3780 {
3781 name = vim_strsave(name);
3782 *pp = end;
3783 if (STRNCMP(name, "<SNR>", 5) == 0)
3784 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003785 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 name[0] = K_SPECIAL;
3787 name[1] = KS_EXTRA;
3788 name[2] = (int)KE_SNR;
3789 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3790 }
3791 goto theend;
3792 }
3793
3794 if (lv.ll_exp_name != NULL)
3795 {
3796 len = (int)STRLEN(lv.ll_exp_name);
3797 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3798 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3799 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003800 // When there was "s:" already or the name expanded to get a
3801 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802 lv.ll_name += 2;
3803 len -= 2;
3804 lead = 2;
3805 }
3806 }
3807 else
3808 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003809 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003811 {
3812 if (is_global != NULL && lv.ll_name[0] == 'g')
3813 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003815 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 len = (int)(end - lv.ll_name);
3817 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003818 if (len <= 0)
3819 {
3820 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003821 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003822 goto theend;
3823 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003825 // In Vim9 script a user function is script-local by default, unless it
3826 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003827 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003828 if (vim9script)
3829 {
3830 char_u *p;
3831
3832 // SomeScript#func() is a global function.
3833 for (p = start; *p != NUL && *p != '('; ++p)
3834 if (*p == AUTOLOAD_CHAR)
3835 vim9script = FALSE;
3836 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003837
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 /*
3839 * Copy the function name to allocated memory.
3840 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3841 * Accept <SNR>123_name() outside a script.
3842 */
3843 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003844 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003845 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003847 if (!vim9script)
3848 lead = 3;
3849 if (vim9script || (lv.ll_exp_name != NULL
3850 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003851 || eval_fname_sid(*pp))
3852 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003853 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003854 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003856 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857 goto theend;
3858 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003859 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003860 if (vim9script)
3861 extra = 3 + (int)STRLEN(sid_buf);
3862 else
3863 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864 }
3865 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003866 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3867 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003869 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003870 goto theend;
3871 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003872 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 {
3874 char_u *cp = vim_strchr(lv.ll_name, ':');
3875
3876 if (cp != NULL && cp < end)
3877 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003878 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879 goto theend;
3880 }
3881 }
3882
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003883 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003884 if (name != NULL)
3885 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003886 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 {
3888 name[0] = K_SPECIAL;
3889 name[1] = KS_EXTRA;
3890 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003891 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 STRCPY(name + 3, sid_buf);
3893 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003894 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3895 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003896 }
3897 *pp = end;
3898
3899theend:
3900 clear_lval(&lv);
3901 return name;
3902}
3903
3904/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003905 * Assuming "name" is the result of trans_function_name() and it was prefixed
3906 * to use the script-local name, return the unmodified name (points into
3907 * "name"). Otherwise return NULL.
3908 * This can be used to first search for a script-local function and fall back
3909 * to the global function if not found.
3910 */
3911 char_u *
3912untrans_function_name(char_u *name)
3913{
3914 char_u *p;
3915
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003916 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003917 {
3918 p = vim_strchr(name, '_');
3919 if (p != NULL)
3920 return p + 1;
3921 }
3922 return NULL;
3923}
3924
3925/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003926 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3927 * current script ID and returns the expanded function name. The caller should
3928 * free the returned name. If not called from a script context or the function
3929 * name doesn't start with these prefixes, then returns NULL.
3930 * This doesn't check whether the script-local function exists or not.
3931 */
3932 char_u *
3933get_scriptlocal_funcname(char_u *funcname)
3934{
3935 char sid_buf[25];
3936 int off;
3937 char_u *newname;
3938
3939 if (funcname == NULL)
3940 return NULL;
3941
3942 if (STRNCMP(funcname, "s:", 2) != 0
3943 && STRNCMP(funcname, "<SID>", 5) != 0)
3944 // The function name is not a script-local function name
3945 return NULL;
3946
3947 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3948 {
3949 emsg(_(e_using_sid_not_in_script_context));
3950 return NULL;
3951 }
3952 // Expand s: prefix into <SNR>nr_<name>
3953 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3954 (long)current_sctx.sc_sid);
3955 off = *funcname == 's' ? 2 : 5;
3956 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3957 if (newname == NULL)
3958 return NULL;
3959 STRCPY(newname, sid_buf);
3960 STRCAT(newname, funcname + off);
3961
3962 return newname;
3963}
3964
3965/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003966 * Call trans_function_name(), except that a lambda is returned as-is.
3967 * Returns the name in allocated memory.
3968 */
3969 char_u *
3970save_function_name(
3971 char_u **name,
3972 int *is_global,
3973 int skip,
3974 int flags,
3975 funcdict_T *fudi)
3976{
3977 char_u *p = *name;
3978 char_u *saved;
3979
3980 if (STRNCMP(p, "<lambda>", 8) == 0)
3981 {
3982 p += 8;
3983 (void)getdigits(&p);
3984 saved = vim_strnsave(*name, p - *name);
3985 if (fudi != NULL)
3986 CLEAR_POINTER(fudi);
3987 }
3988 else
3989 saved = trans_function_name(&p, is_global, skip,
3990 flags, fudi, NULL, NULL);
3991 *name = p;
3992 return saved;
3993}
3994
3995/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003996 * List functions. When "regmatch" is NULL all of then.
3997 * Otherwise functions matching "regmatch".
3998 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003999 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004000list_functions(regmatch_T *regmatch)
4001{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004002 int changed = func_hashtab.ht_changed;
4003 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004004 hashitem_T *hi;
4005
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004006 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004007 {
4008 if (!HASHITEM_EMPTY(hi))
4009 {
4010 ufunc_T *fp = HI2UF(hi);
4011
4012 --todo;
4013 if ((fp->uf_flags & FC_DEAD) == 0
4014 && (regmatch == NULL
4015 ? !message_filtered(fp->uf_name)
4016 && !func_name_refcount(fp->uf_name)
4017 : !isdigit(*fp->uf_name)
4018 && vim_regexec(regmatch, fp->uf_name, 0)))
4019 {
4020 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004021 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004022 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004023 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004024 return;
4025 }
4026 }
4027 }
4028 }
4029}
4030
4031/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004032 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004033 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4034 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004035 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004036 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004038 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004039define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 int j;
4042 int c;
4043 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004044 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004045 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 char_u *p;
4047 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004048 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004049 char_u *line_arg = NULL;
4050 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004051 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004052 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 garray_T newlines;
4054 int varargs = FALSE;
4055 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004056 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004057 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004058 int fp_allocated = FALSE;
4059 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004060 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061 dictitem_T *v;
4062 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004063 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004064 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004066 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004067 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004068 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069
4070 /*
4071 * ":function" without argument: list functions.
4072 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004073 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 {
4075 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004076 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004077 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004078 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 }
4080
4081 /*
4082 * ":function /pat": list functions matching pattern.
4083 */
4084 if (*eap->arg == '/')
4085 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004086 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087 if (!eap->skip)
4088 {
4089 regmatch_T regmatch;
4090
4091 c = *p;
4092 *p = NUL;
4093 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4094 *p = c;
4095 if (regmatch.regprog != NULL)
4096 {
4097 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004098 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099 vim_regfree(regmatch.regprog);
4100 }
4101 }
4102 if (*p == '/')
4103 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004104 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004105 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106 }
4107
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004108 ga_init(&newargs);
4109 ga_init(&argtypes);
4110 ga_init(&default_args);
4111
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 /*
4113 * Get the function name. There are these situations:
4114 * func normal function name
4115 * "name" == func, "fudi.fd_dict" == NULL
4116 * dict.func new dictionary entry
4117 * "name" == NULL, "fudi.fd_dict" set,
4118 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4119 * dict.func existing dict entry with a Funcref
4120 * "name" == func, "fudi.fd_dict" set,
4121 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4122 * dict.func existing dict entry that's not a Funcref
4123 * "name" == NULL, "fudi.fd_dict" set,
4124 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4125 * s:func script-local function name
4126 * g:func global function name, same as "func"
4127 */
4128 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004129 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004131 // nested function, argument is (args).
4132 paren = TRUE;
4133 CLEAR_FIELD(fudi);
4134 }
4135 else
4136 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004137 name = save_function_name(&p, &is_global, eap->skip,
4138 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004139 paren = (vim_strchr(p, '(') != NULL);
4140 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004142 /*
4143 * Return on an invalid expression in braces, unless the expression
4144 * evaluation has been cancelled due to an aborting error, an
4145 * interrupt, or an exception.
4146 */
4147 if (!aborting())
4148 {
4149 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004150 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004151 vim_free(fudi.fd_newkey);
4152 return NULL;
4153 }
4154 else
4155 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004157
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004158 // For "export def FuncName()" in an autoload script the function name
4159 // is stored with the legacy autoload name "dir#script#FuncName" so
4160 // that it can also be found in legacy script.
4161 if (is_export)
4162 name = may_prefix_autoload(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163 }
4164
Bram Moolenaare38eab22019-12-05 21:50:01 +01004165 // An error in a function call during evaluation of an expression in magic
4166 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 saved_did_emsg = did_emsg;
4168 did_emsg = FALSE;
4169
4170 /*
4171 * ":function func" with only function name: list function.
4172 */
4173 if (!paren)
4174 {
4175 if (!ends_excmd(*skipwhite(p)))
4176 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004177 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 goto ret_free;
4179 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004180 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 if (eap->nextcmd != NULL)
4182 *p = NUL;
4183 if (!eap->skip && !got_int)
4184 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004185 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004186 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4187 {
4188 char_u *up = untrans_function_name(name);
4189
4190 // With Vim9 script the name was made script-local, if not
4191 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004192 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004193 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004194 }
4195
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196 if (fp != NULL)
4197 {
4198 list_func_head(fp, TRUE);
4199 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4200 {
4201 if (FUNCLINE(fp, j) == NULL)
4202 continue;
4203 msg_putchar('\n');
4204 msg_outnum((long)(j + 1));
4205 if (j < 9)
4206 msg_putchar(' ');
4207 if (j < 99)
4208 msg_putchar(' ');
4209 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004210 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 ui_breakcheck();
4212 }
4213 if (!got_int)
4214 {
4215 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004216 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004217 msg_puts(" enddef");
4218 else
4219 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220 }
4221 }
4222 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004223 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004224 }
4225 goto ret_free;
4226 }
4227
4228 /*
4229 * ":function name(arg1, arg2)" Define function.
4230 */
4231 p = skipwhite(p);
4232 if (*p != '(')
4233 {
4234 if (!eap->skip)
4235 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004236 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 goto ret_free;
4238 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004239 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240 if (vim_strchr(p, '(') != NULL)
4241 p = vim_strchr(p, '(');
4242 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004244 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4245 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004246 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004247 goto ret_free;
4248 }
4249
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004250 // In Vim9 script only global functions can be redefined.
4251 if (vim9script && eap->forceit && !is_global)
4252 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004253 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004254 goto ret_free;
4255 }
4256
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004257 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258
Bram Moolenaar04b12692020-05-04 23:24:44 +02004259 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004261 // Check the name of the function. Unless it's a dictionary function
4262 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263 if (name != NULL)
4264 arg = name;
4265 else
4266 arg = fudi.fd_newkey;
4267 if (arg != NULL && (fudi.fd_di == NULL
4268 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4269 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4270 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004271 char_u *name_base = arg;
4272 int i;
4273
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004275 {
4276 name_base = vim_strchr(arg, '_');
4277 if (name_base == NULL)
4278 name_base = arg + 3;
4279 else
4280 ++name_base;
4281 }
4282 for (i = 0; name_base[i] != NUL && (i == 0
4283 ? eval_isnamec1(name_base[i])
4284 : eval_isnamec(name_base[i])); ++i)
4285 ;
4286 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004287 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004288
4289 // In Vim9 script a function cannot have the same name as a
4290 // variable.
4291 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004292 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4293 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004294 + EVAL_VAR_NO_FUNC) == OK)
4295 {
4296 semsg(_(e_redefining_script_item_str), name_base);
4297 goto ret_free;
4298 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004300 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004302 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004303 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004304 goto ret_free;
4305 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306 }
4307
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004308 // This may get more lines and make the pointers into the first line
4309 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004310 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004311 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004312 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004313 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004314 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004316 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004318 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004320 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004321 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004323 if (*p != ':')
4324 {
4325 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4326 p = skipwhite(p);
4327 }
4328 else if (!IS_WHITE_OR_NUL(p[1]))
4329 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004330 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004331 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004332 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004333 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004334 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004335 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004336 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004337 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004338 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004339 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004340 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004341 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004342 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004344 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004346 else
4347 // find extra arguments "range", "dict", "abort" and "closure"
4348 for (;;)
4349 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004350 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004351 p = skipwhite(p);
4352 if (STRNCMP(p, "range", 5) == 0)
4353 {
4354 flags |= FC_RANGE;
4355 p += 5;
4356 }
4357 else if (STRNCMP(p, "dict", 4) == 0)
4358 {
4359 flags |= FC_DICT;
4360 p += 4;
4361 }
4362 else if (STRNCMP(p, "abort", 5) == 0)
4363 {
4364 flags |= FC_ABORT;
4365 p += 5;
4366 }
4367 else if (STRNCMP(p, "closure", 7) == 0)
4368 {
4369 flags |= FC_CLOSURE;
4370 p += 7;
4371 if (current_funccal == NULL)
4372 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004373 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004374 name == NULL ? (char_u *)"" : name);
4375 goto erret;
4376 }
4377 }
4378 else
4379 break;
4380 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004381
Bram Moolenaare38eab22019-12-05 21:50:01 +01004382 // When there is a line break use what follows for the function body.
4383 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384 if (*p == '\n')
4385 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004386 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004387 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4388 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004389 && !(VIM_ISWHITE(*whitep) && *p == '#'
4390 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004391 && !eap->skip
4392 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004393 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394
4395 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004396 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4397 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 */
4399 if (KeyTyped)
4400 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004401 // Check if the function already exists, don't let the user type the
4402 // whole function before telling him it doesn't work! For a script we
4403 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004404 if (!eap->skip && !eap->forceit)
4405 {
4406 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004407 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004408 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004409 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 }
4411
4412 if (!eap->skip && did_emsg)
4413 goto erret;
4414
Bram Moolenaare38eab22019-12-05 21:50:01 +01004415 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 cmdline_row = msg_row;
4417 }
4418
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004419 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004420 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004421
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004422 // Do not define the function when getting the body fails and when
4423 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004424 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004425 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426 goto erret;
4427
4428 /*
4429 * If there are no errors, add the function
4430 */
4431 if (fudi.fd_dict == NULL)
4432 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004433 hashtab_T *ht;
4434
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004435 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4437 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004438 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 goto erret;
4440 }
4441
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004442 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004443 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004444 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004445 char_u *uname = untrans_function_name(name);
4446
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004447 import = find_imported(uname == NULL ? name : uname, 0, FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004448 }
4449
4450 if (fp != NULL || import != NULL)
4451 {
4452 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004453
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004454 // Function can be replaced with "function!" and when sourcing the
4455 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004456 // A name that is used by an import can not be overruled.
4457 if (import != NULL
4458 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004459 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004460 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004462 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004463 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004464 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004465 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004466 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467 goto erret;
4468 }
4469 if (fp->uf_calls > 0)
4470 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004471 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004472 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 goto erret;
4474 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004475 if (fp->uf_refcount > 1)
4476 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004477 // This function is referenced somewhere, don't redefine it but
4478 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004479 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004480 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004481 fp = NULL;
4482 overwrite = TRUE;
4483 }
4484 else
4485 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004486 char_u *exp_name = fp->uf_name_exp;
4487
4488 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004489 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004490 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004491 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004492 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004493 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004494#ifdef FEAT_PROFILE
4495 fp->uf_profiling = FALSE;
4496 fp->uf_prof_initialized = FALSE;
4497#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004498 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004499 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500 }
4501 }
4502 else
4503 {
4504 char numbuf[20];
4505
4506 fp = NULL;
4507 if (fudi.fd_newkey == NULL && !eap->forceit)
4508 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004509 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 goto erret;
4511 }
4512 if (fudi.fd_di == NULL)
4513 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004514 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004515 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 goto erret;
4517 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004518 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004519 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004520 goto erret;
4521
Bram Moolenaare38eab22019-12-05 21:50:01 +01004522 // Give the function a sequential number. Can only be used with a
4523 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524 vim_free(name);
4525 sprintf(numbuf, "%d", ++func_nr);
4526 name = vim_strsave((char_u *)numbuf);
4527 if (name == NULL)
4528 goto erret;
4529 }
4530
4531 if (fp == NULL)
4532 {
4533 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4534 {
4535 int slen, plen;
4536 char_u *scriptname;
4537
Bram Moolenaare38eab22019-12-05 21:50:01 +01004538 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004540 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 {
4542 scriptname = autoload_name(name);
4543 if (scriptname != NULL)
4544 {
4545 p = vim_strchr(scriptname, '/');
4546 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004547 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004549 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550 j = OK;
4551 vim_free(scriptname);
4552 }
4553 }
4554 if (j == FAIL)
4555 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004556 linenr_T save_lnum = SOURCING_LNUM;
4557
4558 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004559 semsg(_(e_function_name_does_not_match_script_file_name_str),
4560 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004561 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 goto erret;
4563 }
4564 }
4565
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004566 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004567 if (fp == NULL)
4568 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004569 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004570
4571 if (fudi.fd_dict != NULL)
4572 {
4573 if (fudi.fd_di == NULL)
4574 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004575 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4577 if (fudi.fd_di == NULL)
4578 {
4579 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004580 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 goto erret;
4582 }
4583 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4584 {
4585 vim_free(fudi.fd_di);
4586 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004587 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004588 goto erret;
4589 }
4590 }
4591 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004592 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 clear_tv(&fudi.fd_di->di_tv);
4594 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596
Bram Moolenaare38eab22019-12-05 21:50:01 +01004597 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598 flags |= FC_DICT;
4599 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 }
4601 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004602 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004603 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004604 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004605
4606 if (eap->cmdidx == CMD_def)
4607 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004608 int lnum_save = SOURCING_LNUM;
4609 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004610
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004611 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004612
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004613 // error messages are for the first function line
4614 SOURCING_LNUM = sourcing_lnum_top;
4615
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004616 // The function may use script variables from the context.
4617 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004618
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004619 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004620 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004621 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004622 free_fp = fp_allocated;
4623 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004624 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004625 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004626
4627 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004628 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004629 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004630 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004631 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004632 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004633 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004634 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004635 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004636 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004637 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004638
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004639 if (fp_allocated)
4640 {
4641 // insert the new function in the function list
4642 set_ufunc_name(fp, name);
4643 if (overwrite)
4644 {
4645 hi = hash_find(&func_hashtab, name);
4646 hi->hi_key = UF2HIKEY(fp);
4647 }
4648 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4649 {
4650 free_fp = TRUE;
4651 goto erret;
4652 }
4653 fp->uf_refcount = 1;
4654 }
4655
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004657 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004658 if ((flags & FC_CLOSURE) != 0)
4659 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004660 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004661 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004662 }
4663 else
4664 fp->uf_scoped = NULL;
4665
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004666#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 if (prof_def_func())
4668 func_do_profile(fp);
4669#endif
4670 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004671 if (sandbox)
4672 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004673 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004674 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675 fp->uf_flags = flags;
4676 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004677 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004678 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004679 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004680 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004681 if (is_export)
4682 {
4683 fp->uf_flags |= FC_EXPORT;
4684 // let ex_export() know the export worked.
4685 is_export = FALSE;
4686 }
4687
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004688 if (eap->cmdidx == CMD_def)
4689 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004690 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4691 // :func does not use Vim9 script syntax, even in a Vim9 script file
4692 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004693
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 goto ret_free;
4695
4696erret:
4697 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004698 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004699 if (fp != NULL)
4700 {
4701 ga_init(&fp->uf_args);
4702 ga_init(&fp->uf_def_args);
4703 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004704errret_2:
4705 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004706 if (fp != NULL)
4707 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004708 if (free_fp)
4709 {
4710 vim_free(fp);
4711 fp = NULL;
4712 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004714 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004716 if (name != name_arg)
4717 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004718 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004720
4721 return fp;
4722}
4723
4724/*
4725 * ":function"
4726 */
4727 void
4728ex_function(exarg_T *eap)
4729{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004730 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004731
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004732 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4733 (void)define_function(eap, NULL, &lines_to_free);
4734 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004735}
4736
4737/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004738 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004739 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004740 */
4741 void
4742ex_defcompile(exarg_T *eap UNUSED)
4743{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004744 long todo = (long)func_hashtab.ht_used;
4745 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004746 hashitem_T *hi;
4747 ufunc_T *ufunc;
4748
4749 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4750 {
4751 if (!HASHITEM_EMPTY(hi))
4752 {
4753 --todo;
4754 ufunc = HI2UF(hi);
4755 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004756 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4757 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004758 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004759 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004760
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004761 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004762 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004763 // a function has been added or removed, need to start over
4764 todo = (long)func_hashtab.ht_used;
4765 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004766 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004767 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004768 }
4769 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004770 }
4771 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004772}
4773
4774/*
4775 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4776 * Return 2 if "p" starts with "s:".
4777 * Return 0 otherwise.
4778 */
4779 int
4780eval_fname_script(char_u *p)
4781{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004782 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4783 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4785 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4786 return 5;
4787 if (p[0] == 's' && p[1] == ':')
4788 return 2;
4789 return 0;
4790}
4791
4792 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004793translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004794{
4795 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004796 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004797 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004798}
4799
4800/*
4801 * Return TRUE when "ufunc" has old-style "..." varargs
4802 * or named varargs "...name: type".
4803 */
4804 int
4805has_varargs(ufunc_T *ufunc)
4806{
4807 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004808}
4809
4810/*
4811 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004812 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 */
4814 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004815function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004816{
4817 char_u *nm = name;
4818 char_u *p;
4819 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004820 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004821 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004822
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004823 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4824 if (no_deref)
4825 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004826 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 nm = skipwhite(nm);
4828
Bram Moolenaare38eab22019-12-05 21:50:01 +01004829 // Only accept "funcname", "funcname ", "funcname (..." and
4830 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004831 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004832 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 vim_free(p);
4834 return n;
4835}
4836
Bram Moolenaar113e1072019-01-20 15:30:40 +01004837#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 char_u *
4839get_expanded_name(char_u *name, int check)
4840{
4841 char_u *nm = name;
4842 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004843 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004845 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004846 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004848 if (p != NULL && *nm == NUL
4849 && (!check || translated_function_exists(p, is_global)))
4850 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004851
4852 vim_free(p);
4853 return NULL;
4854}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004855#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004856
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857/*
4858 * Function given to ExpandGeneric() to obtain the list of user defined
4859 * function names.
4860 */
4861 char_u *
4862get_user_func_name(expand_T *xp, int idx)
4863{
4864 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004865 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866 static hashitem_T *hi;
4867 ufunc_T *fp;
4868
4869 if (idx == 0)
4870 {
4871 done = 0;
4872 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004873 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004875 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004876 {
4877 if (done++ > 0)
4878 ++hi;
4879 while (HASHITEM_EMPTY(hi))
4880 ++hi;
4881 fp = HI2UF(hi);
4882
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004883 // don't show dead, dict and lambda functions
4884 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004885 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004886 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004887
4888 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004889 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004890
4891 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004892 if (xp->xp_context != EXPAND_USER_FUNC
4893 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894 {
4895 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004896 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004897 STRCAT(IObuff, ")");
4898 }
4899 return IObuff;
4900 }
4901 return NULL;
4902}
4903
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904/*
4905 * ":delfunction {name}"
4906 */
4907 void
4908ex_delfunction(exarg_T *eap)
4909{
4910 ufunc_T *fp = NULL;
4911 char_u *p;
4912 char_u *name;
4913 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004914 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004915
4916 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004917 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4918 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919 vim_free(fudi.fd_newkey);
4920 if (name == NULL)
4921 {
4922 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004923 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004924 return;
4925 }
4926 if (!ends_excmd(*skipwhite(p)))
4927 {
4928 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00004929 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930 return;
4931 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004932 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004933 if (eap->nextcmd != NULL)
4934 *p = NUL;
4935
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004936 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004937 {
4938 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004939 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004940 vim_free(name);
4941 return;
4942 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004944 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 vim_free(name);
4946
4947 if (!eap->skip)
4948 {
4949 if (fp == NULL)
4950 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004951 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004952 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 return;
4954 }
4955 if (fp->uf_calls > 0)
4956 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004957 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004958 return;
4959 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004960 if (fp->uf_flags & FC_VIM9)
4961 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004962 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004963 return;
4964 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965
4966 if (fudi.fd_dict != NULL)
4967 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004968 // Delete the dict item that refers to the function, it will
4969 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004970 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4971 }
4972 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004973 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004974 // A normal function (not a numbered function or lambda) has a
4975 // refcount of 1 for the entry in the hashtable. When deleting
4976 // it and the refcount is more than one, it should be kept.
4977 // A numbered function and lambda should be kept if the refcount is
4978 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004979 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004980 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004981 // Function is still referenced somewhere. Don't free it but
4982 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004983 if (func_remove(fp))
4984 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004985 }
4986 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004987 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004988 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004989 }
4990}
4991
4992/*
4993 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004994 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004995 */
4996 void
4997func_unref(char_u *name)
4998{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004999 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005000
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005001 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005002 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005003 fp = find_func(name, FALSE, NULL);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005004 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005006#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005007 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005008#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005009 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005010 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005011 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005012}
5013
5014/*
5015 * Unreference a Function: decrement the reference count and free it when it
5016 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005017 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005018 */
5019 void
5020func_ptr_unref(ufunc_T *fp)
5021{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005022 if (fp != NULL && (--fp->uf_refcount <= 0
5023 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5024 && fp->uf_partial->pt_refcount <= 1
5025 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005026 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005027 // Only delete it when it's not being used. Otherwise it's done
5028 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005029 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005030 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005031 }
5032}
5033
5034/*
5035 * Count a reference to a Function.
5036 */
5037 void
5038func_ref(char_u *name)
5039{
5040 ufunc_T *fp;
5041
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005042 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005043 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005044 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005045 if (fp != NULL)
5046 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005047 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005048 // Only give an error for a numbered function.
5049 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005050 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005051}
5052
5053/*
5054 * Count a reference to a Function.
5055 */
5056 void
5057func_ptr_ref(ufunc_T *fp)
5058{
5059 if (fp != NULL)
5060 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005061}
5062
5063/*
5064 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5065 * referenced from anywhere that is in use.
5066 */
5067 static int
5068can_free_funccal(funccall_T *fc, int copyID)
5069{
5070 return (fc->l_varlist.lv_copyID != copyID
5071 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005072 && fc->l_avars.dv_copyID != copyID
5073 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074}
5075
5076/*
5077 * ":return [expr]"
5078 */
5079 void
5080ex_return(exarg_T *eap)
5081{
5082 char_u *arg = eap->arg;
5083 typval_T rettv;
5084 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005085 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005086
5087 if (current_funccal == NULL)
5088 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005089 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005090 return;
5091 }
5092
Bram Moolenaar844fb642021-10-23 13:32:30 +01005093 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005094 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5095
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005096 if (eap->skip)
5097 ++emsg_skip;
5098
5099 eap->nextcmd = NULL;
5100 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005101 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102 {
5103 if (!eap->skip)
5104 returning = do_return(eap, FALSE, TRUE, &rettv);
5105 else
5106 clear_tv(&rettv);
5107 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005108 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109 else if (!eap->skip)
5110 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005111 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005112 update_force_abort();
5113
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005114 /*
5115 * Return unless the expression evaluation has been cancelled due to an
5116 * aborting error, an interrupt, or an exception.
5117 */
5118 if (!aborting())
5119 returning = do_return(eap, FALSE, TRUE, NULL);
5120 }
5121
Bram Moolenaare38eab22019-12-05 21:50:01 +01005122 // When skipping or the return gets pending, advance to the next command
5123 // in this line (!returning). Otherwise, ignore the rest of the line.
5124 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005125 if (returning)
5126 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005127 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005128 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005129
5130 if (eap->skip)
5131 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005132 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005133}
5134
5135/*
5136 * ":1,25call func(arg1, arg2)" function call.
5137 */
5138 void
5139ex_call(exarg_T *eap)
5140{
5141 char_u *arg = eap->arg;
5142 char_u *startarg;
5143 char_u *name;
5144 char_u *tofree;
5145 int len;
5146 typval_T rettv;
5147 linenr_T lnum;
5148 int doesrange;
5149 int failed = FALSE;
5150 funcdict_T fudi;
5151 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005152 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005153 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005154 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005155
Bram Moolenaare6b53242020-07-01 17:28:33 +02005156 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005157 if (eap->skip)
5158 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005159 // trans_function_name() doesn't work well when skipping, use eval0()
5160 // instead to skip to any following command, e.g. for:
5161 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005163 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005164 clear_tv(&rettv);
5165 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005166 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005167 return;
5168 }
5169
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005170 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5171 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172 if (fudi.fd_newkey != NULL)
5173 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005174 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005175 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005176 vim_free(fudi.fd_newkey);
5177 }
5178 if (tofree == NULL)
5179 return;
5180
Bram Moolenaare38eab22019-12-05 21:50:01 +01005181 // Increase refcount on dictionary, it could get deleted when evaluating
5182 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005183 if (fudi.fd_dict != NULL)
5184 ++fudi.fd_dict->dv_refcount;
5185
Bram Moolenaare38eab22019-12-05 21:50:01 +01005186 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5187 // contents. For VAR_PARTIAL get its partial, unless we already have one
5188 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005189 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005190 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005191 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192
Bram Moolenaare38eab22019-12-05 21:50:01 +01005193 // Skip white space to allow ":call func ()". Not good, but required for
5194 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005195 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005196 if (*startarg != '(')
5197 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005198 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005199 goto end;
5200 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005201 if (in_vim9script() && startarg > arg)
5202 {
5203 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5204 goto end;
5205 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005206
5207 /*
5208 * When skipping, evaluate the function once, to find the end of the
5209 * arguments.
5210 * When the function takes a range, this is discovered after the first
5211 * call, and the loop is broken.
5212 */
5213 if (eap->skip)
5214 {
5215 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005216 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005217 }
5218 else
5219 lnum = eap->line1;
5220 for ( ; lnum <= eap->line2; ++lnum)
5221 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005222 funcexe_T funcexe;
5223
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224 if (!eap->skip && eap->addr_count > 0)
5225 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005226 if (lnum > curbuf->b_ml.ml_line_count)
5227 {
5228 // If the function deleted lines or switched to another buffer
5229 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005230 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005231 break;
5232 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005233 curwin->w_cursor.lnum = lnum;
5234 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005235 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 }
5237 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005238
Bram Moolenaara80faa82020-04-12 19:37:17 +02005239 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005240 funcexe.fe_firstline = eap->line1;
5241 funcexe.fe_lastline = eap->line2;
5242 funcexe.fe_doesrange = &doesrange;
5243 funcexe.fe_evaluate = !eap->skip;
5244 funcexe.fe_partial = partial;
5245 funcexe.fe_selfdict = fudi.fd_dict;
5246 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005247 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005248 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005249 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005250 {
5251 failed = TRUE;
5252 break;
5253 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005254 if (has_watchexpr())
5255 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005256
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005257 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005258 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005259 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005260 {
5261 failed = TRUE;
5262 break;
5263 }
5264
5265 clear_tv(&rettv);
5266 if (doesrange || eap->skip)
5267 break;
5268
Bram Moolenaare38eab22019-12-05 21:50:01 +01005269 // Stop when immediately aborting on error, or when an interrupt
5270 // occurred or an exception was thrown but not caught.
5271 // get_func_tv() returned OK, so that the check for trailing
5272 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005273 if (aborting())
5274 break;
5275 }
5276 if (eap->skip)
5277 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005278 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005279
Bram Moolenaar1d341892021-09-18 15:25:52 +02005280 // When inside :try we need to check for following "| catch" or "| endtry".
5281 // Not when there was an error, but do check if an exception was thrown.
5282 if ((!aborting() || did_throw)
5283 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005284 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005285 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005286 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005287 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005288 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005289 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005290 {
5291 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005292 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005294 }
5295 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005296 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 }
5298
5299end:
5300 dict_unref(fudi.fd_dict);
5301 vim_free(tofree);
5302}
5303
5304/*
5305 * Return from a function. Possibly makes the return pending. Also called
5306 * for a pending return at the ":endtry" or after returning from an extra
5307 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5308 * when called due to a ":return" command. "rettv" may point to a typval_T
5309 * with the return rettv. Returns TRUE when the return can be carried out,
5310 * FALSE when the return gets pending.
5311 */
5312 int
5313do_return(
5314 exarg_T *eap,
5315 int reanimate,
5316 int is_cmd,
5317 void *rettv)
5318{
5319 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005320 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005321
5322 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005323 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005324 current_funccal->returned = FALSE;
5325
5326 /*
5327 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5328 * not in its finally clause (which then is to be executed next) is found.
5329 * In this case, make the ":return" pending for execution at the ":endtry".
5330 * Otherwise, return normally.
5331 */
5332 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5333 if (idx >= 0)
5334 {
5335 cstack->cs_pending[idx] = CSTP_RETURN;
5336
5337 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005338 // A pending return again gets pending. "rettv" points to an
5339 // allocated variable with the rettv of the original ":return"'s
5340 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005341 cstack->cs_rettv[idx] = rettv;
5342 else
5343 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005344 // When undoing a return in order to make it pending, get the stored
5345 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005346 if (reanimate)
5347 rettv = current_funccal->rettv;
5348
5349 if (rettv != NULL)
5350 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005351 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005352 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5353 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5354 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005355 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005356 }
5357 else
5358 cstack->cs_rettv[idx] = NULL;
5359
5360 if (reanimate)
5361 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005362 // The pending return value could be overwritten by a ":return"
5363 // without argument in a finally clause; reset the default
5364 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005365 current_funccal->rettv->v_type = VAR_NUMBER;
5366 current_funccal->rettv->vval.v_number = 0;
5367 }
5368 }
5369 report_make_pending(CSTP_RETURN, rettv);
5370 }
5371 else
5372 {
5373 current_funccal->returned = TRUE;
5374
Bram Moolenaare38eab22019-12-05 21:50:01 +01005375 // If the return is carried out now, store the return value. For
5376 // a return immediately after reanimation, the value is already
5377 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005378 if (!reanimate && rettv != NULL)
5379 {
5380 clear_tv(current_funccal->rettv);
5381 *current_funccal->rettv = *(typval_T *)rettv;
5382 if (!is_cmd)
5383 vim_free(rettv);
5384 }
5385 }
5386
5387 return idx < 0;
5388}
5389
5390/*
5391 * Free the variable with a pending return value.
5392 */
5393 void
5394discard_pending_return(void *rettv)
5395{
5396 free_tv((typval_T *)rettv);
5397}
5398
5399/*
5400 * Generate a return command for producing the value of "rettv". The result
5401 * is an allocated string. Used by report_pending() for verbose messages.
5402 */
5403 char_u *
5404get_return_cmd(void *rettv)
5405{
5406 char_u *s = NULL;
5407 char_u *tofree = NULL;
5408 char_u numbuf[NUMBUFLEN];
5409
5410 if (rettv != NULL)
5411 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5412 if (s == NULL)
5413 s = (char_u *)"";
5414
5415 STRCPY(IObuff, ":return ");
5416 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5417 if (STRLEN(s) + 8 >= IOSIZE)
5418 STRCPY(IObuff + IOSIZE - 4, "...");
5419 vim_free(tofree);
5420 return vim_strsave(IObuff);
5421}
5422
5423/*
5424 * Get next function line.
5425 * Called by do_cmdline() to get the next line.
5426 * Returns allocated string, or NULL for end of function.
5427 */
5428 char_u *
5429get_func_line(
5430 int c UNUSED,
5431 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005432 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005433 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005434{
5435 funccall_T *fcp = (funccall_T *)cookie;
5436 ufunc_T *fp = fcp->func;
5437 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005438 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005439
Bram Moolenaare38eab22019-12-05 21:50:01 +01005440 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005441 if (fcp->dbg_tick != debug_tick)
5442 {
5443 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005444 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005445 fcp->dbg_tick = debug_tick;
5446 }
5447#ifdef FEAT_PROFILE
5448 if (do_profiling == PROF_YES)
5449 func_line_end(cookie);
5450#endif
5451
5452 gap = &fp->uf_lines;
5453 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5454 || fcp->returned)
5455 retval = NULL;
5456 else
5457 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005458 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005459 while (fcp->linenr < gap->ga_len
5460 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5461 ++fcp->linenr;
5462 if (fcp->linenr >= gap->ga_len)
5463 retval = NULL;
5464 else
5465 {
5466 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005467 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005468#ifdef FEAT_PROFILE
5469 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005470 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005471#endif
5472 }
5473 }
5474
Bram Moolenaare38eab22019-12-05 21:50:01 +01005475 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005476 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005477 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005478 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005479 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005480 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005481 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005482 fcp->dbg_tick = debug_tick;
5483 }
5484
5485 return retval;
5486}
5487
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005488/*
5489 * Return TRUE if the currently active function should be ended, because a
5490 * return was encountered or an error occurred. Used inside a ":while".
5491 */
5492 int
5493func_has_ended(void *cookie)
5494{
5495 funccall_T *fcp = (funccall_T *)cookie;
5496
Bram Moolenaare38eab22019-12-05 21:50:01 +01005497 // Ignore the "abort" flag if the abortion behavior has been changed due to
5498 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005499 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5500 || fcp->returned);
5501}
5502
5503/*
5504 * return TRUE if cookie indicates a function which "abort"s on errors.
5505 */
5506 int
5507func_has_abort(
5508 void *cookie)
5509{
5510 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5511}
5512
5513
5514/*
5515 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5516 * Don't do this when "Func" is already a partial that was bound
5517 * explicitly (pt_auto is FALSE).
5518 * Changes "rettv" in-place.
5519 * Returns the updated "selfdict_in".
5520 */
5521 dict_T *
5522make_partial(dict_T *selfdict_in, typval_T *rettv)
5523{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005524 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005525 char_u *tofree = NULL;
5526 ufunc_T *fp;
5527 char_u fname_buf[FLEN_FIXED + 1];
5528 int error;
5529 dict_T *selfdict = selfdict_in;
5530
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005531 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5532 fp = rettv->vval.v_partial->pt_func;
5533 else
5534 {
5535 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5536 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005537 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005538 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005539 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005540 vim_free(tofree);
5541 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005542
5543 if (fp != NULL && (fp->uf_flags & FC_DICT))
5544 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005545 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005546
5547 if (pt != NULL)
5548 {
5549 pt->pt_refcount = 1;
5550 pt->pt_dict = selfdict;
5551 pt->pt_auto = TRUE;
5552 selfdict = NULL;
5553 if (rettv->v_type == VAR_FUNC)
5554 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005555 // Just a function: Take over the function name and use
5556 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005557 pt->pt_name = rettv->vval.v_string;
5558 }
5559 else
5560 {
5561 partial_T *ret_pt = rettv->vval.v_partial;
5562 int i;
5563
Bram Moolenaare38eab22019-12-05 21:50:01 +01005564 // Partial: copy the function name, use selfdict and copy
5565 // args. Can't take over name or args, the partial might
5566 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005567 if (ret_pt->pt_name != NULL)
5568 {
5569 pt->pt_name = vim_strsave(ret_pt->pt_name);
5570 func_ref(pt->pt_name);
5571 }
5572 else
5573 {
5574 pt->pt_func = ret_pt->pt_func;
5575 func_ptr_ref(pt->pt_func);
5576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005577 if (ret_pt->pt_argc > 0)
5578 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005579 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005580 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005581 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005582 pt->pt_argc = 0;
5583 else
5584 {
5585 pt->pt_argc = ret_pt->pt_argc;
5586 for (i = 0; i < pt->pt_argc; i++)
5587 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5588 }
5589 }
5590 partial_unref(ret_pt);
5591 }
5592 rettv->v_type = VAR_PARTIAL;
5593 rettv->vval.v_partial = pt;
5594 }
5595 }
5596 return selfdict;
5597}
5598
5599/*
5600 * Return the name of the executed function.
5601 */
5602 char_u *
5603func_name(void *cookie)
5604{
5605 return ((funccall_T *)cookie)->func->uf_name;
5606}
5607
5608/*
5609 * Return the address holding the next breakpoint line for a funccall cookie.
5610 */
5611 linenr_T *
5612func_breakpoint(void *cookie)
5613{
5614 return &((funccall_T *)cookie)->breakpoint;
5615}
5616
5617/*
5618 * Return the address holding the debug tick for a funccall cookie.
5619 */
5620 int *
5621func_dbg_tick(void *cookie)
5622{
5623 return &((funccall_T *)cookie)->dbg_tick;
5624}
5625
5626/*
5627 * Return the nesting level for a funccall cookie.
5628 */
5629 int
5630func_level(void *cookie)
5631{
5632 return ((funccall_T *)cookie)->level;
5633}
5634
5635/*
5636 * Return TRUE when a function was ended by a ":return" command.
5637 */
5638 int
5639current_func_returned(void)
5640{
5641 return current_funccal->returned;
5642}
5643
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005644 int
5645free_unref_funccal(int copyID, int testing)
5646{
5647 int did_free = FALSE;
5648 int did_free_funccal = FALSE;
5649 funccall_T *fc, **pfc;
5650
5651 for (pfc = &previous_funccal; *pfc != NULL; )
5652 {
5653 if (can_free_funccal(*pfc, copyID))
5654 {
5655 fc = *pfc;
5656 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005657 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005658 did_free = TRUE;
5659 did_free_funccal = TRUE;
5660 }
5661 else
5662 pfc = &(*pfc)->caller;
5663 }
5664 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005665 // When a funccal was freed some more items might be garbage
5666 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005667 (void)garbage_collect(testing);
5668
5669 return did_free;
5670}
5671
5672/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005673 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005674 */
5675 static funccall_T *
5676get_funccal(void)
5677{
5678 int i;
5679 funccall_T *funccal;
5680 funccall_T *temp_funccal;
5681
5682 funccal = current_funccal;
5683 if (debug_backtrace_level > 0)
5684 {
5685 for (i = 0; i < debug_backtrace_level; i++)
5686 {
5687 temp_funccal = funccal->caller;
5688 if (temp_funccal)
5689 funccal = temp_funccal;
5690 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005691 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005692 debug_backtrace_level = i;
5693 }
5694 }
5695 return funccal;
5696}
5697
5698/*
5699 * Return the hashtable used for local variables in the current funccal.
5700 * Return NULL if there is no current funccal.
5701 */
5702 hashtab_T *
5703get_funccal_local_ht()
5704{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005705 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005706 return NULL;
5707 return &get_funccal()->l_vars.dv_hashtab;
5708}
5709
5710/*
5711 * Return the l: scope variable.
5712 * Return NULL if there is no current funccal.
5713 */
5714 dictitem_T *
5715get_funccal_local_var()
5716{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005717 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005718 return NULL;
5719 return &get_funccal()->l_vars_var;
5720}
5721
5722/*
5723 * Return the hashtable used for argument in the current funccal.
5724 * Return NULL if there is no current funccal.
5725 */
5726 hashtab_T *
5727get_funccal_args_ht()
5728{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005729 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005730 return NULL;
5731 return &get_funccal()->l_avars.dv_hashtab;
5732}
5733
5734/*
5735 * Return the a: scope variable.
5736 * Return NULL if there is no current funccal.
5737 */
5738 dictitem_T *
5739get_funccal_args_var()
5740{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005741 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005742 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005743 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005744}
5745
5746/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005747 * List function variables, if there is a function.
5748 */
5749 void
5750list_func_vars(int *first)
5751{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005752 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005753 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005754 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005755}
5756
5757/*
5758 * If "ht" is the hashtable for local variables in the current funccal, return
5759 * the dict that contains it.
5760 * Otherwise return NULL.
5761 */
5762 dict_T *
5763get_current_funccal_dict(hashtab_T *ht)
5764{
5765 if (current_funccal != NULL
5766 && ht == &current_funccal->l_vars.dv_hashtab)
5767 return &current_funccal->l_vars;
5768 return NULL;
5769}
5770
5771/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005772 * Search hashitem in parent scope.
5773 */
5774 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005775find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005776{
5777 funccall_T *old_current_funccal = current_funccal;
5778 hashtab_T *ht;
5779 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005780 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005781
5782 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5783 return NULL;
5784
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005785 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005786 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005787 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005788 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005789 ht = find_var_ht(name, &varname);
5790 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005791 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005792 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005793 if (!HASHITEM_EMPTY(hi))
5794 {
5795 *pht = ht;
5796 break;
5797 }
5798 }
5799 if (current_funccal == current_funccal->func->uf_scoped)
5800 break;
5801 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005802 }
5803 current_funccal = old_current_funccal;
5804
5805 return hi;
5806}
5807
5808/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005809 * Search variable in parent scope.
5810 */
5811 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005812find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005813{
5814 dictitem_T *v = NULL;
5815 funccall_T *old_current_funccal = current_funccal;
5816 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005817 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005818
5819 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5820 return NULL;
5821
Bram Moolenaare38eab22019-12-05 21:50:01 +01005822 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005823 current_funccal = current_funccal->func->uf_scoped;
5824 while (current_funccal)
5825 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005826 ht = find_var_ht(name, &varname);
5827 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005828 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005829 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005830 if (v != NULL)
5831 break;
5832 }
5833 if (current_funccal == current_funccal->func->uf_scoped)
5834 break;
5835 current_funccal = current_funccal->func->uf_scoped;
5836 }
5837 current_funccal = old_current_funccal;
5838
5839 return v;
5840}
5841
5842/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005843 * Set "copyID + 1" in previous_funccal and callers.
5844 */
5845 int
5846set_ref_in_previous_funccal(int copyID)
5847{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005848 funccall_T *fc;
5849
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005850 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005851 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005852 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005853 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5854 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5855 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5856 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005857 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005858 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005859}
5860
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005861 static int
5862set_ref_in_funccal(funccall_T *fc, int copyID)
5863{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005864 if (fc->fc_copyID != copyID)
5865 {
5866 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005867 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5868 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5869 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5870 || set_ref_in_func(NULL, fc->func, copyID))
5871 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005872 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005873 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005874}
5875
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005876/*
5877 * Set "copyID" in all local vars and arguments in the call stack.
5878 */
5879 int
5880set_ref_in_call_stack(int copyID)
5881{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005882 funccall_T *fc;
5883 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005884
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005885 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5886 if (set_ref_in_funccal(fc, copyID))
5887 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005888
5889 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005890 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5891 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5892 if (set_ref_in_funccal(fc, copyID))
5893 return TRUE;
5894 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005895}
5896
5897/*
5898 * Set "copyID" in all functions available by name.
5899 */
5900 int
5901set_ref_in_functions(int copyID)
5902{
5903 int todo;
5904 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005905 ufunc_T *fp;
5906
5907 todo = (int)func_hashtab.ht_used;
5908 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005909 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005910 if (!HASHITEM_EMPTY(hi))
5911 {
5912 --todo;
5913 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005914 if (!func_name_refcount(fp->uf_name)
5915 && set_ref_in_func(NULL, fp, copyID))
5916 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005917 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005918 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005919 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005920}
5921
5922/*
5923 * Set "copyID" in all function arguments.
5924 */
5925 int
5926set_ref_in_func_args(int copyID)
5927{
5928 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005929
5930 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005931 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5932 copyID, NULL, NULL))
5933 return TRUE;
5934 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005935}
5936
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005937/*
5938 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005939 * Returns TRUE if setting references failed somehow.
5940 */
5941 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005942set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005943{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005944 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005945 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005946 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005947 char_u fname_buf[FLEN_FIXED + 1];
5948 char_u *tofree = NULL;
5949 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005950 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005951
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005952 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005953 return FALSE;
5954
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005955 if (fp_in == NULL)
5956 {
5957 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005958 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005959 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005960 if (fp != NULL)
5961 {
5962 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005963 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005964 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005965
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005966 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005967 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005968}
5969
Bram Moolenaare38eab22019-12-05 21:50:01 +01005970#endif // FEAT_EVAL