blob: 020d1bcfcb1942715f07c29ef5f2b8214ce65749 [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)
225 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100226 if (argtypes != NULL)
227 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200228 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200229 ga_init2(default_args, (int)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
1152 ga_init2(&newlines, (int)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 Moolenaara9b579f2016-07-17 18:29:19 +02001439 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1440 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 }
1611 import = find_imported(p, len, NULL);
1612
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 Moolenaara9b579f2016-07-17 18:29:19 +02001706
1707 /*
1708 * Get the arguments.
1709 */
1710 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001711 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1712 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001714 // skip the '(' or ',' and possibly line breaks
1715 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1716
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 if (*argp == ')' || *argp == ',' || *argp == NUL)
1718 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001719 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720 {
1721 ret = FAIL;
1722 break;
1723 }
1724 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001725 // The comma should come right after the argument, but this wasn't
1726 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001727 if (vim9script)
1728 {
1729 if (*argp != ',' && *skipwhite(argp) == ',')
1730 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001731 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001732 ret = FAIL;
1733 break;
1734 }
1735 }
1736 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001737 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001738 if (*argp != ',')
1739 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001740 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1741 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001742 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001743 ret = FAIL;
1744 break;
1745 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001746 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001747 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001748 if (*argp == ')')
1749 ++argp;
1750 else
1751 ret = FAIL;
1752
1753 if (ret == OK)
1754 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001755 int i = 0;
1756 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001757
1758 if (get_vim_var_nr(VV_TESTING))
1759 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001760 // Prepare for calling test_garbagecollect_now(), need to know
1761 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001762 if (funcargs.ga_itemsize == 0)
1763 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1764 for (i = 0; i < argcount; ++i)
1765 if (ga_grow(&funcargs, 1) == OK)
1766 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1767 &argvars[i];
1768 }
1769
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001770 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001771 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001772 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001773 // An error in a builtin function does not return FAIL, but we do
1774 // want to abort further processing if an error was given.
1775 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001776 clear_tv(rettv);
1777 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778
1779 funcargs.ga_len -= i;
1780 }
1781 else if (!aborting())
1782 {
1783 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001784 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001786 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 }
1788
1789 while (--argcount >= 0)
1790 clear_tv(&argvars[argcount]);
1791
Bram Moolenaar8294d492020-08-10 22:40:56 +02001792 if (in_vim9script())
1793 *arg = argp;
1794 else
1795 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796 return ret;
1797}
1798
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799/*
1800 * Return TRUE if "p" starts with "<SID>" or "s:".
1801 * Only works if eval_fname_script() returned non-zero for "p"!
1802 */
1803 static int
1804eval_fname_sid(char_u *p)
1805{
1806 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1807}
1808
1809/*
1810 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1811 * Change <SNR>123_name() to K_SNR 123_name().
1812 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1813 * (slow).
1814 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001815 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1817{
1818 int llen;
1819 char_u *fname;
1820 int i;
1821
1822 llen = eval_fname_script(name);
1823 if (llen > 0)
1824 {
1825 fname_buf[0] = K_SPECIAL;
1826 fname_buf[1] = KS_EXTRA;
1827 fname_buf[2] = (int)KE_SNR;
1828 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001829 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001831 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001832 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 else
1834 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001835 sprintf((char *)fname_buf + 3, "%ld_",
1836 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837 i = (int)STRLEN(fname_buf);
1838 }
1839 }
1840 if (i + STRLEN(name + llen) < FLEN_FIXED)
1841 {
1842 STRCPY(fname_buf + i, name + llen);
1843 fname = fname_buf;
1844 }
1845 else
1846 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001847 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001849 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 else
1851 {
1852 *tofree = fname;
1853 mch_memmove(fname, fname_buf, (size_t)i);
1854 STRCPY(fname + i, name + llen);
1855 }
1856 }
1857 }
1858 else
1859 fname = name;
1860 return fname;
1861}
1862
1863/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001864 * Find a function "name" in script "sid".
1865 */
1866 static ufunc_T *
1867find_func_with_sid(char_u *name, int sid)
1868{
1869 hashitem_T *hi;
1870 char_u buffer[200];
1871
1872 buffer[0] = K_SPECIAL;
1873 buffer[1] = KS_EXTRA;
1874 buffer[2] = (int)KE_SNR;
1875 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1876 (long)sid, name);
1877 hi = hash_find(&func_hashtab, buffer);
1878 if (!HASHITEM_EMPTY(hi))
1879 return HI2UF(hi);
1880
1881 return NULL;
1882}
1883
1884/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001886 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001887 * Return NULL for unknown function.
1888 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001889 ufunc_T *
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001890find_func_even_dead(char_u *name, int is_global, cctx_T *cctx UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001891{
1892 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001893 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001894
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001895 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001896 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001897 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1898 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001899
Bram Moolenaar95006e32020-08-29 17:47:08 +02001900 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001901 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001902 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001903 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1904 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001905 if (func != NULL)
1906 return func;
1907 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001908 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909
Bram Moolenaara26b9702020-04-18 19:53:28 +02001910 hi = hash_find(&func_hashtab,
1911 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001912 if (!HASHITEM_EMPTY(hi))
1913 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001914
1915 return NULL;
1916}
1917
1918/*
1919 * Find a function by name, return pointer to it in ufuncs.
1920 * "cctx" is passed in a :def function to find imported functions.
1921 * Return NULL for unknown or dead function.
1922 */
1923 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001924find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001925{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001926 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001927
1928 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1929 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001930 return NULL;
1931}
1932
1933/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001934 * Return TRUE if "ufunc" is a global function.
1935 */
1936 int
1937func_is_global(ufunc_T *ufunc)
1938{
1939 return ufunc->uf_name[0] != K_SPECIAL;
1940}
1941
1942/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943 * Copy the function name of "fp" to buffer "buf".
1944 * "buf" must be able to hold the function name plus three bytes.
1945 * Takes care of script-local function names.
1946 */
1947 static void
1948cat_func_name(char_u *buf, ufunc_T *fp)
1949{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001950 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951 {
1952 STRCPY(buf, "<SNR>");
1953 STRCAT(buf, fp->uf_name + 3);
1954 }
1955 else
1956 STRCPY(buf, fp->uf_name);
1957}
1958
1959/*
1960 * Add a number variable "name" to dict "dp" with value "nr".
1961 */
1962 static void
1963add_nr_var(
1964 dict_T *dp,
1965 dictitem_T *v,
1966 char *name,
1967 varnumber_T nr)
1968{
1969 STRCPY(v->di_key, name);
1970 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1971 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1972 v->di_tv.v_type = VAR_NUMBER;
1973 v->di_tv.v_lock = VAR_FIXED;
1974 v->di_tv.vval.v_number = nr;
1975}
1976
1977/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001978 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001979 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001980 static void
1981free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001982{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001983 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001984
1985 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1986 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001987 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001988
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001989 // When garbage collecting a funccall_T may be freed before the
1990 // function that references it, clear its uf_scoped field.
1991 // The function may have been redefined and point to another
1992 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001993 if (fp != NULL && fp->uf_scoped == fc)
1994 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001995 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001996 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001997
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001998 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001999 vim_free(fc);
2000}
2001
2002/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002003 * Free "fc" and what it contains.
2004 * Can be called only when "fc" is kept beyond the period of it called,
2005 * i.e. after cleanup_function_call(fc).
2006 */
2007 static void
2008free_funccal_contents(funccall_T *fc)
2009{
2010 listitem_T *li;
2011
2012 // Free all l: variables.
2013 vars_clear(&fc->l_vars.dv_hashtab);
2014
2015 // Free all a: variables.
2016 vars_clear(&fc->l_avars.dv_hashtab);
2017
2018 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002019 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002020 clear_tv(&li->li_tv);
2021
2022 free_funccal(fc);
2023}
2024
2025/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002026 * Handle the last part of returning from a function: free the local hashtable.
2027 * Unless it is still in use by a closure.
2028 */
2029 static void
2030cleanup_function_call(funccall_T *fc)
2031{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002032 int may_free_fc = fc->fc_refcount <= 0;
2033 int free_fc = TRUE;
2034
Bram Moolenaar6914c642017-04-01 21:21:30 +02002035 current_funccal = fc->caller;
2036
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002037 // Free all l: variables if not referred.
2038 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2039 vars_clear(&fc->l_vars.dv_hashtab);
2040 else
2041 free_fc = FALSE;
2042
2043 // If the a:000 list and the l: and a: dicts are not referenced and
2044 // there is no closure using it, we can free the funccall_T and what's
2045 // in it.
2046 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2047 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002048 else
2049 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002050 int todo;
2051 hashitem_T *hi;
2052 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002053
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002054 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002055
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002056 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002057 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2058 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2059 {
2060 if (!HASHITEM_EMPTY(hi))
2061 {
2062 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002063 di = HI2DI(hi);
2064 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002065 }
2066 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002067 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002068
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002069 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2070 fc->l_varlist.lv_first = NULL;
2071 else
2072 {
2073 listitem_T *li;
2074
2075 free_fc = FALSE;
2076
2077 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002078 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002079 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002080 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002081
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002082 if (free_fc)
2083 free_funccal(fc);
2084 else
2085 {
2086 static int made_copy = 0;
2087
2088 // "fc" is still in use. This can happen when returning "a:000",
2089 // assigning "l:" to a global variable or defining a closure.
2090 // Link "fc" in the list for garbage collection later.
2091 fc->caller = previous_funccal;
2092 previous_funccal = fc;
2093
2094 if (want_garbage_collect)
2095 // If garbage collector is ready, clear count.
2096 made_copy = 0;
2097 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002098 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002099 // We have made a lot of copies, worth 4 Mbyte. This can happen
2100 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002101 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002102 // too much memory.
2103 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002104 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002105 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002106 }
2107}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002108
2109/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002110 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2111 */
2112 static int
2113numbered_function(char_u *name)
2114{
2115 return isdigit(*name)
2116 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2117}
2118
2119/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002120 * There are two kinds of function names:
2121 * 1. ordinary names, function defined with :function or :def
2122 * 2. numbered functions and lambdas
2123 * For the first we only count the name stored in func_hashtab as a reference,
2124 * using function() does not count as a reference, because the function is
2125 * looked up by name.
2126 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002127 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002128func_name_refcount(char_u *name)
2129{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002130 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002131}
2132
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002133/*
2134 * Unreference "fc": decrement the reference count and free it when it
2135 * becomes zero. "fp" is detached from "fc".
2136 * When "force" is TRUE we are exiting.
2137 */
2138 static void
2139funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2140{
2141 funccall_T **pfc;
2142 int i;
2143
2144 if (fc == NULL)
2145 return;
2146
2147 if (--fc->fc_refcount <= 0 && (force || (
2148 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2149 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2150 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2151 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2152 {
2153 if (fc == *pfc)
2154 {
2155 *pfc = fc->caller;
2156 free_funccal_contents(fc);
2157 return;
2158 }
2159 }
2160 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2161 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2162 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2163}
2164
2165/*
2166 * Remove the function from the function hashtable. If the function was
2167 * deleted while it still has references this was already done.
2168 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2169 */
2170 static int
2171func_remove(ufunc_T *fp)
2172{
2173 hashitem_T *hi;
2174
2175 // Return if it was already virtually deleted.
2176 if (fp->uf_flags & FC_DEAD)
2177 return FALSE;
2178
2179 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2180 if (!HASHITEM_EMPTY(hi))
2181 {
2182 // When there is a def-function index do not actually remove the
2183 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002184 // Do remove it when it's a copy.
2185 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002186 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002187 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002188 return FALSE;
2189 }
2190 hash_remove(&func_hashtab, hi);
2191 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002192 return TRUE;
2193 }
2194 return FALSE;
2195}
2196
2197 static void
2198func_clear_items(ufunc_T *fp)
2199{
2200 ga_clear_strings(&(fp->uf_args));
2201 ga_clear_strings(&(fp->uf_def_args));
2202 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002203 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002204 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002205 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002206 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002207
2208 // Increment the refcount of this function to avoid it being freed
2209 // recursively when the partial is freed.
2210 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002211 partial_unref(fp->uf_partial);
2212 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002213 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002214
2215#ifdef FEAT_LUA
2216 if (fp->uf_cb_free != NULL)
2217 {
2218 fp->uf_cb_free(fp->uf_cb_state);
2219 fp->uf_cb_free = NULL;
2220 }
2221
2222 fp->uf_cb_state = NULL;
2223 fp->uf_cb = NULL;
2224#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002225#ifdef FEAT_PROFILE
2226 VIM_CLEAR(fp->uf_tml_count);
2227 VIM_CLEAR(fp->uf_tml_total);
2228 VIM_CLEAR(fp->uf_tml_self);
2229#endif
2230}
2231
2232/*
2233 * Free all things that a function contains. Does not free the function
2234 * itself, use func_free() for that.
2235 * When "force" is TRUE we are exiting.
2236 */
2237 static void
2238func_clear(ufunc_T *fp, int force)
2239{
2240 if (fp->uf_cleared)
2241 return;
2242 fp->uf_cleared = TRUE;
2243
2244 // clear this function
2245 func_clear_items(fp);
2246 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002247 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002248}
2249
2250/*
2251 * Free a function and remove it from the list of functions. Does not free
2252 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002253 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002254 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002255 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002256 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002257func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002258{
2259 // Only remove it when not done already, otherwise we would remove a newer
2260 // version of the function with the same name.
2261 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2262 func_remove(fp);
2263
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002264 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002265 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002266 if (fp->uf_dfunc_idx > 0)
2267 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002268 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002269 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002270 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002271 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002272 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002273}
2274
2275/*
2276 * Free all things that a function contains and free the function itself.
2277 * When "force" is TRUE we are exiting.
2278 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002279 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002280func_clear_free(ufunc_T *fp, int force)
2281{
2282 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002283 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2284 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002285 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002286 else
2287 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002288}
2289
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002290/*
2291 * Copy already defined function "lambda" to a new function with name "global".
2292 * This is for when a compiled function defines a global function.
2293 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002294 int
2295copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002296{
2297 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002298 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002299
2300 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002301 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002302 semsg(_(e_lambda_function_not_found_str), lambda);
2303 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002304 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002305
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002306 fp = find_func(global, TRUE, NULL);
2307 if (fp != NULL)
2308 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002309 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002310 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002311 return FAIL;
2312 }
2313
2314 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2315 if (fp == NULL)
2316 return FAIL;
2317
2318 fp->uf_varargs = ufunc->uf_varargs;
2319 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2320 fp->uf_def_status = ufunc->uf_def_status;
2321 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2322 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2323 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2324 == FAIL
2325 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2326 goto failed;
2327
2328 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2329 : vim_strsave(ufunc->uf_name_exp);
2330 if (ufunc->uf_arg_types != NULL)
2331 {
2332 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2333 if (fp->uf_arg_types == NULL)
2334 goto failed;
2335 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2336 sizeof(type_T *) * fp->uf_args.ga_len);
2337 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002338 if (ufunc->uf_va_name != NULL)
2339 {
2340 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2341 if (fp->uf_va_name == NULL)
2342 goto failed;
2343 }
2344 fp->uf_ret_type = ufunc->uf_ret_type;
2345
2346 fp->uf_refcount = 1;
2347 STRCPY(fp->uf_name, global);
2348 hash_add(&func_hashtab, UF2HIKEY(fp));
2349
2350 // the referenced dfunc_T is now used one more time
2351 link_def_function(fp);
2352
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002353 // Create a partial to store the context of the function where it was
2354 // instantiated. Only needs to be done once. Do this on the original
2355 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002356 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2357 {
2358 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2359
2360 if (pt == NULL)
2361 goto failed;
2362 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002363 {
2364 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002365 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002366 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002367 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002368 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002369 }
2370
2371 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002372
2373failed:
2374 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002375 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002376}
2377
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002378static int funcdepth = 0;
2379
2380/*
2381 * Increment the function call depth count.
2382 * Return FAIL when going over 'maxfuncdepth'.
2383 * Otherwise return OK, must call funcdepth_decrement() later!
2384 */
2385 int
2386funcdepth_increment(void)
2387{
2388 if (funcdepth >= p_mfd)
2389 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002390 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002391 return FAIL;
2392 }
2393 ++funcdepth;
2394 return OK;
2395}
2396
2397 void
2398funcdepth_decrement(void)
2399{
2400 --funcdepth;
2401}
2402
2403/*
2404 * Get the current function call depth.
2405 */
2406 int
2407funcdepth_get(void)
2408{
2409 return funcdepth;
2410}
2411
2412/*
2413 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002414 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002415 * times as funcdepth_increment().
2416 */
2417 void
2418funcdepth_restore(int depth)
2419{
2420 funcdepth = depth;
2421}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002422
2423/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002424 * Call a user function.
2425 */
2426 static void
2427call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002428 ufunc_T *fp, // pointer to function
2429 int argcount, // nr of args
2430 typval_T *argvars, // arguments
2431 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002432 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002433 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002435 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002436 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002437 funccall_T *fc;
2438 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002439 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002441 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 int i;
2443 int ai;
2444 int islambda = FALSE;
2445 char_u numbuf[NUMBUFLEN];
2446 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002447 typval_T *tv_to_free[MAX_FUNC_ARGS];
2448 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002450 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002452 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453
Bram Moolenaarb2049902021-01-24 12:53:53 +01002454#ifdef FEAT_PROFILE
2455 CLEAR_FIELD(profile_info);
2456#endif
2457
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002458 // If depth of calling is getting too high, don't execute the function.
2459 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002460 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461 rettv->v_type = VAR_NUMBER;
2462 rettv->vval.v_number = -1;
2463 return;
2464 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002465
Bram Moolenaare38eab22019-12-05 21:50:01 +01002466 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002468 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002469 if (fc == NULL)
2470 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 fc->caller = current_funccal;
2472 current_funccal = fc;
2473 fc->func = fp;
2474 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002476 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002477 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2478 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002479 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002480 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002481 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002482
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002483 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002484 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002485#ifdef FEAT_PROFILE
2486 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2487#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002488 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002489#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002490 if (do_profiling == PROF_YES)
2491 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002492#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002493 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002494 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002495#ifdef FEAT_PROFILE
2496 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002497 || (caller != NULL && caller->uf_profiling)))
2498 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002499#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002500 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002501 free_funccal(fc);
2502 return;
2503 }
2504
Bram Moolenaar38453522021-11-28 22:00:12 +00002505 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506
2507 /*
2508 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2509 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2510 * each argument variable and saves a lot of time.
2511 */
2512 /*
2513 * Init l: variables.
2514 */
2515 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2516 if (selfdict != NULL)
2517 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002518 // Set l:self to "selfdict". Use "name" to avoid a warning from
2519 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 v = &fc->fixvar[fixvar_idx++].var;
2521 name = v->di_key;
2522 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002523 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2525 v->di_tv.v_type = VAR_DICT;
2526 v->di_tv.v_lock = 0;
2527 v->di_tv.vval.v_dict = selfdict;
2528 ++selfdict->dv_refcount;
2529 }
2530
2531 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002532 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002533 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 * Set a:000 to a list with room for the "..." arguments.
2535 */
2536 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002537 if ((fp->uf_flags & FC_NOARGS) == 0)
2538 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002539 (varnumber_T)(argcount >= fp->uf_args.ga_len
2540 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002541 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002542 if ((fp->uf_flags & FC_NOARGS) == 0)
2543 {
2544 // Use "name" to avoid a warning from some compiler that checks the
2545 // destination size.
2546 v = &fc->fixvar[fixvar_idx++].var;
2547 name = v->di_key;
2548 STRCPY(name, "000");
2549 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2550 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2551 v->di_tv.v_type = VAR_LIST;
2552 v->di_tv.v_lock = VAR_FIXED;
2553 v->di_tv.vval.v_list = &fc->l_varlist;
2554 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002555 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2557 fc->l_varlist.lv_lock = VAR_FIXED;
2558
2559 /*
2560 * Set a:firstline to "firstline" and a:lastline to "lastline".
2561 * Set a:name to named arguments.
2562 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002563 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002565 if ((fp->uf_flags & FC_NOARGS) == 0)
2566 {
2567 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002568 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002569 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002570 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002571 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002572 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 {
2574 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002575 typval_T def_rettv;
2576 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002577
2578 ai = i - fp->uf_args.ga_len;
2579 if (ai < 0)
2580 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002581 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582 name = FUNCARG(fp, i);
2583 if (islambda)
2584 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002585
2586 // evaluate named argument default expression
2587 isdefault = ai + fp->uf_def_args.ga_len >= 0
2588 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2589 && argvars[i].vval.v_number == VVAL_NONE));
2590 if (isdefault)
2591 {
2592 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002593
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002594 def_rettv.v_type = VAR_NUMBER;
2595 def_rettv.vval.v_number = -1;
2596
2597 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2598 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002599 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002600 {
2601 default_arg_err = 1;
2602 break;
2603 }
2604 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002605 }
2606 else
2607 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002608 if ((fp->uf_flags & FC_NOARGS) != 0)
2609 // Bail out if no a: arguments used (in lambda).
2610 break;
2611
Bram Moolenaare38eab22019-12-05 21:50:01 +01002612 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 sprintf((char *)numbuf, "%d", ai + 1);
2614 name = numbuf;
2615 }
2616 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2617 {
2618 v = &fc->fixvar[fixvar_idx++].var;
2619 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002620 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 }
2622 else
2623 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002624 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002625 if (v == NULL)
2626 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002627 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002629
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002630 // Note: the values are copied directly to avoid alloc/free.
2631 // "argvars" must have VAR_FIXED for v_lock.
2632 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 v->di_tv.v_lock = VAR_FIXED;
2634
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002635 if (isdefault)
2636 // Need to free this later, no matter where it's stored.
2637 tv_to_free[tv_to_free_len++] = &v->di_tv;
2638
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 if (addlocal)
2640 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002641 // Named arguments should be accessed without the "a:" prefix in
2642 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002643 copy_tv(&v->di_tv, &v->di_tv);
2644 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002645 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002646 else
2647 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648
2649 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2650 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002651 listitem_T *li = &fc->l_listitems[ai];
2652
2653 li->li_tv = argvars[i];
2654 li->li_tv.v_lock = VAR_FIXED;
2655 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 }
2657 }
2658
Bram Moolenaare38eab22019-12-05 21:50:01 +01002659 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002661
2662 if (fp->uf_flags & FC_SANDBOX)
2663 {
2664 using_sandbox = TRUE;
2665 ++sandbox;
2666 }
2667
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002668 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002669 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002670 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002671 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002672 ++no_wait_return;
2673 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002675 smsg(_("calling %s"), SOURCING_NAME);
2676 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002678 char_u buf[MSG_BUF_LEN];
2679 char_u numbuf2[NUMBUFLEN];
2680 char_u *tofree;
2681 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002683 msg_puts("(");
2684 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002686 if (i > 0)
2687 msg_puts(", ");
2688 if (argvars[i].v_type == VAR_NUMBER)
2689 msg_outnum((long)argvars[i].vval.v_number);
2690 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002692 // Do not want errors such as E724 here.
2693 ++emsg_off;
2694 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2695 --emsg_off;
2696 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002698 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002700 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2701 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002703 msg_puts((char *)s);
2704 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 }
2706 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002708 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002710 msg_puts("\n"); // don't overwrite this either
2711
2712 verbose_leave_scroll();
2713 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 }
2715#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002716 if (do_profiling == PROF_YES)
2717 profile_may_start_func(&profile_info, fp,
2718 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719#endif
2720
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002721 save_current_sctx = current_sctx;
2722 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 save_did_emsg = did_emsg;
2724 did_emsg = FALSE;
2725
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002726 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2727 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002728 else if (islambda)
2729 {
2730 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2731
2732 // A Lambda always has the command "return {expr}". It is much faster
2733 // to evaluate {expr} directly.
2734 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002735 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002736 --ex_nesting_level;
2737 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002738 else
2739 // call do_cmdline() to execute the lines
2740 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002741 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2742
2743 --RedrawingDisabled;
2744
Bram Moolenaare38eab22019-12-05 21:50:01 +01002745 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2747 {
2748 clear_tv(rettv);
2749 rettv->v_type = VAR_NUMBER;
2750 rettv->vval.v_number = -1;
2751 }
2752
2753#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002754 if (do_profiling == PROF_YES)
2755 {
2756 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2757
2758 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2759 profile_may_end_func(&profile_info, fp, caller);
2760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761#endif
2762
Bram Moolenaare38eab22019-12-05 21:50:01 +01002763 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764 if (p_verbose >= 12)
2765 {
2766 ++no_wait_return;
2767 verbose_enter_scroll();
2768
2769 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002770 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002772 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773 (long)fc->rettv->vval.v_number);
2774 else
2775 {
2776 char_u buf[MSG_BUF_LEN];
2777 char_u numbuf2[NUMBUFLEN];
2778 char_u *tofree;
2779 char_u *s;
2780
Bram Moolenaare38eab22019-12-05 21:50:01 +01002781 // The value may be very long. Skip the middle part, so that we
2782 // have some idea how it starts and ends. smsg() would always
2783 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002784 ++emsg_off;
2785 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2786 --emsg_off;
2787 if (s != NULL)
2788 {
2789 if (vim_strsize(s) > MSG_BUF_CLEN)
2790 {
2791 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2792 s = buf;
2793 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002794 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795 vim_free(tofree);
2796 }
2797 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002798 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799
2800 verbose_leave_scroll();
2801 --no_wait_return;
2802 }
2803
Bram Moolenaare31ee862020-01-07 20:59:34 +01002804 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002805 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002806 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807#ifdef FEAT_PROFILE
2808 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002809 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002811 if (using_sandbox)
2812 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002814 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 {
2816 ++no_wait_return;
2817 verbose_enter_scroll();
2818
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002819 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002820 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821
2822 verbose_leave_scroll();
2823 --no_wait_return;
2824 }
2825
2826 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002827 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002828 for (i = 0; i < tv_to_free_len; ++i)
2829 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002830 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831}
2832
2833/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002834 * Check the argument count for user function "fp".
2835 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2836 */
2837 int
2838check_user_func_argcount(ufunc_T *fp, int argcount)
2839{
2840 int regular_args = fp->uf_args.ga_len;
2841
2842 if (argcount < regular_args - fp->uf_def_args.ga_len)
2843 return FCERR_TOOFEW;
2844 else if (!has_varargs(fp) && argcount > regular_args)
2845 return FCERR_TOOMANY;
2846 return FCERR_UNKNOWN;
2847}
2848
2849/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002850 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002851 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002852 int
2853call_user_func_check(
2854 ufunc_T *fp,
2855 int argcount,
2856 typval_T *argvars,
2857 typval_T *rettv,
2858 funcexe_T *funcexe,
2859 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002860{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002861 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002862
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002863 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2864 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002865 error = check_user_func_argcount(fp, argcount);
2866 if (error != FCERR_UNKNOWN)
2867 return error;
2868 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002869 error = FCERR_DICT;
2870 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002871 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002872 int did_save_redo = FALSE;
2873 save_redo_T save_redo;
2874
2875 /*
2876 * Call the user function.
2877 * Save and restore search patterns, script variables and
2878 * redo buffer.
2879 */
2880 save_search_patterns();
2881 if (!ins_compl_active())
2882 {
2883 saveRedobuff(&save_redo);
2884 did_save_redo = TRUE;
2885 }
2886 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002887 call_user_func(fp, argcount, argvars, rettv, funcexe,
2888 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002889 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2890 // Function was unreferenced while being used, free it now.
2891 func_clear_free(fp, FALSE);
2892 if (did_save_redo)
2893 restoreRedobuff(&save_redo);
2894 restore_search_patterns();
2895 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002896 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002897 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002898}
2899
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002900static funccal_entry_T *funccal_stack = NULL;
2901
2902/*
2903 * Save the current function call pointer, and set it to NULL.
2904 * Used when executing autocommands and for ":source".
2905 */
2906 void
2907save_funccal(funccal_entry_T *entry)
2908{
2909 entry->top_funccal = current_funccal;
2910 entry->next = funccal_stack;
2911 funccal_stack = entry;
2912 current_funccal = NULL;
2913}
2914
2915 void
2916restore_funccal(void)
2917{
2918 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002919 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002920 else
2921 {
2922 current_funccal = funccal_stack->top_funccal;
2923 funccal_stack = funccal_stack->next;
2924 }
2925}
2926
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002927 funccall_T *
2928get_current_funccal(void)
2929{
2930 return current_funccal;
2931}
2932
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002933/*
2934 * Mark all functions of script "sid" as deleted.
2935 */
2936 void
2937delete_script_functions(int sid)
2938{
2939 hashitem_T *hi;
2940 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002941 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002942 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002943 size_t len;
2944
2945 buf[0] = K_SPECIAL;
2946 buf[1] = KS_EXTRA;
2947 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002948 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002949 len = STRLEN(buf);
2950
Bram Moolenaarce658352020-07-31 23:47:12 +02002951 while (todo > 0)
2952 {
2953 todo = func_hashtab.ht_used;
2954 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2955 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002956 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002957 fp = HI2UF(hi);
2958 if (STRNCMP(fp->uf_name, buf, len) == 0)
2959 {
2960 int changed = func_hashtab.ht_changed;
2961
2962 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002963
2964 if (fp->uf_calls > 0)
2965 {
2966 // Function is executing, don't free it but do remove
2967 // it from the hashtable.
2968 if (func_remove(fp))
2969 fp->uf_refcount--;
2970 }
2971 else
2972 {
2973 func_clear(fp, TRUE);
2974 // When clearing a function another function can be
2975 // cleared as a side effect. When that happens start
2976 // over.
2977 if (changed != func_hashtab.ht_changed)
2978 break;
2979 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002980 }
2981 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002982 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002983 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002984}
2985
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002986#if defined(EXITFREE) || defined(PROTO)
2987 void
2988free_all_functions(void)
2989{
2990 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002991 ufunc_T *fp;
2992 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002993 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002994 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995
Bram Moolenaare38eab22019-12-05 21:50:01 +01002996 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002997 while (current_funccal != NULL)
2998 {
2999 clear_tv(current_funccal->rettv);
3000 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003001 if (current_funccal == NULL && funccal_stack != NULL)
3002 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003003 }
3004
Bram Moolenaare38eab22019-12-05 21:50:01 +01003005 // First clear what the functions contain. Since this may lower the
3006 // reference count of a function, it may also free a function and change
3007 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003008 while (todo > 0)
3009 {
3010 todo = func_hashtab.ht_used;
3011 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3012 if (!HASHITEM_EMPTY(hi))
3013 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003014 // clear the def function index now
3015 fp = HI2UF(hi);
3016 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003017 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003018
Bram Moolenaare38eab22019-12-05 21:50:01 +01003019 // Only free functions that are not refcounted, those are
3020 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003021 if (func_name_refcount(fp->uf_name))
3022 ++skipped;
3023 else
3024 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003025 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003026 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003027 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003028 {
3029 skipped = 0;
3030 break;
3031 }
3032 }
3033 --todo;
3034 }
3035 }
3036
Bram Moolenaare38eab22019-12-05 21:50:01 +01003037 // Now actually free the functions. Need to start all over every time,
3038 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003039 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003040 while (func_hashtab.ht_used > skipped)
3041 {
3042 todo = func_hashtab.ht_used;
3043 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044 if (!HASHITEM_EMPTY(hi))
3045 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003046 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003047 // Only free functions that are not refcounted, those are
3048 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003049 fp = HI2UF(hi);
3050 if (func_name_refcount(fp->uf_name))
3051 ++skipped;
3052 else
3053 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003054 if (func_free(fp, FALSE) == OK)
3055 {
3056 skipped = 0;
3057 break;
3058 }
3059 // did not actually free it
3060 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003061 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003063 }
3064 if (skipped == 0)
3065 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003066
3067 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068}
3069#endif
3070
3071/*
3072 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003073 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003074 * "len" is the length of "name", or -1 for NUL terminated.
3075 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003076 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077builtin_function(char_u *name, int len)
3078{
3079 char_u *p;
3080
Bram Moolenaara26b9702020-04-18 19:53:28 +02003081 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082 return FALSE;
3083 p = vim_strchr(name, AUTOLOAD_CHAR);
3084 return p == NULL || (len > 0 && p > name + len);
3085}
3086
3087 int
3088func_call(
3089 char_u *name,
3090 typval_T *args,
3091 partial_T *partial,
3092 dict_T *selfdict,
3093 typval_T *rettv)
3094{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003095 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096 listitem_T *item;
3097 typval_T argv[MAX_FUNC_ARGS + 1];
3098 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 int r = 0;
3100
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003101 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003102 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 {
3104 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3105 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003106 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003107 break;
3108 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003109 // Make a copy of each argument. This is needed to be able to set
3110 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111 copy_tv(&item->li_tv, &argv[argc++]);
3112 }
3113
3114 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003115 {
3116 funcexe_T funcexe;
3117
Bram Moolenaara80faa82020-04-12 19:37:17 +02003118 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003119 funcexe.fe_firstline = curwin->w_cursor.lnum;
3120 funcexe.fe_lastline = curwin->w_cursor.lnum;
3121 funcexe.fe_evaluate = TRUE;
3122 funcexe.fe_partial = partial;
3123 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003124 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3125 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126
Bram Moolenaare38eab22019-12-05 21:50:01 +01003127 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128 while (argc > 0)
3129 clear_tv(&argv[--argc]);
3130
3131 return r;
3132}
3133
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003134static int callback_depth = 0;
3135
3136 int
3137get_callback_depth(void)
3138{
3139 return callback_depth;
3140}
3141
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003143 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003144 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003145 */
3146 int
3147call_callback(
3148 callback_T *callback,
3149 int len, // length of "name" or -1 to use strlen()
3150 typval_T *rettv, // return value goes here
3151 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003152 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003153 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003154{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003155 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003156 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003157
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003158 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3159 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003160 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003161 funcexe.fe_evaluate = TRUE;
3162 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003163 ++callback_depth;
3164 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3165 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003166
3167 // When a :def function was called that uses :try an error would be turned
3168 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003169 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003170 {
3171 need_rethrow = FALSE;
3172 handle_did_throw();
3173 }
3174
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003175 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003176}
3177
3178/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003179 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003180 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003181 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3182 */
3183 varnumber_T
3184call_callback_retnr(
3185 callback_T *callback,
3186 int argcount, // number of "argvars"
3187 typval_T *argvars) // vars for arguments, must have "argcount"
3188 // PLUS ONE elements!
3189{
3190 typval_T rettv;
3191 varnumber_T retval;
3192
3193 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003194 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003195
3196 retval = tv_get_number_chk(&rettv, NULL);
3197 clear_tv(&rettv);
3198 return retval;
3199}
3200
3201/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 * Give an error message for the result of a function.
3203 * Nothing if "error" is FCERR_NONE.
3204 */
3205 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003206user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003207{
3208 switch (error)
3209 {
3210 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003211 if (funcexe->fe_found_var)
3212 semsg(_(e_not_callable_type_str), name);
3213 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003214 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003215 break;
3216 case FCERR_NOTMETHOD:
3217 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003218 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003219 break;
3220 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003221 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003222 break;
3223 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003224 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003225 break;
3226 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003227 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003228 break;
3229 case FCERR_SCRIPT:
3230 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003231 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003232 break;
3233 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003234 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3235 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003236 break;
3237 }
3238}
3239
3240/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003242 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243 * Return FAIL when the function can't be called, OK otherwise.
3244 * Also returns OK when an error was encountered while executing the function.
3245 */
3246 int
3247call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003248 char_u *funcname, // name of the function
3249 int len, // length of "name" or -1 to use strlen()
3250 typval_T *rettv, // return value goes here
3251 int argcount_in, // number of "argvars"
3252 typval_T *argvars_in, // vars for arguments, must have "argcount"
3253 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003254 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003255{
3256 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003257 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003258 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003259 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003260 char_u fname_buf[FLEN_FIXED + 1];
3261 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003262 char_u *fname = NULL;
3263 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264 int argcount = argcount_in;
3265 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003266 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003267 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003268 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003270 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003271 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003272 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003273 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003275 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3276 // even when call_func() returns FAIL.
3277 rettv->v_type = VAR_UNKNOWN;
3278
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003279 if (partial != NULL)
3280 fp = partial->pt_func;
3281 if (fp == NULL)
3282 {
3283 // Make a copy of the name, if it comes from a funcref variable it
3284 // could be changed or deleted in the called function.
3285 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3286 if (name == NULL)
3287 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003288
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003289 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3290 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003291
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003292 if (funcexe->fe_doesrange != NULL)
3293 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294
3295 if (partial != NULL)
3296 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003297 // When the function has a partial with a dict and there is a dict
3298 // argument, use the dict argument. That is backwards compatible.
3299 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003300 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003301 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003302 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 {
3304 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003305 {
3306 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3307 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003308 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003309 goto theend;
3310 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003312 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 for (i = 0; i < argcount_in; ++i)
3314 argv[i + argv_clear] = argvars_in[i];
3315 argvars = argv;
3316 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003317
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003318 if (funcexe->fe_check_type != NULL
3319 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003320 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003321 // Now funcexe->fe_check_type is missing the added arguments,
3322 // make a copy of the type with the correction.
3323 check_type = *funcexe->fe_check_type;
3324 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003325 check_type.tt_args = check_type_args;
3326 CLEAR_FIELD(check_type_args);
3327 for (i = 0; i < check_type.tt_argcount; ++i)
3328 check_type_args[i + partial->pt_argc] =
3329 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003330 check_type.tt_argcount += partial->pt_argc;
3331 check_type.tt_min_argcount += partial->pt_argc;
3332 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003333 }
3334 }
3335
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003336 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3337 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003338 {
3339 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003340 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003341 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003342 error = FCERR_OTHER;
3343 }
3344
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003345 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 {
3347 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003348 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349
Bram Moolenaar333894b2020-08-01 18:53:07 +02003350 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003351 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003352 {
3353 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003355 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003356
Bram Moolenaare38eab22019-12-05 21:50:01 +01003357 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003359 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003361 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 {
3363 /*
3364 * User defined function.
3365 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003366 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003367 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368
Bram Moolenaare38eab22019-12-05 21:50:01 +01003369 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 if (fp == NULL
3371 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003372 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 && !aborting())
3374 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003375 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003376 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003377 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003378 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003379 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3380 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003381 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003382 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003383 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003384 if (fp == NULL)
3385 {
3386 char_u *p = untrans_function_name(rfname);
3387
3388 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003389 // Don't do this if the name starts with "s:".
3390 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003391 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003392 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003394 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003395 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003396#ifdef FEAT_LUA
3397 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3398 {
3399 cfunc_T cb = fp->uf_cb;
3400
3401 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3402 }
3403#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003404 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003406 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003407 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003408 argcount = funcexe->fe_argv_func(argcount, argvars,
3409 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003410
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003411 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003412 {
3413 // Method call: base->Method()
3414 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003415 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003416 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003417 argvars = argv;
3418 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003419 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003420
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003421 error = call_user_func_check(fp, argcount, argvars, rettv,
3422 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423 }
3424 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003425 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003426 {
3427 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003428 * expr->method(): Find the method name in the table, call its
3429 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003430 */
3431 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003432 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 else
3435 {
3436 /*
3437 * Find the function name in the table, call its implementation.
3438 */
3439 error = call_internal_func(fname, argcount, argvars, rettv);
3440 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003441
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 /*
3443 * The function call (or "FuncUndefined" autocommand sequence) might
3444 * have been aborted by an error, an interrupt, or an explicitly thrown
3445 * exception that has not been caught so far. This situation can be
3446 * tested for by calling aborting(). For an error in an internal
3447 * function or for the "E132" error in call_user_func(), however, the
3448 * throw point at which the "force_abort" flag (temporarily reset by
3449 * emsg()) is normally updated has not been reached yet. We need to
3450 * update that flag first to make aborting() reliable.
3451 */
3452 update_force_abort();
3453 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003454 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 ret = OK;
3456
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003457theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 /*
3459 * Report an error unless the argument evaluation or function call has been
3460 * cancelled due to an aborting error, an interrupt, or an exception.
3461 */
3462 if (!aborting())
3463 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003464 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003465 }
3466
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003467 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003468 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003469 clear_tv(&argv[--argv_clear + argv_base]);
3470
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 vim_free(tofree);
3472 vim_free(name);
3473
3474 return ret;
3475}
3476
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003477 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003478printable_func_name(ufunc_T *fp)
3479{
3480 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3481}
3482
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003483/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003484 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 */
3486 static void
3487list_func_head(ufunc_T *fp, int indent)
3488{
3489 int j;
3490
3491 msg_start();
3492 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003493 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003494 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003495 msg_puts("def ");
3496 else
3497 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003498 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 msg_putchar('(');
3500 for (j = 0; j < fp->uf_args.ga_len; ++j)
3501 {
3502 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003503 msg_puts(", ");
3504 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003505 if (fp->uf_arg_types != NULL)
3506 {
3507 char *tofree;
3508
3509 msg_puts(": ");
3510 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3511 vim_free(tofree);
3512 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003513 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3514 {
3515 msg_puts(" = ");
3516 msg_puts(((char **)(fp->uf_def_args.ga_data))
3517 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003519 }
3520 if (fp->uf_varargs)
3521 {
3522 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003523 msg_puts(", ");
3524 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003525 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003526 if (fp->uf_va_name != NULL)
3527 {
3528 if (j)
3529 msg_puts(", ");
3530 msg_puts("...");
3531 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003532 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003533 {
3534 char *tofree;
3535
3536 msg_puts(": ");
3537 msg_puts(type_name(fp->uf_va_type, &tofree));
3538 vim_free(tofree);
3539 }
3540 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003542
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003543 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003544 {
3545 if (fp->uf_ret_type != &t_void)
3546 {
3547 char *tofree;
3548
3549 msg_puts(": ");
3550 msg_puts(type_name(fp->uf_ret_type, &tofree));
3551 vim_free(tofree);
3552 }
3553 }
3554 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003555 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003557 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003559 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003560 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003561 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003562 msg_clr_eos();
3563 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003564 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003565}
3566
3567/*
3568 * Get a function name, translating "<SID>" and "<SNR>".
3569 * Also handles a Funcref in a List or Dictionary.
3570 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003571 * Set "*is_global" to TRUE when the function must be global, unless
3572 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 * flags:
3574 * TFN_INT: internal function name OK
3575 * TFN_QUIET: be quiet
3576 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003577 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 * Advances "pp" to just after the function name (if no error).
3579 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003580 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581trans_function_name(
3582 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003583 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003584 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003586 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003587 partial_T **partial, // return: partial of a FuncRef
3588 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589{
3590 char_u *name = NULL;
3591 char_u *start;
3592 char_u *end;
3593 int lead;
3594 char_u sid_buf[20];
3595 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003596 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003598 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599
3600 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003601 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 start = *pp;
3603
Bram Moolenaare38eab22019-12-05 21:50:01 +01003604 // Check for hard coded <SNR>: already translated function ID (from a user
3605 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003606 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3607 && (*pp)[2] == (int)KE_SNR)
3608 {
3609 *pp += 3;
3610 len = get_id_len(pp) + 3;
3611 return vim_strnsave(start, len);
3612 }
3613
Bram Moolenaare38eab22019-12-05 21:50:01 +01003614 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3615 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 lead = eval_fname_script(start);
3617 if (lead > 2)
3618 start += lead;
3619
Bram Moolenaare38eab22019-12-05 21:50:01 +01003620 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003621 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 lead > 2 ? 0 : FNE_CHECK_START);
3623 if (end == start)
3624 {
3625 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003626 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 goto theend;
3628 }
3629 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3630 {
3631 /*
3632 * Report an invalid expression in braces, unless the expression
3633 * evaluation has been cancelled due to an aborting error, an
3634 * interrupt, or an exception.
3635 */
3636 if (!aborting())
3637 {
3638 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003639 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640 }
3641 else
3642 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3643 goto theend;
3644 }
3645
3646 if (lv.ll_tv != NULL)
3647 {
3648 if (fdp != NULL)
3649 {
3650 fdp->fd_dict = lv.ll_dict;
3651 fdp->fd_newkey = lv.ll_newkey;
3652 lv.ll_newkey = NULL;
3653 fdp->fd_di = lv.ll_di;
3654 }
3655 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3656 {
3657 name = vim_strsave(lv.ll_tv->vval.v_string);
3658 *pp = end;
3659 }
3660 else if (lv.ll_tv->v_type == VAR_PARTIAL
3661 && lv.ll_tv->vval.v_partial != NULL)
3662 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003663 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 *pp = end;
3665 if (partial != NULL)
3666 *partial = lv.ll_tv->vval.v_partial;
3667 }
3668 else
3669 {
3670 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3671 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003672 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 else
3674 *pp = end;
3675 name = NULL;
3676 }
3677 goto theend;
3678 }
3679
3680 if (lv.ll_name == NULL)
3681 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003682 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 *pp = end;
3684 goto theend;
3685 }
3686
Bram Moolenaare38eab22019-12-05 21:50:01 +01003687 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 if (lv.ll_exp_name != NULL)
3689 {
3690 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003691 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003692 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 if (name == lv.ll_exp_name)
3694 name = NULL;
3695 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003696 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 {
3698 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003699 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003700 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 if (name == *pp)
3702 name = NULL;
3703 }
3704 if (name != NULL)
3705 {
3706 name = vim_strsave(name);
3707 *pp = end;
3708 if (STRNCMP(name, "<SNR>", 5) == 0)
3709 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003710 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711 name[0] = K_SPECIAL;
3712 name[1] = KS_EXTRA;
3713 name[2] = (int)KE_SNR;
3714 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3715 }
3716 goto theend;
3717 }
3718
3719 if (lv.ll_exp_name != NULL)
3720 {
3721 len = (int)STRLEN(lv.ll_exp_name);
3722 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3723 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3724 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003725 // When there was "s:" already or the name expanded to get a
3726 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 lv.ll_name += 2;
3728 len -= 2;
3729 lead = 2;
3730 }
3731 }
3732 else
3733 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003734 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003736 {
3737 if (is_global != NULL && lv.ll_name[0] == 'g')
3738 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003740 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 len = (int)(end - lv.ll_name);
3742 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003743 if (len <= 0)
3744 {
3745 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003746 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003747 goto theend;
3748 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003750 // In Vim9 script a user function is script-local by default, unless it
3751 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003752 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003753 if (vim9script)
3754 {
3755 char_u *p;
3756
3757 // SomeScript#func() is a global function.
3758 for (p = start; *p != NUL && *p != '('; ++p)
3759 if (*p == AUTOLOAD_CHAR)
3760 vim9script = FALSE;
3761 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003762
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003763 /*
3764 * Copy the function name to allocated memory.
3765 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3766 * Accept <SNR>123_name() outside a script.
3767 */
3768 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003769 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003770 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003772 if (!vim9script)
3773 lead = 3;
3774 if (vim9script || (lv.ll_exp_name != NULL
3775 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 || eval_fname_sid(*pp))
3777 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003779 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003781 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782 goto theend;
3783 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003784 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003785 if (vim9script)
3786 extra = 3 + (int)STRLEN(sid_buf);
3787 else
3788 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003789 }
3790 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003791 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3792 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003794 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 goto theend;
3796 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003797 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 {
3799 char_u *cp = vim_strchr(lv.ll_name, ':');
3800
3801 if (cp != NULL && cp < end)
3802 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003803 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 goto theend;
3805 }
3806 }
3807
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003808 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 if (name != NULL)
3810 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003811 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 {
3813 name[0] = K_SPECIAL;
3814 name[1] = KS_EXTRA;
3815 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003816 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 STRCPY(name + 3, sid_buf);
3818 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003819 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3820 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 }
3822 *pp = end;
3823
3824theend:
3825 clear_lval(&lv);
3826 return name;
3827}
3828
3829/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003830 * Assuming "name" is the result of trans_function_name() and it was prefixed
3831 * to use the script-local name, return the unmodified name (points into
3832 * "name"). Otherwise return NULL.
3833 * This can be used to first search for a script-local function and fall back
3834 * to the global function if not found.
3835 */
3836 char_u *
3837untrans_function_name(char_u *name)
3838{
3839 char_u *p;
3840
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003841 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003842 {
3843 p = vim_strchr(name, '_');
3844 if (p != NULL)
3845 return p + 1;
3846 }
3847 return NULL;
3848}
3849
3850/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003851 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3852 * current script ID and returns the expanded function name. The caller should
3853 * free the returned name. If not called from a script context or the function
3854 * name doesn't start with these prefixes, then returns NULL.
3855 * This doesn't check whether the script-local function exists or not.
3856 */
3857 char_u *
3858get_scriptlocal_funcname(char_u *funcname)
3859{
3860 char sid_buf[25];
3861 int off;
3862 char_u *newname;
3863
3864 if (funcname == NULL)
3865 return NULL;
3866
3867 if (STRNCMP(funcname, "s:", 2) != 0
3868 && STRNCMP(funcname, "<SID>", 5) != 0)
3869 // The function name is not a script-local function name
3870 return NULL;
3871
3872 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3873 {
3874 emsg(_(e_using_sid_not_in_script_context));
3875 return NULL;
3876 }
3877 // Expand s: prefix into <SNR>nr_<name>
3878 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3879 (long)current_sctx.sc_sid);
3880 off = *funcname == 's' ? 2 : 5;
3881 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3882 if (newname == NULL)
3883 return NULL;
3884 STRCPY(newname, sid_buf);
3885 STRCAT(newname, funcname + off);
3886
3887 return newname;
3888}
3889
3890/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003891 * Call trans_function_name(), except that a lambda is returned as-is.
3892 * Returns the name in allocated memory.
3893 */
3894 char_u *
3895save_function_name(
3896 char_u **name,
3897 int *is_global,
3898 int skip,
3899 int flags,
3900 funcdict_T *fudi)
3901{
3902 char_u *p = *name;
3903 char_u *saved;
3904
3905 if (STRNCMP(p, "<lambda>", 8) == 0)
3906 {
3907 p += 8;
3908 (void)getdigits(&p);
3909 saved = vim_strnsave(*name, p - *name);
3910 if (fudi != NULL)
3911 CLEAR_POINTER(fudi);
3912 }
3913 else
3914 saved = trans_function_name(&p, is_global, skip,
3915 flags, fudi, NULL, NULL);
3916 *name = p;
3917 return saved;
3918}
3919
3920/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003921 * List functions. When "regmatch" is NULL all of then.
3922 * Otherwise functions matching "regmatch".
3923 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003924 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003925list_functions(regmatch_T *regmatch)
3926{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003927 int changed = func_hashtab.ht_changed;
3928 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003929 hashitem_T *hi;
3930
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003931 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003932 {
3933 if (!HASHITEM_EMPTY(hi))
3934 {
3935 ufunc_T *fp = HI2UF(hi);
3936
3937 --todo;
3938 if ((fp->uf_flags & FC_DEAD) == 0
3939 && (regmatch == NULL
3940 ? !message_filtered(fp->uf_name)
3941 && !func_name_refcount(fp->uf_name)
3942 : !isdigit(*fp->uf_name)
3943 && vim_regexec(regmatch, fp->uf_name, 0)))
3944 {
3945 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003946 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003947 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00003948 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003949 return;
3950 }
3951 }
3952 }
3953 }
3954}
3955
3956/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003957 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003958 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3959 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003960 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003961 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003962 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003963 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003964define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 int j;
3967 int c;
3968 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003969 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003970 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 char_u *p;
3972 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003973 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003974 char_u *line_arg = NULL;
3975 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003976 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003977 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 garray_T newlines;
3979 int varargs = FALSE;
3980 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003981 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003982 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00003983 int fp_allocated = FALSE;
3984 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003985 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 dictitem_T *v;
3987 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003988 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003991 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003992 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003993 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994
3995 /*
3996 * ":function" without argument: list functions.
3997 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003998 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 {
4000 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004001 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004002 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004003 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 }
4005
4006 /*
4007 * ":function /pat": list functions matching pattern.
4008 */
4009 if (*eap->arg == '/')
4010 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004011 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 if (!eap->skip)
4013 {
4014 regmatch_T regmatch;
4015
4016 c = *p;
4017 *p = NUL;
4018 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4019 *p = c;
4020 if (regmatch.regprog != NULL)
4021 {
4022 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004023 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024 vim_regfree(regmatch.regprog);
4025 }
4026 }
4027 if (*p == '/')
4028 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004029 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004030 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031 }
4032
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004033 ga_init(&newargs);
4034 ga_init(&argtypes);
4035 ga_init(&default_args);
4036
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 /*
4038 * Get the function name. There are these situations:
4039 * func normal function name
4040 * "name" == func, "fudi.fd_dict" == NULL
4041 * dict.func new dictionary entry
4042 * "name" == NULL, "fudi.fd_dict" set,
4043 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4044 * dict.func existing dict entry with a Funcref
4045 * "name" == func, "fudi.fd_dict" set,
4046 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4047 * dict.func existing dict entry that's not a Funcref
4048 * "name" == NULL, "fudi.fd_dict" set,
4049 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4050 * s:func script-local function name
4051 * g:func global function name, same as "func"
4052 */
4053 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004054 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004056 // nested function, argument is (args).
4057 paren = TRUE;
4058 CLEAR_FIELD(fudi);
4059 }
4060 else
4061 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004062 name = save_function_name(&p, &is_global, eap->skip,
4063 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004064 paren = (vim_strchr(p, '(') != NULL);
4065 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004067 /*
4068 * Return on an invalid expression in braces, unless the expression
4069 * evaluation has been cancelled due to an aborting error, an
4070 * interrupt, or an exception.
4071 */
4072 if (!aborting())
4073 {
4074 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004075 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004076 vim_free(fudi.fd_newkey);
4077 return NULL;
4078 }
4079 else
4080 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082 }
4083
Bram Moolenaare38eab22019-12-05 21:50:01 +01004084 // An error in a function call during evaluation of an expression in magic
4085 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 saved_did_emsg = did_emsg;
4087 did_emsg = FALSE;
4088
4089 /*
4090 * ":function func" with only function name: list function.
4091 */
4092 if (!paren)
4093 {
4094 if (!ends_excmd(*skipwhite(p)))
4095 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004096 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 goto ret_free;
4098 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004099 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004100 if (eap->nextcmd != NULL)
4101 *p = NUL;
4102 if (!eap->skip && !got_int)
4103 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004104 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004105 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4106 {
4107 char_u *up = untrans_function_name(name);
4108
4109 // With Vim9 script the name was made script-local, if not
4110 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004111 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004112 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004113 }
4114
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115 if (fp != NULL)
4116 {
4117 list_func_head(fp, TRUE);
4118 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4119 {
4120 if (FUNCLINE(fp, j) == NULL)
4121 continue;
4122 msg_putchar('\n');
4123 msg_outnum((long)(j + 1));
4124 if (j < 9)
4125 msg_putchar(' ');
4126 if (j < 99)
4127 msg_putchar(' ');
4128 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004129 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130 ui_breakcheck();
4131 }
4132 if (!got_int)
4133 {
4134 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004135 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004136 msg_puts(" enddef");
4137 else
4138 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 }
4140 }
4141 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004142 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004143 }
4144 goto ret_free;
4145 }
4146
4147 /*
4148 * ":function name(arg1, arg2)" Define function.
4149 */
4150 p = skipwhite(p);
4151 if (*p != '(')
4152 {
4153 if (!eap->skip)
4154 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004155 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 goto ret_free;
4157 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004158 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 if (vim_strchr(p, '(') != NULL)
4160 p = vim_strchr(p, '(');
4161 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004163 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4164 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004165 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004166 goto ret_free;
4167 }
4168
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004169 // In Vim9 script only global functions can be redefined.
4170 if (vim9script && eap->forceit && !is_global)
4171 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004172 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004173 goto ret_free;
4174 }
4175
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004176 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177
Bram Moolenaar04b12692020-05-04 23:24:44 +02004178 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004180 // Check the name of the function. Unless it's a dictionary function
4181 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 if (name != NULL)
4183 arg = name;
4184 else
4185 arg = fudi.fd_newkey;
4186 if (arg != NULL && (fudi.fd_di == NULL
4187 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4188 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4189 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004190 char_u *name_base = arg;
4191 int i;
4192
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004194 {
4195 name_base = vim_strchr(arg, '_');
4196 if (name_base == NULL)
4197 name_base = arg + 3;
4198 else
4199 ++name_base;
4200 }
4201 for (i = 0; name_base[i] != NUL && (i == 0
4202 ? eval_isnamec1(name_base[i])
4203 : eval_isnamec(name_base[i])); ++i)
4204 ;
4205 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004206 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004207
4208 // In Vim9 script a function cannot have the same name as a
4209 // variable.
4210 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004211 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4212 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004213 + EVAL_VAR_NO_FUNC) == OK)
4214 {
4215 semsg(_(e_redefining_script_item_str), name_base);
4216 goto ret_free;
4217 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004219 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004221 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004222 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004223 goto ret_free;
4224 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004225 }
4226
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004227 // This may get more lines and make the pointers into the first line
4228 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004229 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004230 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004231 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004232 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004233 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004235 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004236
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004237 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004239 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004240 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004242 if (*p != ':')
4243 {
4244 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4245 p = skipwhite(p);
4246 }
4247 else if (!IS_WHITE_OR_NUL(p[1]))
4248 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004249 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004250 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004251 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004252 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004253 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004254 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004255 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004256 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004257 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004258 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004259 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004260 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004261 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004262 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004263 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004265 else
4266 // find extra arguments "range", "dict", "abort" and "closure"
4267 for (;;)
4268 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004269 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004270 p = skipwhite(p);
4271 if (STRNCMP(p, "range", 5) == 0)
4272 {
4273 flags |= FC_RANGE;
4274 p += 5;
4275 }
4276 else if (STRNCMP(p, "dict", 4) == 0)
4277 {
4278 flags |= FC_DICT;
4279 p += 4;
4280 }
4281 else if (STRNCMP(p, "abort", 5) == 0)
4282 {
4283 flags |= FC_ABORT;
4284 p += 5;
4285 }
4286 else if (STRNCMP(p, "closure", 7) == 0)
4287 {
4288 flags |= FC_CLOSURE;
4289 p += 7;
4290 if (current_funccal == NULL)
4291 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004292 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004293 name == NULL ? (char_u *)"" : name);
4294 goto erret;
4295 }
4296 }
4297 else
4298 break;
4299 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300
Bram Moolenaare38eab22019-12-05 21:50:01 +01004301 // When there is a line break use what follows for the function body.
4302 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 if (*p == '\n')
4304 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004305 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004306 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4307 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004308 && !(VIM_ISWHITE(*whitep) && *p == '#'
4309 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004310 && !eap->skip
4311 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004312 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313
4314 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004315 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4316 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 */
4318 if (KeyTyped)
4319 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004320 // Check if the function already exists, don't let the user type the
4321 // whole function before telling him it doesn't work! For a script we
4322 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 if (!eap->skip && !eap->forceit)
4324 {
4325 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004326 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004327 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004328 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 }
4330
4331 if (!eap->skip && did_emsg)
4332 goto erret;
4333
Bram Moolenaare38eab22019-12-05 21:50:01 +01004334 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 cmdline_row = msg_row;
4336 }
4337
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004338 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004339 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004340
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004341 // Do not define the function when getting the body fails and when
4342 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004343 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004344 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 goto erret;
4346
4347 /*
4348 * If there are no errors, add the function
4349 */
4350 if (fudi.fd_dict == NULL)
4351 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004352 hashtab_T *ht;
4353
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004354 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4356 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004357 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 goto erret;
4359 }
4360
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004361 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004362 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004364 char_u *uname = untrans_function_name(name);
4365
4366 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4367 }
4368
4369 if (fp != NULL || import != NULL)
4370 {
4371 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004372
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004373 // Function can be replaced with "function!" and when sourcing the
4374 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004375 // A name that is used by an import can not be overruled.
4376 if (import != NULL
4377 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004378 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004379 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004380 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004381 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004382 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004383 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004384 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004385 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 goto erret;
4387 }
4388 if (fp->uf_calls > 0)
4389 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004390 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004391 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392 goto erret;
4393 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004394 if (fp->uf_refcount > 1)
4395 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004396 // This function is referenced somewhere, don't redefine it but
4397 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004398 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004399 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004400 fp = NULL;
4401 overwrite = TRUE;
4402 }
4403 else
4404 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004405 char_u *exp_name = fp->uf_name_exp;
4406
4407 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004408 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004409 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004410 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004411 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004412 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004413#ifdef FEAT_PROFILE
4414 fp->uf_profiling = FALSE;
4415 fp->uf_prof_initialized = FALSE;
4416#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004417 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004418 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 }
4420 }
4421 else
4422 {
4423 char numbuf[20];
4424
4425 fp = NULL;
4426 if (fudi.fd_newkey == NULL && !eap->forceit)
4427 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004428 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 goto erret;
4430 }
4431 if (fudi.fd_di == NULL)
4432 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004433 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004434 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004435 goto erret;
4436 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004437 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004438 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 goto erret;
4440
Bram Moolenaare38eab22019-12-05 21:50:01 +01004441 // Give the function a sequential number. Can only be used with a
4442 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443 vim_free(name);
4444 sprintf(numbuf, "%d", ++func_nr);
4445 name = vim_strsave((char_u *)numbuf);
4446 if (name == NULL)
4447 goto erret;
4448 }
4449
4450 if (fp == NULL)
4451 {
4452 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4453 {
4454 int slen, plen;
4455 char_u *scriptname;
4456
Bram Moolenaare38eab22019-12-05 21:50:01 +01004457 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004459 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004460 {
4461 scriptname = autoload_name(name);
4462 if (scriptname != NULL)
4463 {
4464 p = vim_strchr(scriptname, '/');
4465 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004466 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004468 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 j = OK;
4470 vim_free(scriptname);
4471 }
4472 }
4473 if (j == FAIL)
4474 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004475 linenr_T save_lnum = SOURCING_LNUM;
4476
4477 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004478 semsg(_(e_function_name_does_not_match_script_file_name_str),
4479 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004480 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 goto erret;
4482 }
4483 }
4484
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004485 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 if (fp == NULL)
4487 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004488 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489
4490 if (fudi.fd_dict != NULL)
4491 {
4492 if (fudi.fd_di == NULL)
4493 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004494 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4496 if (fudi.fd_di == NULL)
4497 {
4498 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004499 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500 goto erret;
4501 }
4502 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4503 {
4504 vim_free(fudi.fd_di);
4505 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004506 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004507 goto erret;
4508 }
4509 }
4510 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004511 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004512 clear_tv(&fudi.fd_di->di_tv);
4513 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515
Bram Moolenaare38eab22019-12-05 21:50:01 +01004516 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517 flags |= FC_DICT;
4518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 }
4520 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004521 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004522 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004523 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004524
4525 if (eap->cmdidx == CMD_def)
4526 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004527 int lnum_save = SOURCING_LNUM;
4528 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004529
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004530 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004531
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004532 // error messages are for the first function line
4533 SOURCING_LNUM = sourcing_lnum_top;
4534
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004535 // The function may use script variables from the context.
4536 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004537
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004538 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004539 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004540 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004541 free_fp = fp_allocated;
4542 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004543 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004544 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004545
4546 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004547 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004548 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004549 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004550 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004551 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004552 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004553 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004554 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004555 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004556 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004557
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004558 if (fp_allocated)
4559 {
4560 // insert the new function in the function list
4561 set_ufunc_name(fp, name);
4562 if (overwrite)
4563 {
4564 hi = hash_find(&func_hashtab, name);
4565 hi->hi_key = UF2HIKEY(fp);
4566 }
4567 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4568 {
4569 free_fp = TRUE;
4570 goto erret;
4571 }
4572 fp->uf_refcount = 1;
4573 }
4574
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004576 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004577 if ((flags & FC_CLOSURE) != 0)
4578 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004579 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004580 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004581 }
4582 else
4583 fp->uf_scoped = NULL;
4584
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004586 if (prof_def_func())
4587 func_do_profile(fp);
4588#endif
4589 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004590 if (sandbox)
4591 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004592 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004593 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594 fp->uf_flags = flags;
4595 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004596 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004597 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004598 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004599 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004600 if (is_export)
4601 {
4602 fp->uf_flags |= FC_EXPORT;
4603 // let ex_export() know the export worked.
4604 is_export = FALSE;
4605 }
4606
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004607 if (eap->cmdidx == CMD_def)
4608 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004609 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4610 // :func does not use Vim9 script syntax, even in a Vim9 script file
4611 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004612
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004613 goto ret_free;
4614
4615erret:
4616 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004617 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004618 if (fp != NULL)
4619 {
4620 ga_init(&fp->uf_args);
4621 ga_init(&fp->uf_def_args);
4622 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004623errret_2:
4624 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004625 if (fp != NULL)
4626 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004627 if (free_fp)
4628 {
4629 vim_free(fp);
4630 fp = NULL;
4631 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004633 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004635 if (name != name_arg)
4636 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004637 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004638 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004639
4640 return fp;
4641}
4642
4643/*
4644 * ":function"
4645 */
4646 void
4647ex_function(exarg_T *eap)
4648{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004649 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004650
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004651 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4652 (void)define_function(eap, NULL, &lines_to_free);
4653 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004654}
4655
4656/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004657 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004658 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004659 */
4660 void
4661ex_defcompile(exarg_T *eap UNUSED)
4662{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004663 long todo = (long)func_hashtab.ht_used;
4664 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004665 hashitem_T *hi;
4666 ufunc_T *ufunc;
4667
4668 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4669 {
4670 if (!HASHITEM_EMPTY(hi))
4671 {
4672 --todo;
4673 ufunc = HI2UF(hi);
4674 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004675 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4676 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004677 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004678 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004679
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004680 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004681 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004682 // a function has been added or removed, need to start over
4683 todo = (long)func_hashtab.ht_used;
4684 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004685 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004686 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004687 }
4688 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004689 }
4690 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691}
4692
4693/*
4694 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4695 * Return 2 if "p" starts with "s:".
4696 * Return 0 otherwise.
4697 */
4698 int
4699eval_fname_script(char_u *p)
4700{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004701 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4702 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004703 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4704 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4705 return 5;
4706 if (p[0] == 's' && p[1] == ':')
4707 return 2;
4708 return 0;
4709}
4710
4711 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004712translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713{
4714 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004715 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004716 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004717}
4718
4719/*
4720 * Return TRUE when "ufunc" has old-style "..." varargs
4721 * or named varargs "...name: type".
4722 */
4723 int
4724has_varargs(ufunc_T *ufunc)
4725{
4726 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727}
4728
4729/*
4730 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004731 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004732 */
4733 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004734function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735{
4736 char_u *nm = name;
4737 char_u *p;
4738 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004739 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004740 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004741
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004742 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4743 if (no_deref)
4744 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004745 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 nm = skipwhite(nm);
4747
Bram Moolenaare38eab22019-12-05 21:50:01 +01004748 // Only accept "funcname", "funcname ", "funcname (..." and
4749 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004751 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752 vim_free(p);
4753 return n;
4754}
4755
Bram Moolenaar113e1072019-01-20 15:30:40 +01004756#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 char_u *
4758get_expanded_name(char_u *name, int check)
4759{
4760 char_u *nm = name;
4761 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004762 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004763
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004764 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004765 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004766
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004767 if (p != NULL && *nm == NUL
4768 && (!check || translated_function_exists(p, is_global)))
4769 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770
4771 vim_free(p);
4772 return NULL;
4773}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004774#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004775
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004776/*
4777 * Function given to ExpandGeneric() to obtain the list of user defined
4778 * function names.
4779 */
4780 char_u *
4781get_user_func_name(expand_T *xp, int idx)
4782{
4783 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004784 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785 static hashitem_T *hi;
4786 ufunc_T *fp;
4787
4788 if (idx == 0)
4789 {
4790 done = 0;
4791 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004792 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004794 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 {
4796 if (done++ > 0)
4797 ++hi;
4798 while (HASHITEM_EMPTY(hi))
4799 ++hi;
4800 fp = HI2UF(hi);
4801
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004802 // don't show dead, dict and lambda functions
4803 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004804 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004805 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806
4807 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004808 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809
4810 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004811 if (xp->xp_context != EXPAND_USER_FUNC
4812 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 {
4814 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004815 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004816 STRCAT(IObuff, ")");
4817 }
4818 return IObuff;
4819 }
4820 return NULL;
4821}
4822
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823/*
4824 * ":delfunction {name}"
4825 */
4826 void
4827ex_delfunction(exarg_T *eap)
4828{
4829 ufunc_T *fp = NULL;
4830 char_u *p;
4831 char_u *name;
4832 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004833 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004834
4835 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004836 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4837 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 vim_free(fudi.fd_newkey);
4839 if (name == NULL)
4840 {
4841 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004842 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004843 return;
4844 }
4845 if (!ends_excmd(*skipwhite(p)))
4846 {
4847 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00004848 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 return;
4850 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004851 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004852 if (eap->nextcmd != NULL)
4853 *p = NUL;
4854
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004855 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004856 {
4857 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004858 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004859 vim_free(name);
4860 return;
4861 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004862 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004863 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004864 vim_free(name);
4865
4866 if (!eap->skip)
4867 {
4868 if (fp == NULL)
4869 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004870 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004871 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004872 return;
4873 }
4874 if (fp->uf_calls > 0)
4875 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004876 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004877 return;
4878 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004879 if (fp->uf_flags & FC_VIM9)
4880 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004881 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004882 return;
4883 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004884
4885 if (fudi.fd_dict != NULL)
4886 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004887 // Delete the dict item that refers to the function, it will
4888 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004889 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4890 }
4891 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004892 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004893 // A normal function (not a numbered function or lambda) has a
4894 // refcount of 1 for the entry in the hashtable. When deleting
4895 // it and the refcount is more than one, it should be kept.
4896 // A numbered function and lambda should be kept if the refcount is
4897 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004898 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004899 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004900 // Function is still referenced somewhere. Don't free it but
4901 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004902 if (func_remove(fp))
4903 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004904 }
4905 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004906 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004907 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908 }
4909}
4910
4911/*
4912 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004913 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914 */
4915 void
4916func_unref(char_u *name)
4917{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004918 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004920 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004921 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004922 fp = find_func(name, FALSE, NULL);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004923 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004924 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004925#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004926 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004928 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004929 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004930 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004931}
4932
4933/*
4934 * Unreference a Function: decrement the reference count and free it when it
4935 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004936 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004937 */
4938 void
4939func_ptr_unref(ufunc_T *fp)
4940{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004941 if (fp != NULL && (--fp->uf_refcount <= 0
4942 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4943 && fp->uf_partial->pt_refcount <= 1
4944 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004945 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004946 // Only delete it when it's not being used. Otherwise it's done
4947 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004948 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004949 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950 }
4951}
4952
4953/*
4954 * Count a reference to a Function.
4955 */
4956 void
4957func_ref(char_u *name)
4958{
4959 ufunc_T *fp;
4960
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004961 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004963 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004964 if (fp != NULL)
4965 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004966 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004967 // Only give an error for a numbered function.
4968 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004969 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004970}
4971
4972/*
4973 * Count a reference to a Function.
4974 */
4975 void
4976func_ptr_ref(ufunc_T *fp)
4977{
4978 if (fp != NULL)
4979 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980}
4981
4982/*
4983 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4984 * referenced from anywhere that is in use.
4985 */
4986 static int
4987can_free_funccal(funccall_T *fc, int copyID)
4988{
4989 return (fc->l_varlist.lv_copyID != copyID
4990 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004991 && fc->l_avars.dv_copyID != copyID
4992 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993}
4994
4995/*
4996 * ":return [expr]"
4997 */
4998 void
4999ex_return(exarg_T *eap)
5000{
5001 char_u *arg = eap->arg;
5002 typval_T rettv;
5003 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005004 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005
5006 if (current_funccal == NULL)
5007 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005008 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005009 return;
5010 }
5011
Bram Moolenaar844fb642021-10-23 13:32:30 +01005012 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005013 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5014
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005015 if (eap->skip)
5016 ++emsg_skip;
5017
5018 eap->nextcmd = NULL;
5019 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005020 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005021 {
5022 if (!eap->skip)
5023 returning = do_return(eap, FALSE, TRUE, &rettv);
5024 else
5025 clear_tv(&rettv);
5026 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005027 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 else if (!eap->skip)
5029 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005030 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005031 update_force_abort();
5032
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005033 /*
5034 * Return unless the expression evaluation has been cancelled due to an
5035 * aborting error, an interrupt, or an exception.
5036 */
5037 if (!aborting())
5038 returning = do_return(eap, FALSE, TRUE, NULL);
5039 }
5040
Bram Moolenaare38eab22019-12-05 21:50:01 +01005041 // When skipping or the return gets pending, advance to the next command
5042 // in this line (!returning). Otherwise, ignore the rest of the line.
5043 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005044 if (returning)
5045 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005046 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005047 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005048
5049 if (eap->skip)
5050 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005051 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052}
5053
5054/*
5055 * ":1,25call func(arg1, arg2)" function call.
5056 */
5057 void
5058ex_call(exarg_T *eap)
5059{
5060 char_u *arg = eap->arg;
5061 char_u *startarg;
5062 char_u *name;
5063 char_u *tofree;
5064 int len;
5065 typval_T rettv;
5066 linenr_T lnum;
5067 int doesrange;
5068 int failed = FALSE;
5069 funcdict_T fudi;
5070 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005071 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005072 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005073 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074
Bram Moolenaare6b53242020-07-01 17:28:33 +02005075 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005076 if (eap->skip)
5077 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005078 // trans_function_name() doesn't work well when skipping, use eval0()
5079 // instead to skip to any following command, e.g. for:
5080 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005081 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005082 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005083 clear_tv(&rettv);
5084 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005085 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005086 return;
5087 }
5088
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005089 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5090 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005091 if (fudi.fd_newkey != NULL)
5092 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005093 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005094 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005095 vim_free(fudi.fd_newkey);
5096 }
5097 if (tofree == NULL)
5098 return;
5099
Bram Moolenaare38eab22019-12-05 21:50:01 +01005100 // Increase refcount on dictionary, it could get deleted when evaluating
5101 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102 if (fudi.fd_dict != NULL)
5103 ++fudi.fd_dict->dv_refcount;
5104
Bram Moolenaare38eab22019-12-05 21:50:01 +01005105 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5106 // contents. For VAR_PARTIAL get its partial, unless we already have one
5107 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005108 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005109 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005110 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005111
Bram Moolenaare38eab22019-12-05 21:50:01 +01005112 // Skip white space to allow ":call func ()". Not good, but required for
5113 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005114 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115 if (*startarg != '(')
5116 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005117 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005118 goto end;
5119 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005120 if (in_vim9script() && startarg > arg)
5121 {
5122 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5123 goto end;
5124 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005125
5126 /*
5127 * When skipping, evaluate the function once, to find the end of the
5128 * arguments.
5129 * When the function takes a range, this is discovered after the first
5130 * call, and the loop is broken.
5131 */
5132 if (eap->skip)
5133 {
5134 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005135 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005136 }
5137 else
5138 lnum = eap->line1;
5139 for ( ; lnum <= eap->line2; ++lnum)
5140 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005141 funcexe_T funcexe;
5142
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005143 if (!eap->skip && eap->addr_count > 0)
5144 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005145 if (lnum > curbuf->b_ml.ml_line_count)
5146 {
5147 // If the function deleted lines or switched to another buffer
5148 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005149 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005150 break;
5151 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 curwin->w_cursor.lnum = lnum;
5153 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005154 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005155 }
5156 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005157
Bram Moolenaara80faa82020-04-12 19:37:17 +02005158 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005159 funcexe.fe_firstline = eap->line1;
5160 funcexe.fe_lastline = eap->line2;
5161 funcexe.fe_doesrange = &doesrange;
5162 funcexe.fe_evaluate = !eap->skip;
5163 funcexe.fe_partial = partial;
5164 funcexe.fe_selfdict = fudi.fd_dict;
5165 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005166 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005167 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005168 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169 {
5170 failed = TRUE;
5171 break;
5172 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005173 if (has_watchexpr())
5174 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005176 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005177 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005178 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005179 {
5180 failed = TRUE;
5181 break;
5182 }
5183
5184 clear_tv(&rettv);
5185 if (doesrange || eap->skip)
5186 break;
5187
Bram Moolenaare38eab22019-12-05 21:50:01 +01005188 // Stop when immediately aborting on error, or when an interrupt
5189 // occurred or an exception was thrown but not caught.
5190 // get_func_tv() returned OK, so that the check for trailing
5191 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192 if (aborting())
5193 break;
5194 }
5195 if (eap->skip)
5196 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005197 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005198
Bram Moolenaar1d341892021-09-18 15:25:52 +02005199 // When inside :try we need to check for following "| catch" or "| endtry".
5200 // Not when there was an error, but do check if an exception was thrown.
5201 if ((!aborting() || did_throw)
5202 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005204 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005205 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005206 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005208 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005209 {
5210 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005211 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005212 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005213 }
5214 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005215 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 }
5217
5218end:
5219 dict_unref(fudi.fd_dict);
5220 vim_free(tofree);
5221}
5222
5223/*
5224 * Return from a function. Possibly makes the return pending. Also called
5225 * for a pending return at the ":endtry" or after returning from an extra
5226 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5227 * when called due to a ":return" command. "rettv" may point to a typval_T
5228 * with the return rettv. Returns TRUE when the return can be carried out,
5229 * FALSE when the return gets pending.
5230 */
5231 int
5232do_return(
5233 exarg_T *eap,
5234 int reanimate,
5235 int is_cmd,
5236 void *rettv)
5237{
5238 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005239 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005240
5241 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005242 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005243 current_funccal->returned = FALSE;
5244
5245 /*
5246 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5247 * not in its finally clause (which then is to be executed next) is found.
5248 * In this case, make the ":return" pending for execution at the ":endtry".
5249 * Otherwise, return normally.
5250 */
5251 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5252 if (idx >= 0)
5253 {
5254 cstack->cs_pending[idx] = CSTP_RETURN;
5255
5256 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005257 // A pending return again gets pending. "rettv" points to an
5258 // allocated variable with the rettv of the original ":return"'s
5259 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005260 cstack->cs_rettv[idx] = rettv;
5261 else
5262 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005263 // When undoing a return in order to make it pending, get the stored
5264 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005265 if (reanimate)
5266 rettv = current_funccal->rettv;
5267
5268 if (rettv != NULL)
5269 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005270 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005271 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5272 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5273 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005274 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005275 }
5276 else
5277 cstack->cs_rettv[idx] = NULL;
5278
5279 if (reanimate)
5280 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005281 // The pending return value could be overwritten by a ":return"
5282 // without argument in a finally clause; reset the default
5283 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005284 current_funccal->rettv->v_type = VAR_NUMBER;
5285 current_funccal->rettv->vval.v_number = 0;
5286 }
5287 }
5288 report_make_pending(CSTP_RETURN, rettv);
5289 }
5290 else
5291 {
5292 current_funccal->returned = TRUE;
5293
Bram Moolenaare38eab22019-12-05 21:50:01 +01005294 // If the return is carried out now, store the return value. For
5295 // a return immediately after reanimation, the value is already
5296 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 if (!reanimate && rettv != NULL)
5298 {
5299 clear_tv(current_funccal->rettv);
5300 *current_funccal->rettv = *(typval_T *)rettv;
5301 if (!is_cmd)
5302 vim_free(rettv);
5303 }
5304 }
5305
5306 return idx < 0;
5307}
5308
5309/*
5310 * Free the variable with a pending return value.
5311 */
5312 void
5313discard_pending_return(void *rettv)
5314{
5315 free_tv((typval_T *)rettv);
5316}
5317
5318/*
5319 * Generate a return command for producing the value of "rettv". The result
5320 * is an allocated string. Used by report_pending() for verbose messages.
5321 */
5322 char_u *
5323get_return_cmd(void *rettv)
5324{
5325 char_u *s = NULL;
5326 char_u *tofree = NULL;
5327 char_u numbuf[NUMBUFLEN];
5328
5329 if (rettv != NULL)
5330 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5331 if (s == NULL)
5332 s = (char_u *)"";
5333
5334 STRCPY(IObuff, ":return ");
5335 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5336 if (STRLEN(s) + 8 >= IOSIZE)
5337 STRCPY(IObuff + IOSIZE - 4, "...");
5338 vim_free(tofree);
5339 return vim_strsave(IObuff);
5340}
5341
5342/*
5343 * Get next function line.
5344 * Called by do_cmdline() to get the next line.
5345 * Returns allocated string, or NULL for end of function.
5346 */
5347 char_u *
5348get_func_line(
5349 int c UNUSED,
5350 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005351 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005352 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005353{
5354 funccall_T *fcp = (funccall_T *)cookie;
5355 ufunc_T *fp = fcp->func;
5356 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005357 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005358
Bram Moolenaare38eab22019-12-05 21:50:01 +01005359 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005360 if (fcp->dbg_tick != debug_tick)
5361 {
5362 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005363 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005364 fcp->dbg_tick = debug_tick;
5365 }
5366#ifdef FEAT_PROFILE
5367 if (do_profiling == PROF_YES)
5368 func_line_end(cookie);
5369#endif
5370
5371 gap = &fp->uf_lines;
5372 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5373 || fcp->returned)
5374 retval = NULL;
5375 else
5376 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005377 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005378 while (fcp->linenr < gap->ga_len
5379 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5380 ++fcp->linenr;
5381 if (fcp->linenr >= gap->ga_len)
5382 retval = NULL;
5383 else
5384 {
5385 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005386 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005387#ifdef FEAT_PROFILE
5388 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005389 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005390#endif
5391 }
5392 }
5393
Bram Moolenaare38eab22019-12-05 21:50:01 +01005394 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005395 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005396 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005397 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005398 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005400 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005401 fcp->dbg_tick = debug_tick;
5402 }
5403
5404 return retval;
5405}
5406
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005407/*
5408 * Return TRUE if the currently active function should be ended, because a
5409 * return was encountered or an error occurred. Used inside a ":while".
5410 */
5411 int
5412func_has_ended(void *cookie)
5413{
5414 funccall_T *fcp = (funccall_T *)cookie;
5415
Bram Moolenaare38eab22019-12-05 21:50:01 +01005416 // Ignore the "abort" flag if the abortion behavior has been changed due to
5417 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005418 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5419 || fcp->returned);
5420}
5421
5422/*
5423 * return TRUE if cookie indicates a function which "abort"s on errors.
5424 */
5425 int
5426func_has_abort(
5427 void *cookie)
5428{
5429 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5430}
5431
5432
5433/*
5434 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5435 * Don't do this when "Func" is already a partial that was bound
5436 * explicitly (pt_auto is FALSE).
5437 * Changes "rettv" in-place.
5438 * Returns the updated "selfdict_in".
5439 */
5440 dict_T *
5441make_partial(dict_T *selfdict_in, typval_T *rettv)
5442{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005443 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005444 char_u *tofree = NULL;
5445 ufunc_T *fp;
5446 char_u fname_buf[FLEN_FIXED + 1];
5447 int error;
5448 dict_T *selfdict = selfdict_in;
5449
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005450 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5451 fp = rettv->vval.v_partial->pt_func;
5452 else
5453 {
5454 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5455 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005456 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005457 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005458 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005459 vim_free(tofree);
5460 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461
5462 if (fp != NULL && (fp->uf_flags & FC_DICT))
5463 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005464 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005465
5466 if (pt != NULL)
5467 {
5468 pt->pt_refcount = 1;
5469 pt->pt_dict = selfdict;
5470 pt->pt_auto = TRUE;
5471 selfdict = NULL;
5472 if (rettv->v_type == VAR_FUNC)
5473 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005474 // Just a function: Take over the function name and use
5475 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476 pt->pt_name = rettv->vval.v_string;
5477 }
5478 else
5479 {
5480 partial_T *ret_pt = rettv->vval.v_partial;
5481 int i;
5482
Bram Moolenaare38eab22019-12-05 21:50:01 +01005483 // Partial: copy the function name, use selfdict and copy
5484 // args. Can't take over name or args, the partial might
5485 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005486 if (ret_pt->pt_name != NULL)
5487 {
5488 pt->pt_name = vim_strsave(ret_pt->pt_name);
5489 func_ref(pt->pt_name);
5490 }
5491 else
5492 {
5493 pt->pt_func = ret_pt->pt_func;
5494 func_ptr_ref(pt->pt_func);
5495 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005496 if (ret_pt->pt_argc > 0)
5497 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005498 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005499 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005500 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005501 pt->pt_argc = 0;
5502 else
5503 {
5504 pt->pt_argc = ret_pt->pt_argc;
5505 for (i = 0; i < pt->pt_argc; i++)
5506 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5507 }
5508 }
5509 partial_unref(ret_pt);
5510 }
5511 rettv->v_type = VAR_PARTIAL;
5512 rettv->vval.v_partial = pt;
5513 }
5514 }
5515 return selfdict;
5516}
5517
5518/*
5519 * Return the name of the executed function.
5520 */
5521 char_u *
5522func_name(void *cookie)
5523{
5524 return ((funccall_T *)cookie)->func->uf_name;
5525}
5526
5527/*
5528 * Return the address holding the next breakpoint line for a funccall cookie.
5529 */
5530 linenr_T *
5531func_breakpoint(void *cookie)
5532{
5533 return &((funccall_T *)cookie)->breakpoint;
5534}
5535
5536/*
5537 * Return the address holding the debug tick for a funccall cookie.
5538 */
5539 int *
5540func_dbg_tick(void *cookie)
5541{
5542 return &((funccall_T *)cookie)->dbg_tick;
5543}
5544
5545/*
5546 * Return the nesting level for a funccall cookie.
5547 */
5548 int
5549func_level(void *cookie)
5550{
5551 return ((funccall_T *)cookie)->level;
5552}
5553
5554/*
5555 * Return TRUE when a function was ended by a ":return" command.
5556 */
5557 int
5558current_func_returned(void)
5559{
5560 return current_funccal->returned;
5561}
5562
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005563 int
5564free_unref_funccal(int copyID, int testing)
5565{
5566 int did_free = FALSE;
5567 int did_free_funccal = FALSE;
5568 funccall_T *fc, **pfc;
5569
5570 for (pfc = &previous_funccal; *pfc != NULL; )
5571 {
5572 if (can_free_funccal(*pfc, copyID))
5573 {
5574 fc = *pfc;
5575 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005576 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005577 did_free = TRUE;
5578 did_free_funccal = TRUE;
5579 }
5580 else
5581 pfc = &(*pfc)->caller;
5582 }
5583 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005584 // When a funccal was freed some more items might be garbage
5585 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005586 (void)garbage_collect(testing);
5587
5588 return did_free;
5589}
5590
5591/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005592 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005593 */
5594 static funccall_T *
5595get_funccal(void)
5596{
5597 int i;
5598 funccall_T *funccal;
5599 funccall_T *temp_funccal;
5600
5601 funccal = current_funccal;
5602 if (debug_backtrace_level > 0)
5603 {
5604 for (i = 0; i < debug_backtrace_level; i++)
5605 {
5606 temp_funccal = funccal->caller;
5607 if (temp_funccal)
5608 funccal = temp_funccal;
5609 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005610 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005611 debug_backtrace_level = i;
5612 }
5613 }
5614 return funccal;
5615}
5616
5617/*
5618 * Return the hashtable used for local variables in the current funccal.
5619 * Return NULL if there is no current funccal.
5620 */
5621 hashtab_T *
5622get_funccal_local_ht()
5623{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005624 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005625 return NULL;
5626 return &get_funccal()->l_vars.dv_hashtab;
5627}
5628
5629/*
5630 * Return the l: scope variable.
5631 * Return NULL if there is no current funccal.
5632 */
5633 dictitem_T *
5634get_funccal_local_var()
5635{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005636 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005637 return NULL;
5638 return &get_funccal()->l_vars_var;
5639}
5640
5641/*
5642 * Return the hashtable used for argument in the current funccal.
5643 * Return NULL if there is no current funccal.
5644 */
5645 hashtab_T *
5646get_funccal_args_ht()
5647{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005648 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005649 return NULL;
5650 return &get_funccal()->l_avars.dv_hashtab;
5651}
5652
5653/*
5654 * Return the a: scope variable.
5655 * Return NULL if there is no current funccal.
5656 */
5657 dictitem_T *
5658get_funccal_args_var()
5659{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005660 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005661 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005662 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005663}
5664
5665/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005666 * List function variables, if there is a function.
5667 */
5668 void
5669list_func_vars(int *first)
5670{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005671 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005672 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005673 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005674}
5675
5676/*
5677 * If "ht" is the hashtable for local variables in the current funccal, return
5678 * the dict that contains it.
5679 * Otherwise return NULL.
5680 */
5681 dict_T *
5682get_current_funccal_dict(hashtab_T *ht)
5683{
5684 if (current_funccal != NULL
5685 && ht == &current_funccal->l_vars.dv_hashtab)
5686 return &current_funccal->l_vars;
5687 return NULL;
5688}
5689
5690/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005691 * Search hashitem in parent scope.
5692 */
5693 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005694find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005695{
5696 funccall_T *old_current_funccal = current_funccal;
5697 hashtab_T *ht;
5698 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005699 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005700
5701 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5702 return NULL;
5703
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005704 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005705 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005706 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005707 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005708 ht = find_var_ht(name, &varname);
5709 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005710 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005711 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005712 if (!HASHITEM_EMPTY(hi))
5713 {
5714 *pht = ht;
5715 break;
5716 }
5717 }
5718 if (current_funccal == current_funccal->func->uf_scoped)
5719 break;
5720 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005721 }
5722 current_funccal = old_current_funccal;
5723
5724 return hi;
5725}
5726
5727/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005728 * Search variable in parent scope.
5729 */
5730 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005731find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005732{
5733 dictitem_T *v = NULL;
5734 funccall_T *old_current_funccal = current_funccal;
5735 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005736 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005737
5738 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5739 return NULL;
5740
Bram Moolenaare38eab22019-12-05 21:50:01 +01005741 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005742 current_funccal = current_funccal->func->uf_scoped;
5743 while (current_funccal)
5744 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005745 ht = find_var_ht(name, &varname);
5746 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005747 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005748 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005749 if (v != NULL)
5750 break;
5751 }
5752 if (current_funccal == current_funccal->func->uf_scoped)
5753 break;
5754 current_funccal = current_funccal->func->uf_scoped;
5755 }
5756 current_funccal = old_current_funccal;
5757
5758 return v;
5759}
5760
5761/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005762 * Set "copyID + 1" in previous_funccal and callers.
5763 */
5764 int
5765set_ref_in_previous_funccal(int copyID)
5766{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005767 funccall_T *fc;
5768
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005769 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005770 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005771 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005772 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5773 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5774 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5775 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005776 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005777 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005778}
5779
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005780 static int
5781set_ref_in_funccal(funccall_T *fc, int copyID)
5782{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005783 if (fc->fc_copyID != copyID)
5784 {
5785 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005786 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5787 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5788 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5789 || set_ref_in_func(NULL, fc->func, copyID))
5790 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005791 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005792 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005793}
5794
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005795/*
5796 * Set "copyID" in all local vars and arguments in the call stack.
5797 */
5798 int
5799set_ref_in_call_stack(int copyID)
5800{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005801 funccall_T *fc;
5802 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005803
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005804 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5805 if (set_ref_in_funccal(fc, copyID))
5806 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005807
5808 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005809 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5810 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5811 if (set_ref_in_funccal(fc, copyID))
5812 return TRUE;
5813 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005814}
5815
5816/*
5817 * Set "copyID" in all functions available by name.
5818 */
5819 int
5820set_ref_in_functions(int copyID)
5821{
5822 int todo;
5823 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005824 ufunc_T *fp;
5825
5826 todo = (int)func_hashtab.ht_used;
5827 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005828 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005829 if (!HASHITEM_EMPTY(hi))
5830 {
5831 --todo;
5832 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005833 if (!func_name_refcount(fp->uf_name)
5834 && set_ref_in_func(NULL, fp, copyID))
5835 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005836 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005837 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005838 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005839}
5840
5841/*
5842 * Set "copyID" in all function arguments.
5843 */
5844 int
5845set_ref_in_func_args(int copyID)
5846{
5847 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005848
5849 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005850 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5851 copyID, NULL, NULL))
5852 return TRUE;
5853 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005854}
5855
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005856/*
5857 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005858 * Returns TRUE if setting references failed somehow.
5859 */
5860 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005861set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005862{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005863 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005864 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005865 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005866 char_u fname_buf[FLEN_FIXED + 1];
5867 char_u *tofree = NULL;
5868 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005869 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005870
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005871 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005872 return FALSE;
5873
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005874 if (fp_in == NULL)
5875 {
5876 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005877 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005878 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005879 if (fp != NULL)
5880 {
5881 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005882 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005883 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005884
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005885 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005886 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005887}
5888
Bram Moolenaare38eab22019-12-05 21:50:01 +01005889#endif // FEAT_EVAL