blob: 48f5890e8b1c4c8acaeb51f72761329312b79050 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020035
36 void
37func_init()
38{
39 hash_init(&func_hashtab);
40}
41
Dominique Pelle748b3082022-01-08 12:41:16 +000042#if defined(FEAT_PROFILE) || defined(PROTO)
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020043/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020044 * Return the function hash table
45 */
46 hashtab_T *
47func_tbl_get(void)
48{
49 return &func_hashtab;
50}
Dominique Pelle748b3082022-01-08 12:41:16 +000051#endif
Bram Moolenaar660a10a2019-07-14 15:48:38 +020052
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010067 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020068 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010069 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010070{
Bram Moolenaar6e949782020-04-13 17:21:00 +020071 char_u *p = arg;
72 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020073 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010074
75 while (ASCII_ISALNUM(*p) || *p == '_')
76 ++p;
77 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020078 || (argtypes == NULL
79 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
80 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010081 {
82 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000083 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 return arg;
85 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010086
Bram Moolenaar057e84a2021-02-28 16:55:11 +010087 // Vim9 script: cannot use script var name for argument. In function: also
88 // check local vars and arguments.
89 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
90 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010091 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010092
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010093 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
94 return arg;
95 if (newargs != NULL)
96 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010097 int c;
98 int i;
99
100 c = *p;
101 *p = NUL;
102 arg_copy = vim_strsave(arg);
103 if (arg_copy == NULL)
104 {
105 *p = c;
106 return arg;
107 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200108 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200109 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200110 // Check for duplicate argument name.
111 for (i = 0; i < newargs->ga_len; ++i)
112 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
113 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000114 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200115 vim_free(arg_copy);
116 return arg;
117 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100118 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
119 newargs->ga_len++;
120
121 *p = c;
122 }
123
124 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100125 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100126 {
127 char_u *type = NULL;
128
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
130 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200131 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 arg_copy == NULL ? arg : arg_copy);
133 p = skipwhite(p);
134 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100135 if (*p == ':')
136 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200137 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100138 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200139 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100140 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200141 return arg;
142 }
143 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200144 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100145 if (!skip)
146 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100147 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200148 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200149 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200150 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200151 arg_copy == NULL ? arg : arg_copy);
152 return arg;
153 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100154 if (!skip)
155 {
156 if (type == NULL && types_optional)
157 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200158 type = vim_strsave((char_u *)
159 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100160 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
161 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100162 }
163
164 return p;
165}
166
167/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000168 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000169 * Get a next line, store it in "eap" if appropriate and put the line in
170 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 */
172 static char_u *
173get_function_line(
174 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000175 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000176 int indent,
177 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000178{
179 char_u *theline;
180
181 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000182 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000183 else
184 theline = eap->getline(':', eap->cookie, indent, getline_options);
185 if (theline != NULL)
186 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000187 if (lines_to_free->ga_len > 0
188 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
189 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000190 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000191 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000192 }
193
194 return theline;
195}
196
197/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200198 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100199 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100200 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203get_function_args(
204 char_u **argp,
205 char_u endchar,
206 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100207 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100208 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100209 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200210 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200211 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200212 int skip,
213 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000214 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200215{
216 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100217 char_u *arg;
218 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200219 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200220 int any_default = FALSE;
221 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100222 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200223
224 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000225 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100226 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000227 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200228 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000229 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230
231 if (varargs != NULL)
232 *varargs = FALSE;
233
234 /*
235 * Isolate the arguments: "arg1, arg2, ...)"
236 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100237 arg = skipwhite(*argp);
238 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200239 while (*p != endchar)
240 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200241 while (eap != NULL && eap->getline != NULL
242 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200243 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200244 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000245 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000246 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000247
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200248 if (theline == NULL)
249 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200250 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 p = skipwhite(theline);
252 }
253
254 if (mustend && *p != endchar)
255 {
256 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000257 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100258 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200259 }
260 if (*p == endchar)
261 break;
262
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200263 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
264 {
265 if (varargs != NULL)
266 *varargs = TRUE;
267 p += 3;
268 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100269
270 if (argtypes != NULL)
271 {
272 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200273 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100275 if (!skip)
276 emsg(_(e_missing_name_after_dots));
277 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100278 }
279
280 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100281 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200282 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100283 if (p == arg)
284 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100285 if (*skipwhite(p) == '=')
286 {
287 emsg(_(e_cannot_use_default_for_variable_arguments));
288 break;
289 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100290 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200291 }
292 else
293 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200294 char_u *np;
295
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200296 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100297 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200298 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100299 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200300 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200301
Bram Moolenaar015cf102021-06-26 21:52:02 +0200302 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200303 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200304 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200305 if (*np == '=' && np[1] != '=' && np[1] != '~'
306 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200307 {
308 typval_T rettv;
309
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100310 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200311 any_default = TRUE;
312 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200313 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 p = skipwhite(p);
315 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200316 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200318 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200319 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200320 if (ga_grow(default_args, 1) == FAIL)
321 goto err_ret;
322
323 // trim trailing whitespace
324 while (p > expr && VIM_ISWHITE(p[-1]))
325 p--;
326 c = *p;
327 *p = NUL;
328 expr = vim_strsave(expr);
329 if (expr == NULL)
330 {
331 *p = c;
332 goto err_ret;
333 }
334 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200335 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200336 default_args->ga_len++;
337 *p = c;
338 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200339 }
340 else
341 mustend = TRUE;
342 }
343 else if (any_default)
344 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000345 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200346 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200347 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200348
349 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
350 {
351 // Be tolerant when skipping
352 if (!skip)
353 {
354 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
355 goto err_ret;
356 }
357 p = skipwhite(p);
358 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200359 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200360 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200361 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200362 // Don't give this error when skipping, it makes the "->" not
363 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100364 // Allow missing space after comma in legacy functions.
365 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200366 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
367 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100368 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 goto err_ret;
370 }
371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200372 else
373 mustend = TRUE;
374 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200375 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200376 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200378
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200379 if (*p != endchar)
380 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100381 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200382
383 *argp = p;
384 return OK;
385
386err_ret:
387 if (newargs != NULL)
388 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200389 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200390 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200391 return FAIL;
392}
393
394/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100395 * Parse the argument types, filling "fp->uf_arg_types".
396 * Return OK or FAIL.
397 */
398 static int
399parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
400{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200401 int len = 0;
402
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100403 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
404 if (argtypes->ga_len > 0)
405 {
406 // When "varargs" is set the last name/type goes into uf_va_name
407 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200408 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100409
410 if (len > 0)
411 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
412 if (fp->uf_arg_types != NULL)
413 {
414 int i;
415 type_T *type;
416
417 for (i = 0; i < len; ++ i)
418 {
419 char_u *p = ((char_u **)argtypes->ga_data)[i];
420
421 if (p == NULL)
422 // will get the type from the default value
423 type = &t_unknown;
424 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100425 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100426 if (type == NULL)
427 return FAIL;
428 fp->uf_arg_types[i] = type;
429 }
430 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100431 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200432
433 if (varargs)
434 {
435 char_u *p;
436
437 // Move the last argument "...name: type" to uf_va_name and
438 // uf_va_type.
439 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
440 [fp->uf_args.ga_len - 1];
441 --fp->uf_args.ga_len;
442 p = ((char_u **)argtypes->ga_data)[len];
443 if (p == NULL)
444 // TODO: get type from default value
445 fp->uf_va_type = &t_list_any;
446 else
447 {
448 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
449 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
450 {
451 semsg(_(e_variable_arguments_type_must_be_list_str),
452 ((char_u **)argtypes->ga_data)[len]);
453 return FAIL;
454 }
455 }
456 if (fp->uf_va_type == NULL)
457 return FAIL;
458 }
459
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100460 return OK;
461}
462
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100463 static int
464parse_return_type(ufunc_T *fp, char_u *ret_type)
465{
466 if (ret_type == NULL)
467 fp->uf_ret_type = &t_void;
468 else
469 {
470 char_u *p = ret_type;
471
472 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
473 if (fp->uf_ret_type == NULL)
474 {
475 fp->uf_ret_type = &t_void;
476 return FAIL;
477 }
478 }
479 return OK;
480}
481
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100482/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200483 * Register function "fp" as using "current_funccal" as its scope.
484 */
485 static int
486register_closure(ufunc_T *fp)
487{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200488 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100489 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200490 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200491 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200492 fp->uf_scoped = current_funccal;
493 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
496 return FAIL;
497 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
498 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200499 return OK;
500}
501
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100502 static void
503set_ufunc_name(ufunc_T *fp, char_u *name)
504{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100505 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
506 // actually extends beyond the struct.
507 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100508
509 if (name[0] == K_SPECIAL)
510 {
511 fp->uf_name_exp = alloc(STRLEN(name) + 3);
512 if (fp->uf_name_exp != NULL)
513 {
514 STRCPY(fp->uf_name_exp, "<SNR>");
515 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
516 }
517 }
518}
519
Bram Moolenaar58016442016-07-31 18:30:22 +0200520/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200521 * Get a name for a lambda. Returned in static memory.
522 */
523 char_u *
524get_lambda_name(void)
525{
526 static char_u name[30];
527 static int lambda_no = 0;
528
529 sprintf((char*)name, "<lambda>%d", ++lambda_no);
530 return name;
531}
532
Bram Moolenaar801ab062020-06-25 19:27:56 +0200533#if defined(FEAT_LUA) || defined(PROTO)
534/*
535 * Registers a native C callback which can be called from Vim script.
536 * Returns the name of the Vim script function.
537 */
538 char_u *
539register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
540{
541 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200542 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200543
544 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
545 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200546 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200547
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200548 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200549 fp->uf_refcount = 1;
550 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000551 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200552 fp->uf_calls = 0;
553 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200554 fp->uf_cb = cb;
555 fp->uf_cb_free = cb_free;
556 fp->uf_cb_state = state;
557
558 set_ufunc_name(fp, name);
559 hash_add(&func_hashtab, UF2HIKEY(fp));
560
561 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200562}
563#endif
564
Bram Moolenaar04b12692020-05-04 23:24:44 +0200565/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100566 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100568 * If "white_error" is not NULL check for correct use of white space and set
569 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100570 * Return NULL if no valid arrow found.
571 */
572 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100573skip_arrow(
574 char_u *start,
575 int equal_arrow,
576 char_u **ret_type,
577 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100578{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100579 char_u *s = start;
580 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100581
582 if (equal_arrow)
583 {
584 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100585 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100586 if (white_error != NULL && !VIM_ISWHITE(s[1]))
587 {
588 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100589 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100592 s = skipwhite(s + 1);
593 *ret_type = s;
594 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100595 if (s == *ret_type)
596 {
597 emsg(_(e_missing_return_type));
598 return NULL;
599 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100600 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100601 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100602 s = skipwhite(s);
603 if (*s != '=')
604 return NULL;
605 ++s;
606 }
607 if (*s != '>')
608 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100609 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
610 || !IS_WHITE_OR_NUL(s[1])))
611 {
612 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100613 semsg(_(e_white_space_required_before_and_after_str_at_str),
614 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100615 return NULL;
616 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100617 return skipwhite(s + 1);
618}
619
620/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100621 * Check if "*cmd" points to a function command and if so advance "*cmd" and
622 * return TRUE.
623 * Otherwise return FALSE;
624 * Do not consider "function(" to be a command.
625 */
626 static int
627is_function_cmd(char_u **cmd)
628{
629 char_u *p = *cmd;
630
631 if (checkforcmd(&p, "function", 2))
632 {
633 if (*p == '(')
634 return FALSE;
635 *cmd = p;
636 return TRUE;
637 }
638 return FALSE;
639}
640
641/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200642 * Called when defining a function: The context may be needed for script
643 * variables declared in a block that is visible now but not when the function
644 * is compiled or called later.
645 */
646 static void
647function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
648{
649 if (cstack != NULL && cstack->cs_idx >= 0)
650 {
651 int count = cstack->cs_idx + 1;
652 int i;
653
654 fp->uf_block_ids = ALLOC_MULT(int, count);
655 if (fp->uf_block_ids != NULL)
656 {
657 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
658 sizeof(int) * count);
659 fp->uf_block_depth = count;
660 }
661
662 // Set flag in each block to indicate a function was defined. This
663 // is used to keep the variable when leaving the block, see
664 // hide_script_var().
665 for (i = 0; i <= cstack->cs_idx; ++i)
666 cstack->cs_flags[i] |= CSF_FUNC_DEF;
667 }
668}
669
670/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100671 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200672 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100673 * "newlines" must already have been initialized.
674 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
675 */
676 static int
677get_function_body(
678 exarg_T *eap,
679 garray_T *newlines,
680 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000681 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100682{
683 linenr_T sourcing_lnum_top = SOURCING_LNUM;
684 linenr_T sourcing_lnum_off;
685 int saved_wait_return = need_wait_return;
686 char_u *line_arg = line_arg_in;
687 int vim9_function = eap->cmdidx == CMD_def
688 || eap->cmdidx == CMD_block;
689#define MAX_FUNC_NESTING 50
690 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100692 int nesting = 0;
693 getline_opt_T getline_options;
694 int indent = 2;
695 char_u *skip_until = NULL;
696 int ret = FAIL;
697 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200698 int heredoc_concat_len = 0;
699 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100700 char_u *heredoc_trimmed = NULL;
701
Bram Moolenaar20677332021-06-06 17:02:53 +0200702 ga_init2(&heredoc_ga, 1, 500);
703
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100704 // Detect having skipped over comment lines to find the return
705 // type. Add NULL lines to keep the line count correct.
706 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
707 if (SOURCING_LNUM < sourcing_lnum_off)
708 {
709 sourcing_lnum_off -= SOURCING_LNUM;
710 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
711 goto theend;
712 while (sourcing_lnum_off-- > 0)
713 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
714 }
715
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200716 nesting_def[0] = vim9_function;
717 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100718 getline_options = vim9_function
719 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
720 for (;;)
721 {
722 char_u *theline;
723 char_u *p;
724 char_u *arg;
725
726 if (KeyTyped)
727 {
728 msg_scroll = TRUE;
729 saved_wait_return = FALSE;
730 }
731 need_wait_return = FALSE;
732
733 if (line_arg != NULL)
734 {
735 // Use eap->arg, split up in parts by line breaks.
736 theline = line_arg;
737 p = vim_strchr(theline, '\n');
738 if (p == NULL)
739 line_arg += STRLEN(line_arg);
740 else
741 {
742 *p = NUL;
743 line_arg = p + 1;
744 }
745 }
746 else
747 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000748 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100749 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100750 }
751 if (KeyTyped)
752 lines_left = Rows - 1;
753 if (theline == NULL)
754 {
755 // Use the start of the function for the line number.
756 SOURCING_LNUM = sourcing_lnum_top;
757 if (skip_until != NULL)
758 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200759 else if (nesting_inline[nesting])
760 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100761 else if (eap->cmdidx == CMD_def)
762 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100763 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000764 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100765 goto theend;
766 }
767
768 // Detect line continuation: SOURCING_LNUM increased more than one.
769 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
770 if (SOURCING_LNUM < sourcing_lnum_off)
771 sourcing_lnum_off -= SOURCING_LNUM;
772 else
773 sourcing_lnum_off = 0;
774
775 if (skip_until != NULL)
776 {
777 // Don't check for ":endfunc"/":enddef" between
778 // * ":append" and "."
779 // * ":python <<EOF" and "EOF"
780 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
781 if (heredoc_trimmed == NULL
782 || (is_heredoc && skipwhite(theline) == theline)
783 || STRNCMP(theline, heredoc_trimmed,
784 STRLEN(heredoc_trimmed)) == 0)
785 {
786 if (heredoc_trimmed == NULL)
787 p = theline;
788 else if (is_heredoc)
789 p = skipwhite(theline) == theline
790 ? theline : theline + STRLEN(heredoc_trimmed);
791 else
792 p = theline + STRLEN(heredoc_trimmed);
793 if (STRCMP(p, skip_until) == 0)
794 {
795 VIM_CLEAR(skip_until);
796 VIM_CLEAR(heredoc_trimmed);
797 getline_options = vim9_function
798 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
799 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200800
801 if (heredoc_concat_len > 0)
802 {
803 // Replace the starting line with all the concatenated
804 // lines.
805 ga_concat(&heredoc_ga, theline);
806 vim_free(((char_u **)(newlines->ga_data))[
807 heredoc_concat_len - 1]);
808 ((char_u **)(newlines->ga_data))[
809 heredoc_concat_len - 1] = heredoc_ga.ga_data;
810 ga_init(&heredoc_ga);
811 heredoc_concat_len = 0;
812 theline += STRLEN(theline); // skip the "EOF"
813 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100814 }
815 }
816 }
817 else
818 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200819 int c;
820 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100821
822 // skip ':' and blanks
823 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
824 ;
825
826 // Check for "endfunction", "enddef" or "}".
827 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200828 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100829 ? *p == '}'
830 : (checkforcmd(&p, nesting_def[nesting]
831 ? "enddef" : "endfunction", 4)
832 && *p != ':'))
833 {
834 if (nesting-- == 0)
835 {
836 char_u *nextcmd = NULL;
837
838 if (*p == '|' || *p == '}')
839 nextcmd = p + 1;
840 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
841 nextcmd = line_arg;
842 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100843 && (vim9_function || p_verbose > 0))
844 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200845 SOURCING_LNUM = sourcing_lnum_top
846 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100847 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000848 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100849 else
850 give_warning2((char_u *)
851 _("W22: Text found after :endfunction: %s"),
852 p, TRUE);
853 }
854 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100855 {
856 // Another command follows. If the line came from "eap"
857 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000858 // change "eap->cmdlinep" to point to the last fetched
859 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100860 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000861 if (lines_to_free->ga_len > 0
862 && *eap->cmdlinep !=
863 ((char_u **)lines_to_free->ga_data)
864 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100865 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000866 // *cmdlinep will be freed later, thus remove the
867 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000869 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
870 [lines_to_free->ga_len - 1];
871 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100872 }
873 }
874 break;
875 }
876 }
877
878 // Check for mismatched "endfunc" or "enddef".
879 // We don't check for "def" inside "func" thus we also can't check
880 // for "enddef".
881 // We continue to find the end of the function, although we might
882 // not find it.
883 else if (nesting_def[nesting])
884 {
885 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
886 emsg(_(e_mismatched_endfunction));
887 }
888 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
889 emsg(_(e_mismatched_enddef));
890
891 // Increase indent inside "if", "while", "for" and "try", decrease
892 // at "end".
893 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
894 indent -= 2;
895 else if (STRNCMP(p, "if", 2) == 0
896 || STRNCMP(p, "wh", 2) == 0
897 || STRNCMP(p, "for", 3) == 0
898 || STRNCMP(p, "try", 3) == 0)
899 indent += 2;
900
901 // Check for defining a function inside this function.
902 // Only recognize "def" inside "def", not inside "function",
903 // For backwards compatibility, see Test_function_python().
904 c = *p;
905 if (is_function_cmd(&p)
906 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
907 {
908 if (*p == '!')
909 p = skipwhite(p + 1);
910 p += eval_fname_script(p);
911 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
912 NULL, NULL));
913 if (*skipwhite(p) == '(')
914 {
915 if (nesting == MAX_FUNC_NESTING - 1)
916 emsg(_(e_function_nesting_too_deep));
917 else
918 {
919 ++nesting;
920 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200921 nesting_inline[nesting] = FALSE;
922 indent += 2;
923 }
924 }
925 }
926
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200927 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200928 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200929 // Not a comment line: check for nested inline function.
930 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200931 while (end > p && VIM_ISWHITE(*end))
932 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200933 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200934 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200935 int is_block;
936
937 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200938 --end;
939 while (end > p && VIM_ISWHITE(*end))
940 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200941 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
942 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200943 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200944 char_u *s = p;
945
946 // check for line starting with "au" for :autocmd or
947 // "com" for :command, these can use a {} block
948 is_block = checkforcmd_noparen(&s, "autocmd", 2)
949 || checkforcmd_noparen(&s, "command", 3);
950 }
951
952 if (is_block)
953 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200954 if (nesting == MAX_FUNC_NESTING - 1)
955 emsg(_(e_function_nesting_too_deep));
956 else
957 {
958 ++nesting;
959 nesting_def[nesting] = TRUE;
960 nesting_inline[nesting] = TRUE;
961 indent += 2;
962 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100963 }
964 }
965 }
966
967 // Check for ":append", ":change", ":insert". Not for :def.
968 p = skip_range(p, FALSE, NULL);
969 if (!vim9_function
970 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
971 || (p[0] == 'c'
972 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
973 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
974 && (STRNCMP(&p[3], "nge", 3) != 0
975 || !ASCII_ISALPHA(p[6])))))))
976 || (p[0] == 'i'
977 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
978 && (!ASCII_ISALPHA(p[2])
979 || (p[2] == 's'
980 && (!ASCII_ISALPHA(p[3])
981 || p[3] == 'e'))))))))
982 skip_until = vim_strsave((char_u *)".");
983
984 // Check for ":python <<EOF", ":tcl <<EOF", etc.
985 arg = skipwhite(skiptowhite(p));
986 if (arg[0] == '<' && arg[1] =='<'
987 && ((p[0] == 'p' && p[1] == 'y'
988 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
989 || ((p[2] == '3' || p[2] == 'x')
990 && !ASCII_ISALPHA(p[3]))))
991 || (p[0] == 'p' && p[1] == 'e'
992 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
993 || (p[0] == 't' && p[1] == 'c'
994 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
995 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
996 && !ASCII_ISALPHA(p[3]))
997 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
998 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
999 || (p[0] == 'm' && p[1] == 'z'
1000 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1001 ))
1002 {
1003 // ":python <<" continues until a dot, like ":append"
1004 p = skipwhite(arg + 2);
1005 if (STRNCMP(p, "trim", 4) == 0)
1006 {
1007 // Ignore leading white space.
1008 p = skipwhite(p + 4);
1009 heredoc_trimmed = vim_strnsave(theline,
1010 skipwhite(theline) - theline);
1011 }
1012 if (*p == NUL)
1013 skip_until = vim_strsave((char_u *)".");
1014 else
1015 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1016 getline_options = GETLINE_NONE;
1017 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001018 if (eap->cmdidx == CMD_def)
1019 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001020 }
1021
1022 // Check for ":cmd v =<< [trim] EOF"
1023 // and ":cmd [a, b] =<< [trim] EOF"
1024 // and "lines =<< [trim] EOF" for Vim9
1025 // Where "cmd" can be "let", "var", "final" or "const".
1026 arg = skipwhite(skiptowhite(p));
1027 if (*arg == '[')
1028 arg = vim_strchr(arg, ']');
1029 if (arg != NULL)
1030 {
1031 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1032 && arg[1] == '<' && arg[2] =='<');
1033
1034 if (!found)
1035 // skip over the argument after "cmd"
1036 arg = skipwhite(skiptowhite(arg));
1037 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1038 && (checkforcmd(&p, "let", 2)
1039 || checkforcmd(&p, "var", 3)
1040 || checkforcmd(&p, "final", 5)
1041 || checkforcmd(&p, "const", 5))))
1042 {
1043 p = skipwhite(arg + 3);
1044 if (STRNCMP(p, "trim", 4) == 0)
1045 {
1046 // Ignore leading white space.
1047 p = skipwhite(p + 4);
1048 heredoc_trimmed = vim_strnsave(theline,
1049 skipwhite(theline) - theline);
1050 }
1051 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1052 getline_options = GETLINE_NONE;
1053 is_heredoc = TRUE;
1054 }
1055 }
1056 }
1057
1058 // Add the line to the function.
1059 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1060 goto theend;
1061
Bram Moolenaar20677332021-06-06 17:02:53 +02001062 if (heredoc_concat_len > 0)
1063 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001064 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001065 // to be used for the instruction later.
1066 ga_concat(&heredoc_ga, theline);
1067 ga_concat(&heredoc_ga, (char_u *)"\n");
1068 p = vim_strsave((char_u *)"");
1069 }
1070 else
1071 {
1072 // Copy the line to newly allocated memory. get_one_sourceline()
1073 // allocates 250 bytes per line, this saves 80% on average. The
1074 // cost is an extra alloc/free.
1075 p = vim_strsave(theline);
1076 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001077 if (p == NULL)
1078 goto theend;
1079 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1080
1081 // Add NULL lines for continuation lines, so that the line count is
1082 // equal to the index in the growarray.
1083 while (sourcing_lnum_off-- > 0)
1084 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1085
1086 // Check for end of eap->arg.
1087 if (line_arg != NULL && *line_arg == NUL)
1088 line_arg = NULL;
1089 }
1090
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001091 // Return OK when no error was detected.
1092 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001093 ret = OK;
1094
1095theend:
1096 vim_free(skip_until);
1097 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001098 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001099 need_wait_return |= saved_wait_return;
1100 return ret;
1101}
1102
1103/*
1104 * Handle the body of a lambda. *arg points to the "{", process statements
1105 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001106 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 * When successful "rettv" is set to a funcref.
1108 */
1109 static int
1110lambda_function_body(
1111 char_u **arg,
1112 typval_T *rettv,
1113 evalarg_T *evalarg,
1114 garray_T *newargs,
1115 garray_T *argtypes,
1116 int varargs,
1117 garray_T *default_args,
1118 char_u *ret_type)
1119{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001120 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001121 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001122 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001123 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001124 exarg_T eap;
1125 garray_T newlines;
1126 char_u *cmdline = NULL;
1127 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001128 partial_T *pt;
1129 char_u *name;
1130 int lnum_save = -1;
1131 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1132
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001133 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1134 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001135 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001136 return FAIL;
1137 }
1138
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001139 CLEAR_FIELD(eap);
1140 eap.cmdidx = CMD_block;
1141 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 eap.cmdlinep = &cmdline;
1143 eap.skip = !evaluate;
1144 if (evalarg->eval_cctx != NULL)
1145 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1146 else
1147 {
1148 eap.getline = evalarg->eval_getline;
1149 eap.cookie = evalarg->eval_cookie;
1150 }
1151
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001152 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001153 if (get_function_body(&eap, &newlines, NULL,
1154 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001155 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001156
1157 // When inside a lambda must add the function lines to evalarg.eval_ga.
1158 evalarg->eval_break_count += newlines.ga_len;
1159 if (gap->ga_itemsize > 0)
1160 {
1161 int idx;
1162 char_u *last;
1163 size_t plen;
1164 char_u *pnl;
1165
1166 for (idx = 0; idx < newlines.ga_len; ++idx)
1167 {
1168 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1169
Bram Moolenaarecb66452021-05-18 15:09:18 +02001170 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001171 goto erret;
1172
1173 // Going to concatenate the lines after parsing. For an empty or
1174 // comment line use an empty string.
1175 // Insert NL characters at the start of each line, the string will
1176 // be split again later in .get_lambda_tv().
1177 if (*p == NUL || vim9_comment_start(p))
1178 p = (char_u *)"";
1179 plen = STRLEN(p);
1180 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1181 if (pnl != NULL)
1182 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001183 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1184 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001185 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001186 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001187 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001188 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001189 // more is following after the "}", which was skipped
1190 last = cmdline;
1191 else
1192 // nothing is following the "}"
1193 last = (char_u *)"}";
1194 plen = STRLEN(last);
1195 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1196 if (pnl != NULL)
1197 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001198 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1199 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001200 }
1201
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001202 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001203 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001204 garray_T *tfgap = &evalarg->eval_tofree_ga;
1205
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 // Something comes after the "}".
1207 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001208
1209 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001210 if (ga_grow(tfgap, 1) == OK)
1211 {
1212 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1213 evalarg->eval_using_cmdline = TRUE;
1214 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001215 }
1216 else
1217 *arg = (char_u *)"";
1218
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001219 if (!evaluate)
1220 {
1221 ret = OK;
1222 goto erret;
1223 }
1224
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001225 name = get_lambda_name();
1226 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1227 if (ufunc == NULL)
1228 goto erret;
1229 set_ufunc_name(ufunc, name);
1230 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001231 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001232 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001233 ufunc->uf_refcount = 1;
1234 ufunc->uf_args = *newargs;
1235 newargs->ga_data = NULL;
1236 ufunc->uf_def_args = *default_args;
1237 default_args->ga_data = NULL;
1238 ufunc->uf_func_type = &t_func_any;
1239
1240 // error messages are for the first function line
1241 lnum_save = SOURCING_LNUM;
1242 SOURCING_LNUM = sourcing_lnum_top;
1243
1244 // parse argument types
1245 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1246 {
1247 SOURCING_LNUM = lnum_save;
1248 goto erret;
1249 }
1250
1251 // parse the return type, if any
1252 if (parse_return_type(ufunc, ret_type) == FAIL)
1253 goto erret;
1254
1255 pt = ALLOC_CLEAR_ONE(partial_T);
1256 if (pt == NULL)
1257 goto erret;
1258 pt->pt_func = ufunc;
1259 pt->pt_refcount = 1;
1260
1261 ufunc->uf_lines = newlines;
1262 newlines.ga_data = NULL;
1263 if (sandbox)
1264 ufunc->uf_flags |= FC_SANDBOX;
1265 if (!ASCII_ISUPPER(*ufunc->uf_name))
1266 ufunc->uf_flags |= FC_VIM9;
1267 ufunc->uf_script_ctx = current_sctx;
1268 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1269 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1270 set_function_type(ufunc);
1271
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001272 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1273
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001274 rettv->vval.v_partial = pt;
1275 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001276 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001277 ret = OK;
1278
1279erret:
1280 if (lnum_save >= 0)
1281 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001283 if (newargs != NULL)
1284 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001286 if (ufunc != NULL)
1287 {
1288 func_clear(ufunc, TRUE);
1289 func_free(ufunc, TRUE);
1290 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001291 return ret;
1292}
1293
1294/*
1295 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001296 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001297 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001298 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1299 */
1300 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001301get_lambda_tv(
1302 char_u **arg,
1303 typval_T *rettv,
1304 int types_optional,
1305 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001306{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001307 int evaluate = evalarg != NULL
1308 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309 garray_T newargs;
1310 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001311 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001312 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001313 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001315 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001316 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001317 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001318 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001319 char_u *s;
1320 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001321 int *old_eval_lavars = eval_lavars_used;
1322 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001323 char_u *tofree1 = NULL;
1324 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001325 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001326 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001327 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001328
1329 if (equal_arrow && !in_vim9script())
1330 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001331
1332 ga_init(&newargs);
1333 ga_init(&newlines);
1334
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 // First, check if this is really a lambda expression. "->" or "=>" must
1336 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001337 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001338 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001339 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001340 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001341 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001342 {
1343 if (types_optional)
1344 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001345 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001348 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001349 if (evaluate)
1350 pnewargs = &newargs;
1351 else
1352 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001353 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001354 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001355 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001356 &varargs, &default_args,
1357 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001358 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001359 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001360 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001361 {
1362 if (types_optional)
1363 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001364 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001365 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001366 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001367 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001368
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001369 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1370 if (ret_type != NULL)
1371 {
1372 ret_type = vim_strsave(ret_type);
1373 tofree2 = ret_type;
1374 }
1375
Bram Moolenaare38eab22019-12-05 21:50:01 +01001376 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001377 if (evaluate)
1378 eval_lavars_used = &eval_lavars;
1379
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380 *arg = skipwhite_and_linebreak(*arg, evalarg);
1381
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001382 // Recognize "{" as the start of a function body.
1383 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001384 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001385 if (evalarg == NULL)
1386 // cannot happen?
1387 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001388 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1389 types_optional ? &argtypes : NULL, varargs,
1390 &default_args, ret_type) == FAIL)
1391 goto errret;
1392 goto theend;
1393 }
1394 if (default_args.ga_len > 0)
1395 {
1396 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001397 goto errret;
1398 }
1399
Bram Moolenaare38eab22019-12-05 21:50:01 +01001400 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001401 start = *arg;
1402 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001403 if (ret == FAIL)
1404 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001405 if (evalarg != NULL)
1406 {
1407 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001408 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001409 evalarg->eval_tofree = NULL;
1410 }
1411
Bram Moolenaar65c44152020-12-24 15:14:01 +01001412 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001413 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001414 *arg = skipwhite_and_linebreak(*arg, evalarg);
1415 if (**arg != '}')
1416 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001417 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001418 goto errret;
1419 }
1420 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422
1423 if (evaluate)
1424 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001425 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001426 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001427 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001428 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001429 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001430
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001431 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 if (fp == NULL)
1433 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001434 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001435 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001436 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001437 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001439 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 if (ga_grow(&newlines, 1) == FAIL)
1441 goto errret;
1442
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001443 // If there are line breaks, we need to split up the string.
1444 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001445 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001446 line_end = end;
1447
1448 // Add "return " before the expression (or the first line).
1449 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001450 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 if (p == NULL)
1452 goto errret;
1453 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1454 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001455 vim_strncpy(p + 7, start, line_end - start);
1456
1457 if (line_end != end)
1458 {
1459 // Add more lines, split by line breaks. Thus is used when a
1460 // lambda with { cmds } is encountered.
1461 while (*line_end == '\n')
1462 {
1463 if (ga_grow(&newlines, 1) == FAIL)
1464 goto errret;
1465 start = line_end + 1;
1466 line_end = vim_strchr(start, '\n');
1467 if (line_end == NULL)
1468 line_end = end;
1469 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1470 vim_strnsave(start, line_end - start);
1471 }
1472 }
1473
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001474 if (strstr((char *)p + 7, "a:") == NULL)
1475 // No a: variables are used for sure.
1476 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477
1478 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001479 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001481 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001482 if (types_optional)
1483 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001484 if (parse_argument_types(fp, &argtypes,
1485 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001486 goto errret;
1487 if (ret_type != NULL)
1488 {
1489 fp->uf_ret_type = parse_type(&ret_type,
1490 &fp->uf_type_list, TRUE);
1491 if (fp->uf_ret_type == NULL)
1492 goto errret;
1493 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001494 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001495 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001496 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001497
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001499 if (current_funccal != NULL && eval_lavars)
1500 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001501 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001502 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001503 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001504 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505
1506#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 if (prof_def_func())
1508 func_do_profile(fp);
1509#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001510 if (sandbox)
1511 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001512 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001513 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1514 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001515 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001517 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001518 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001520 function_using_block_scopes(fp, evalarg->eval_cstack);
1521
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001522 pt->pt_func = fp;
1523 pt->pt_refcount = 1;
1524 rettv->vval.v_partial = pt;
1525 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001526
1527 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001530theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001531 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001532 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001533 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001534 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001535 vim_free(tofree1);
1536 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001537 if (types_optional)
1538 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001539
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001540 return OK;
1541
1542errret:
1543 ga_clear_strings(&newargs);
1544 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001545 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001546 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001547 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001548 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001549 if (fp != NULL)
1550 vim_free(fp->uf_arg_types);
1551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001553 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001554 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001555 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001556 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001557 vim_free(tofree1);
1558 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001559 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 return FAIL;
1561}
1562
1563/*
1564 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1565 * name it contains, otherwise return "name".
1566 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1567 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001568 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1569 * type of the variable.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001570 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001571 */
1572 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001573deref_func_name(
1574 char_u *name,
1575 int *lenp,
1576 partial_T **partialp,
1577 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001578 int no_autoload,
1579 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580{
1581 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001582 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001583 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001584 char_u *s = NULL;
1585 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001586 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587
1588 if (partialp != NULL)
1589 *partialp = NULL;
1590
1591 cc = name[*lenp];
1592 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001593
Bram Moolenaar71f21932022-01-07 18:20:55 +00001594 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001596 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001598 tv = &v->di_tv;
1599 }
1600 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1601 {
1602 imported_T *import;
1603 char_u *p = name;
1604 int len = *lenp;
1605
1606 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001608 p = name + 2;
1609 len -= 2;
1610 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001611 import = find_imported(p, len, FALSE, NULL);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001612
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001613 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001614 if (import != NULL)
1615 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001616 name[len] = NUL;
1617 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
1618 name[len] = cc;
1619 *lenp = 0;
1620 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001621 }
1622 }
1623
1624 if (tv != NULL)
1625 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001626 if (found_var != NULL)
1627 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001628 if (tv->v_type == VAR_FUNC)
1629 {
1630 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001631 {
1632 *lenp = 0;
1633 return (char_u *)""; // just in case
1634 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001635 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001639 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001641 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001642
1643 if (pt == NULL)
1644 {
1645 *lenp = 0;
1646 return (char_u *)""; // just in case
1647 }
1648 if (partialp != NULL)
1649 *partialp = pt;
1650 s = partial_name(pt);
1651 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001653
1654 if (s != NULL)
1655 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001656 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001657 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001658 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001659
1660 if (sv != NULL)
1661 *type = sv->sv_type;
1662 }
1663 return s;
1664 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001665 }
1666
1667 return name;
1668}
1669
1670/*
1671 * Give an error message with a function name. Handle <SNR> things.
1672 * "ermsg" is to be passed without translation, use N_() instead of _().
1673 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001674 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675emsg_funcname(char *ermsg, char_u *name)
1676{
1677 char_u *p;
1678
1679 if (*name == K_SPECIAL)
1680 p = concat_str((char_u *)"<SNR>", name + 3);
1681 else
1682 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001683 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684 if (p != name)
1685 vim_free(p);
1686}
1687
1688/*
1689 * Allocate a variable for the result of a function.
1690 * Return OK or FAIL.
1691 */
1692 int
1693get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001694 char_u *name, // name of the function
1695 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001697 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001698 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001699 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700{
1701 char_u *argp;
1702 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001703 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1704 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001705 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001706 int evaluate = evalarg == NULL
1707 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708
1709 /*
1710 * Get the arguments.
1711 */
1712 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001713 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1714 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001716 // skip the '(' or ',' and possibly line breaks
1717 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1718
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719 if (*argp == ')' || *argp == ',' || *argp == NUL)
1720 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001721 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 {
1723 ret = FAIL;
1724 break;
1725 }
1726 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001727 // The comma should come right after the argument, but this wasn't
1728 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001729 if (vim9script)
1730 {
1731 if (*argp != ',' && *skipwhite(argp) == ',')
1732 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001733 if (evaluate)
1734 semsg(_(e_no_white_space_allowed_before_str_str),
1735 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001736 ret = FAIL;
1737 break;
1738 }
1739 }
1740 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001741 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001742 if (*argp != ',')
1743 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001744 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1745 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001746 if (evaluate)
1747 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001748 ret = FAIL;
1749 break;
1750 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001752 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753 if (*argp == ')')
1754 ++argp;
1755 else
1756 ret = FAIL;
1757
1758 if (ret == OK)
1759 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001760 int i = 0;
1761 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001762
1763 if (get_vim_var_nr(VV_TESTING))
1764 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001765 // Prepare for calling test_garbagecollect_now(), need to know
1766 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001768 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 for (i = 0; i < argcount; ++i)
1770 if (ga_grow(&funcargs, 1) == OK)
1771 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1772 &argvars[i];
1773 }
1774
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001775 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001776 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001777 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001778 // An error in a builtin function does not return FAIL, but we do
1779 // want to abort further processing if an error was given.
1780 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001781 clear_tv(rettv);
1782 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783
1784 funcargs.ga_len -= i;
1785 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001786 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 {
1788 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001789 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001791 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 }
1793
1794 while (--argcount >= 0)
1795 clear_tv(&argvars[argcount]);
1796
Bram Moolenaar8294d492020-08-10 22:40:56 +02001797 if (in_vim9script())
1798 *arg = argp;
1799 else
1800 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001801 return ret;
1802}
1803
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804/*
1805 * Return TRUE if "p" starts with "<SID>" or "s:".
1806 * Only works if eval_fname_script() returned non-zero for "p"!
1807 */
1808 static int
1809eval_fname_sid(char_u *p)
1810{
1811 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1812}
1813
1814/*
1815 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1816 * Change <SNR>123_name() to K_SNR 123_name().
1817 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1818 * (slow).
1819 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001820 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1822{
1823 int llen;
1824 char_u *fname;
1825 int i;
1826
1827 llen = eval_fname_script(name);
1828 if (llen > 0)
1829 {
1830 fname_buf[0] = K_SPECIAL;
1831 fname_buf[1] = KS_EXTRA;
1832 fname_buf[2] = (int)KE_SNR;
1833 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001834 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001835 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001836 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001837 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 else
1839 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001840 sprintf((char *)fname_buf + 3, "%ld_",
1841 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001842 i = (int)STRLEN(fname_buf);
1843 }
1844 }
1845 if (i + STRLEN(name + llen) < FLEN_FIXED)
1846 {
1847 STRCPY(fname_buf + i, name + llen);
1848 fname = fname_buf;
1849 }
1850 else
1851 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001852 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001854 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 else
1856 {
1857 *tofree = fname;
1858 mch_memmove(fname, fname_buf, (size_t)i);
1859 STRCPY(fname + i, name + llen);
1860 }
1861 }
1862 }
1863 else
1864 fname = name;
1865 return fname;
1866}
1867
1868/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001869 * Find a function "name" in script "sid".
1870 */
1871 static ufunc_T *
1872find_func_with_sid(char_u *name, int sid)
1873{
1874 hashitem_T *hi;
1875 char_u buffer[200];
1876
1877 buffer[0] = K_SPECIAL;
1878 buffer[1] = KS_EXTRA;
1879 buffer[2] = (int)KE_SNR;
1880 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1881 (long)sid, name);
1882 hi = hash_find(&func_hashtab, buffer);
1883 if (!HASHITEM_EMPTY(hi))
1884 return HI2UF(hi);
1885
1886 return NULL;
1887}
1888
1889/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001891 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001892 * Return NULL for unknown function.
1893 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001894 ufunc_T *
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001895find_func_even_dead(char_u *name, int is_global, cctx_T *cctx UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896{
1897 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001898 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001899
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001900 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001901 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001902 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1903 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001904
Bram Moolenaar95006e32020-08-29 17:47:08 +02001905 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001906 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001907 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001908 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1909 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001910 if (func != NULL)
1911 return func;
1912 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001913 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001914
Bram Moolenaara26b9702020-04-18 19:53:28 +02001915 hi = hash_find(&func_hashtab,
1916 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 if (!HASHITEM_EMPTY(hi))
1918 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001919
1920 return NULL;
1921}
1922
1923/*
1924 * Find a function by name, return pointer to it in ufuncs.
1925 * "cctx" is passed in a :def function to find imported functions.
1926 * Return NULL for unknown or dead function.
1927 */
1928 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001929find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001930{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001931 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001932
1933 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1934 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001935 return NULL;
1936}
1937
1938/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001939 * Return TRUE if "ufunc" is a global function.
1940 */
1941 int
1942func_is_global(ufunc_T *ufunc)
1943{
1944 return ufunc->uf_name[0] != K_SPECIAL;
1945}
1946
1947/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001948 * Copy the function name of "fp" to buffer "buf".
1949 * "buf" must be able to hold the function name plus three bytes.
1950 * Takes care of script-local function names.
1951 */
1952 static void
1953cat_func_name(char_u *buf, ufunc_T *fp)
1954{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001955 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956 {
1957 STRCPY(buf, "<SNR>");
1958 STRCAT(buf, fp->uf_name + 3);
1959 }
1960 else
1961 STRCPY(buf, fp->uf_name);
1962}
1963
1964/*
1965 * Add a number variable "name" to dict "dp" with value "nr".
1966 */
1967 static void
1968add_nr_var(
1969 dict_T *dp,
1970 dictitem_T *v,
1971 char *name,
1972 varnumber_T nr)
1973{
1974 STRCPY(v->di_key, name);
1975 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1976 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1977 v->di_tv.v_type = VAR_NUMBER;
1978 v->di_tv.v_lock = VAR_FIXED;
1979 v->di_tv.vval.v_number = nr;
1980}
1981
1982/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001983 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001984 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001985 static void
1986free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001987{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001988 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001989
1990 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1991 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001992 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001993
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001994 // When garbage collecting a funccall_T may be freed before the
1995 // function that references it, clear its uf_scoped field.
1996 // The function may have been redefined and point to another
1997 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001998 if (fp != NULL && fp->uf_scoped == fc)
1999 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002000 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002001 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002002
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002003 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002004 vim_free(fc);
2005}
2006
2007/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002008 * Free "fc" and what it contains.
2009 * Can be called only when "fc" is kept beyond the period of it called,
2010 * i.e. after cleanup_function_call(fc).
2011 */
2012 static void
2013free_funccal_contents(funccall_T *fc)
2014{
2015 listitem_T *li;
2016
2017 // Free all l: variables.
2018 vars_clear(&fc->l_vars.dv_hashtab);
2019
2020 // Free all a: variables.
2021 vars_clear(&fc->l_avars.dv_hashtab);
2022
2023 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002024 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002025 clear_tv(&li->li_tv);
2026
2027 free_funccal(fc);
2028}
2029
2030/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002031 * Handle the last part of returning from a function: free the local hashtable.
2032 * Unless it is still in use by a closure.
2033 */
2034 static void
2035cleanup_function_call(funccall_T *fc)
2036{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002037 int may_free_fc = fc->fc_refcount <= 0;
2038 int free_fc = TRUE;
2039
Bram Moolenaar6914c642017-04-01 21:21:30 +02002040 current_funccal = fc->caller;
2041
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002042 // Free all l: variables if not referred.
2043 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2044 vars_clear(&fc->l_vars.dv_hashtab);
2045 else
2046 free_fc = FALSE;
2047
2048 // If the a:000 list and the l: and a: dicts are not referenced and
2049 // there is no closure using it, we can free the funccall_T and what's
2050 // in it.
2051 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2052 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002053 else
2054 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002055 int todo;
2056 hashitem_T *hi;
2057 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002058
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002059 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002060
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002061 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002062 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2063 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2064 {
2065 if (!HASHITEM_EMPTY(hi))
2066 {
2067 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002068 di = HI2DI(hi);
2069 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002070 }
2071 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002072 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002073
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002074 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2075 fc->l_varlist.lv_first = NULL;
2076 else
2077 {
2078 listitem_T *li;
2079
2080 free_fc = FALSE;
2081
2082 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002083 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002084 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002085 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002086
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002087 if (free_fc)
2088 free_funccal(fc);
2089 else
2090 {
2091 static int made_copy = 0;
2092
2093 // "fc" is still in use. This can happen when returning "a:000",
2094 // assigning "l:" to a global variable or defining a closure.
2095 // Link "fc" in the list for garbage collection later.
2096 fc->caller = previous_funccal;
2097 previous_funccal = fc;
2098
2099 if (want_garbage_collect)
2100 // If garbage collector is ready, clear count.
2101 made_copy = 0;
2102 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002103 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002104 // We have made a lot of copies, worth 4 Mbyte. This can happen
2105 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002106 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002107 // too much memory.
2108 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002109 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002110 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002111 }
2112}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002113
2114/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002115 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2116 */
2117 static int
2118numbered_function(char_u *name)
2119{
2120 return isdigit(*name)
2121 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2122}
2123
2124/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002125 * There are two kinds of function names:
2126 * 1. ordinary names, function defined with :function or :def
2127 * 2. numbered functions and lambdas
2128 * For the first we only count the name stored in func_hashtab as a reference,
2129 * using function() does not count as a reference, because the function is
2130 * looked up by name.
2131 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002132 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002133func_name_refcount(char_u *name)
2134{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002135 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002136}
2137
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002138/*
2139 * Unreference "fc": decrement the reference count and free it when it
2140 * becomes zero. "fp" is detached from "fc".
2141 * When "force" is TRUE we are exiting.
2142 */
2143 static void
2144funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2145{
2146 funccall_T **pfc;
2147 int i;
2148
2149 if (fc == NULL)
2150 return;
2151
2152 if (--fc->fc_refcount <= 0 && (force || (
2153 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2154 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2155 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2156 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2157 {
2158 if (fc == *pfc)
2159 {
2160 *pfc = fc->caller;
2161 free_funccal_contents(fc);
2162 return;
2163 }
2164 }
2165 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2166 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2167 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2168}
2169
2170/*
2171 * Remove the function from the function hashtable. If the function was
2172 * deleted while it still has references this was already done.
2173 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2174 */
2175 static int
2176func_remove(ufunc_T *fp)
2177{
2178 hashitem_T *hi;
2179
2180 // Return if it was already virtually deleted.
2181 if (fp->uf_flags & FC_DEAD)
2182 return FALSE;
2183
2184 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2185 if (!HASHITEM_EMPTY(hi))
2186 {
2187 // When there is a def-function index do not actually remove the
2188 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002189 // Do remove it when it's a copy.
2190 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002191 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002192 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002193 return FALSE;
2194 }
2195 hash_remove(&func_hashtab, hi);
2196 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002197 return TRUE;
2198 }
2199 return FALSE;
2200}
2201
2202 static void
2203func_clear_items(ufunc_T *fp)
2204{
2205 ga_clear_strings(&(fp->uf_args));
2206 ga_clear_strings(&(fp->uf_def_args));
2207 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002208 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002209 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002210 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002211 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002212
2213 // Increment the refcount of this function to avoid it being freed
2214 // recursively when the partial is freed.
2215 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002216 partial_unref(fp->uf_partial);
2217 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002218 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002219
2220#ifdef FEAT_LUA
2221 if (fp->uf_cb_free != NULL)
2222 {
2223 fp->uf_cb_free(fp->uf_cb_state);
2224 fp->uf_cb_free = NULL;
2225 }
2226
2227 fp->uf_cb_state = NULL;
2228 fp->uf_cb = NULL;
2229#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002230#ifdef FEAT_PROFILE
2231 VIM_CLEAR(fp->uf_tml_count);
2232 VIM_CLEAR(fp->uf_tml_total);
2233 VIM_CLEAR(fp->uf_tml_self);
2234#endif
2235}
2236
2237/*
2238 * Free all things that a function contains. Does not free the function
2239 * itself, use func_free() for that.
2240 * When "force" is TRUE we are exiting.
2241 */
2242 static void
2243func_clear(ufunc_T *fp, int force)
2244{
2245 if (fp->uf_cleared)
2246 return;
2247 fp->uf_cleared = TRUE;
2248
2249 // clear this function
2250 func_clear_items(fp);
2251 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002252 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002253}
2254
2255/*
2256 * Free a function and remove it from the list of functions. Does not free
2257 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002258 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002259 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002260 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002261 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002262func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002263{
2264 // Only remove it when not done already, otherwise we would remove a newer
2265 // version of the function with the same name.
2266 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2267 func_remove(fp);
2268
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002269 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002270 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002271 if (fp->uf_dfunc_idx > 0)
2272 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002273 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002274 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002275 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002276 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002277 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002278}
2279
2280/*
2281 * Free all things that a function contains and free the function itself.
2282 * When "force" is TRUE we are exiting.
2283 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002284 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002285func_clear_free(ufunc_T *fp, int force)
2286{
2287 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002288 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2289 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002290 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002291 else
2292 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293}
2294
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002295/*
2296 * Copy already defined function "lambda" to a new function with name "global".
2297 * This is for when a compiled function defines a global function.
2298 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002299 int
2300copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002301{
2302 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002303 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002304
2305 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002306 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002307 semsg(_(e_lambda_function_not_found_str), lambda);
2308 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002309 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002310
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002311 fp = find_func(global, TRUE, NULL);
2312 if (fp != NULL)
2313 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002314 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002315 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002316 return FAIL;
2317 }
2318
2319 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2320 if (fp == NULL)
2321 return FAIL;
2322
2323 fp->uf_varargs = ufunc->uf_varargs;
2324 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2325 fp->uf_def_status = ufunc->uf_def_status;
2326 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2327 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2328 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2329 == FAIL
2330 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2331 goto failed;
2332
2333 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2334 : vim_strsave(ufunc->uf_name_exp);
2335 if (ufunc->uf_arg_types != NULL)
2336 {
2337 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2338 if (fp->uf_arg_types == NULL)
2339 goto failed;
2340 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2341 sizeof(type_T *) * fp->uf_args.ga_len);
2342 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002343 if (ufunc->uf_va_name != NULL)
2344 {
2345 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2346 if (fp->uf_va_name == NULL)
2347 goto failed;
2348 }
2349 fp->uf_ret_type = ufunc->uf_ret_type;
2350
2351 fp->uf_refcount = 1;
2352 STRCPY(fp->uf_name, global);
2353 hash_add(&func_hashtab, UF2HIKEY(fp));
2354
2355 // the referenced dfunc_T is now used one more time
2356 link_def_function(fp);
2357
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002358 // Create a partial to store the context of the function where it was
2359 // instantiated. Only needs to be done once. Do this on the original
2360 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002361 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2362 {
2363 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2364
2365 if (pt == NULL)
2366 goto failed;
2367 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002368 {
2369 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002370 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002371 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002372 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002373 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002374 }
2375
2376 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002377
2378failed:
2379 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002380 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002381}
2382
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002383static int funcdepth = 0;
2384
2385/*
2386 * Increment the function call depth count.
2387 * Return FAIL when going over 'maxfuncdepth'.
2388 * Otherwise return OK, must call funcdepth_decrement() later!
2389 */
2390 int
2391funcdepth_increment(void)
2392{
2393 if (funcdepth >= p_mfd)
2394 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002395 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002396 return FAIL;
2397 }
2398 ++funcdepth;
2399 return OK;
2400}
2401
2402 void
2403funcdepth_decrement(void)
2404{
2405 --funcdepth;
2406}
2407
2408/*
2409 * Get the current function call depth.
2410 */
2411 int
2412funcdepth_get(void)
2413{
2414 return funcdepth;
2415}
2416
2417/*
2418 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002419 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002420 * times as funcdepth_increment().
2421 */
2422 void
2423funcdepth_restore(int depth)
2424{
2425 funcdepth = depth;
2426}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002427
2428/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002429 * Call a user function.
2430 */
2431 static void
2432call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002433 ufunc_T *fp, // pointer to function
2434 int argcount, // nr of args
2435 typval_T *argvars, // arguments
2436 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002437 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002438 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002440 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002441 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 funccall_T *fc;
2443 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002444 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002445 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002446 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 int i;
2448 int ai;
2449 int islambda = FALSE;
2450 char_u numbuf[NUMBUFLEN];
2451 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002452 typval_T *tv_to_free[MAX_FUNC_ARGS];
2453 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002455 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002456#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002457 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458
Bram Moolenaarb2049902021-01-24 12:53:53 +01002459#ifdef FEAT_PROFILE
2460 CLEAR_FIELD(profile_info);
2461#endif
2462
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002463 // If depth of calling is getting too high, don't execute the function.
2464 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002465 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 rettv->v_type = VAR_NUMBER;
2467 rettv->vval.v_number = -1;
2468 return;
2469 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470
Bram Moolenaare38eab22019-12-05 21:50:01 +01002471 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002473 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002474 if (fc == NULL)
2475 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476 fc->caller = current_funccal;
2477 current_funccal = fc;
2478 fc->func = fp;
2479 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002481 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002482 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2483 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002484 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002485 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002486 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002488 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002489 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002490#ifdef FEAT_PROFILE
2491 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2492#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002493 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002494#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002495 if (do_profiling == PROF_YES)
2496 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002497#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002498 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002499 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002500#ifdef FEAT_PROFILE
2501 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002502 || (caller != NULL && caller->uf_profiling)))
2503 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002504#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002505 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002506 free_funccal(fc);
2507 return;
2508 }
2509
Bram Moolenaar38453522021-11-28 22:00:12 +00002510 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511
2512 /*
2513 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2514 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2515 * each argument variable and saves a lot of time.
2516 */
2517 /*
2518 * Init l: variables.
2519 */
2520 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2521 if (selfdict != NULL)
2522 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002523 // Set l:self to "selfdict". Use "name" to avoid a warning from
2524 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 v = &fc->fixvar[fixvar_idx++].var;
2526 name = v->di_key;
2527 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002528 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2530 v->di_tv.v_type = VAR_DICT;
2531 v->di_tv.v_lock = 0;
2532 v->di_tv.vval.v_dict = selfdict;
2533 ++selfdict->dv_refcount;
2534 }
2535
2536 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002537 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002538 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 * Set a:000 to a list with room for the "..." arguments.
2540 */
2541 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002542 if ((fp->uf_flags & FC_NOARGS) == 0)
2543 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002544 (varnumber_T)(argcount >= fp->uf_args.ga_len
2545 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002546 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002547 if ((fp->uf_flags & FC_NOARGS) == 0)
2548 {
2549 // Use "name" to avoid a warning from some compiler that checks the
2550 // destination size.
2551 v = &fc->fixvar[fixvar_idx++].var;
2552 name = v->di_key;
2553 STRCPY(name, "000");
2554 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2555 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2556 v->di_tv.v_type = VAR_LIST;
2557 v->di_tv.v_lock = VAR_FIXED;
2558 v->di_tv.vval.v_list = &fc->l_varlist;
2559 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002560 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2562 fc->l_varlist.lv_lock = VAR_FIXED;
2563
2564 /*
2565 * Set a:firstline to "firstline" and a:lastline to "lastline".
2566 * Set a:name to named arguments.
2567 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002568 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002570 if ((fp->uf_flags & FC_NOARGS) == 0)
2571 {
2572 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002573 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002574 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002575 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002576 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002577 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 {
2579 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002580 typval_T def_rettv;
2581 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582
2583 ai = i - fp->uf_args.ga_len;
2584 if (ai < 0)
2585 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002586 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 name = FUNCARG(fp, i);
2588 if (islambda)
2589 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002590
2591 // evaluate named argument default expression
2592 isdefault = ai + fp->uf_def_args.ga_len >= 0
2593 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2594 && argvars[i].vval.v_number == VVAL_NONE));
2595 if (isdefault)
2596 {
2597 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002598
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002599 def_rettv.v_type = VAR_NUMBER;
2600 def_rettv.vval.v_number = -1;
2601
2602 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2603 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002604 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002605 {
2606 default_arg_err = 1;
2607 break;
2608 }
2609 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 }
2611 else
2612 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002613 if ((fp->uf_flags & FC_NOARGS) != 0)
2614 // Bail out if no a: arguments used (in lambda).
2615 break;
2616
Bram Moolenaare38eab22019-12-05 21:50:01 +01002617 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 sprintf((char *)numbuf, "%d", ai + 1);
2619 name = numbuf;
2620 }
2621 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2622 {
2623 v = &fc->fixvar[fixvar_idx++].var;
2624 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002625 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 }
2627 else
2628 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002629 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 if (v == NULL)
2631 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002632 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002635 // Note: the values are copied directly to avoid alloc/free.
2636 // "argvars" must have VAR_FIXED for v_lock.
2637 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 v->di_tv.v_lock = VAR_FIXED;
2639
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002640 if (isdefault)
2641 // Need to free this later, no matter where it's stored.
2642 tv_to_free[tv_to_free_len++] = &v->di_tv;
2643
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 if (addlocal)
2645 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 // Named arguments should be accessed without the "a:" prefix in
2647 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002648 copy_tv(&v->di_tv, &v->di_tv);
2649 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002651 else
2652 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653
2654 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2655 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002656 listitem_T *li = &fc->l_listitems[ai];
2657
2658 li->li_tv = argvars[i];
2659 li->li_tv.v_lock = VAR_FIXED;
2660 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 }
2662 }
2663
Bram Moolenaare38eab22019-12-05 21:50:01 +01002664 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002666
2667 if (fp->uf_flags & FC_SANDBOX)
2668 {
2669 using_sandbox = TRUE;
2670 ++sandbox;
2671 }
2672
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002673 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002674 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002675 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002677 ++no_wait_return;
2678 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002680 smsg(_("calling %s"), SOURCING_NAME);
2681 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002683 char_u buf[MSG_BUF_LEN];
2684 char_u numbuf2[NUMBUFLEN];
2685 char_u *tofree;
2686 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002688 msg_puts("(");
2689 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002691 if (i > 0)
2692 msg_puts(", ");
2693 if (argvars[i].v_type == VAR_NUMBER)
2694 msg_outnum((long)argvars[i].vval.v_number);
2695 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002697 // Do not want errors such as E724 here.
2698 ++emsg_off;
2699 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2700 --emsg_off;
2701 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002703 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002705 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2706 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002708 msg_puts((char *)s);
2709 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 }
2711 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002713 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002715 msg_puts("\n"); // don't overwrite this either
2716
2717 verbose_leave_scroll();
2718 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 }
2720#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002721 if (do_profiling == PROF_YES)
2722 profile_may_start_func(&profile_info, fp,
2723 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724#endif
2725
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002726 save_current_sctx = current_sctx;
2727 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 save_did_emsg = did_emsg;
2729 did_emsg = FALSE;
2730
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002731 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2732 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002733 else if (islambda)
2734 {
2735 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2736
2737 // A Lambda always has the command "return {expr}". It is much faster
2738 // to evaluate {expr} directly.
2739 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002740 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002741 --ex_nesting_level;
2742 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002743 else
2744 // call do_cmdline() to execute the lines
2745 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2747
2748 --RedrawingDisabled;
2749
Bram Moolenaare38eab22019-12-05 21:50:01 +01002750 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2752 {
2753 clear_tv(rettv);
2754 rettv->v_type = VAR_NUMBER;
2755 rettv->vval.v_number = -1;
2756 }
2757
2758#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002759 if (do_profiling == PROF_YES)
2760 {
2761 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2762
2763 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2764 profile_may_end_func(&profile_info, fp, caller);
2765 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766#endif
2767
Bram Moolenaare38eab22019-12-05 21:50:01 +01002768 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 if (p_verbose >= 12)
2770 {
2771 ++no_wait_return;
2772 verbose_enter_scroll();
2773
2774 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002775 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002777 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 (long)fc->rettv->vval.v_number);
2779 else
2780 {
2781 char_u buf[MSG_BUF_LEN];
2782 char_u numbuf2[NUMBUFLEN];
2783 char_u *tofree;
2784 char_u *s;
2785
Bram Moolenaare38eab22019-12-05 21:50:01 +01002786 // The value may be very long. Skip the middle part, so that we
2787 // have some idea how it starts and ends. smsg() would always
2788 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789 ++emsg_off;
2790 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2791 --emsg_off;
2792 if (s != NULL)
2793 {
2794 if (vim_strsize(s) > MSG_BUF_CLEN)
2795 {
2796 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2797 s = buf;
2798 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002799 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 vim_free(tofree);
2801 }
2802 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002803 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804
2805 verbose_leave_scroll();
2806 --no_wait_return;
2807 }
2808
Bram Moolenaare31ee862020-01-07 20:59:34 +01002809 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002810 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002811 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812#ifdef FEAT_PROFILE
2813 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002814 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002816 if (using_sandbox)
2817 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002819 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 {
2821 ++no_wait_return;
2822 verbose_enter_scroll();
2823
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002824 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002825 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826
2827 verbose_leave_scroll();
2828 --no_wait_return;
2829 }
2830
2831 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002832 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002833 for (i = 0; i < tv_to_free_len; ++i)
2834 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002835 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836}
2837
2838/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002839 * Check the argument count for user function "fp".
2840 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2841 */
2842 int
2843check_user_func_argcount(ufunc_T *fp, int argcount)
2844{
2845 int regular_args = fp->uf_args.ga_len;
2846
2847 if (argcount < regular_args - fp->uf_def_args.ga_len)
2848 return FCERR_TOOFEW;
2849 else if (!has_varargs(fp) && argcount > regular_args)
2850 return FCERR_TOOMANY;
2851 return FCERR_UNKNOWN;
2852}
2853
2854/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002856 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002857 int
2858call_user_func_check(
2859 ufunc_T *fp,
2860 int argcount,
2861 typval_T *argvars,
2862 typval_T *rettv,
2863 funcexe_T *funcexe,
2864 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002865{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002866 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002867
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002868 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2869 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002870 error = check_user_func_argcount(fp, argcount);
2871 if (error != FCERR_UNKNOWN)
2872 return error;
2873 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002874 error = FCERR_DICT;
2875 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002876 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002877 int did_save_redo = FALSE;
2878 save_redo_T save_redo;
2879
2880 /*
2881 * Call the user function.
2882 * Save and restore search patterns, script variables and
2883 * redo buffer.
2884 */
2885 save_search_patterns();
2886 if (!ins_compl_active())
2887 {
2888 saveRedobuff(&save_redo);
2889 did_save_redo = TRUE;
2890 }
2891 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002892 call_user_func(fp, argcount, argvars, rettv, funcexe,
2893 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002894 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2895 // Function was unreferenced while being used, free it now.
2896 func_clear_free(fp, FALSE);
2897 if (did_save_redo)
2898 restoreRedobuff(&save_redo);
2899 restore_search_patterns();
2900 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002901 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002902 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002903}
2904
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002905static funccal_entry_T *funccal_stack = NULL;
2906
2907/*
2908 * Save the current function call pointer, and set it to NULL.
2909 * Used when executing autocommands and for ":source".
2910 */
2911 void
2912save_funccal(funccal_entry_T *entry)
2913{
2914 entry->top_funccal = current_funccal;
2915 entry->next = funccal_stack;
2916 funccal_stack = entry;
2917 current_funccal = NULL;
2918}
2919
2920 void
2921restore_funccal(void)
2922{
2923 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002924 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002925 else
2926 {
2927 current_funccal = funccal_stack->top_funccal;
2928 funccal_stack = funccal_stack->next;
2929 }
2930}
2931
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002932 funccall_T *
2933get_current_funccal(void)
2934{
2935 return current_funccal;
2936}
2937
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002938/*
2939 * Mark all functions of script "sid" as deleted.
2940 */
2941 void
2942delete_script_functions(int sid)
2943{
2944 hashitem_T *hi;
2945 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002946 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002947 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002948 size_t len;
2949
2950 buf[0] = K_SPECIAL;
2951 buf[1] = KS_EXTRA;
2952 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002953 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002954 len = STRLEN(buf);
2955
Bram Moolenaarce658352020-07-31 23:47:12 +02002956 while (todo > 0)
2957 {
2958 todo = func_hashtab.ht_used;
2959 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2960 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002961 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002962 fp = HI2UF(hi);
2963 if (STRNCMP(fp->uf_name, buf, len) == 0)
2964 {
2965 int changed = func_hashtab.ht_changed;
2966
2967 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002968
2969 if (fp->uf_calls > 0)
2970 {
2971 // Function is executing, don't free it but do remove
2972 // it from the hashtable.
2973 if (func_remove(fp))
2974 fp->uf_refcount--;
2975 }
2976 else
2977 {
2978 func_clear(fp, TRUE);
2979 // When clearing a function another function can be
2980 // cleared as a side effect. When that happens start
2981 // over.
2982 if (changed != func_hashtab.ht_changed)
2983 break;
2984 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002985 }
2986 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002987 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002988 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002989}
2990
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991#if defined(EXITFREE) || defined(PROTO)
2992 void
2993free_all_functions(void)
2994{
2995 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002996 ufunc_T *fp;
2997 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002998 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002999 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000
Bram Moolenaare38eab22019-12-05 21:50:01 +01003001 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003002 while (current_funccal != NULL)
3003 {
3004 clear_tv(current_funccal->rettv);
3005 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003006 if (current_funccal == NULL && funccal_stack != NULL)
3007 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003008 }
3009
Bram Moolenaare38eab22019-12-05 21:50:01 +01003010 // First clear what the functions contain. Since this may lower the
3011 // reference count of a function, it may also free a function and change
3012 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003013 while (todo > 0)
3014 {
3015 todo = func_hashtab.ht_used;
3016 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3017 if (!HASHITEM_EMPTY(hi))
3018 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003019 // clear the def function index now
3020 fp = HI2UF(hi);
3021 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003022 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023
Bram Moolenaare38eab22019-12-05 21:50:01 +01003024 // Only free functions that are not refcounted, those are
3025 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003026 if (func_name_refcount(fp->uf_name))
3027 ++skipped;
3028 else
3029 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003030 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003031 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003032 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003033 {
3034 skipped = 0;
3035 break;
3036 }
3037 }
3038 --todo;
3039 }
3040 }
3041
Bram Moolenaare38eab22019-12-05 21:50:01 +01003042 // Now actually free the functions. Need to start all over every time,
3043 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003044 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003045 while (func_hashtab.ht_used > skipped)
3046 {
3047 todo = func_hashtab.ht_used;
3048 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 if (!HASHITEM_EMPTY(hi))
3050 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003051 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003052 // Only free functions that are not refcounted, those are
3053 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003054 fp = HI2UF(hi);
3055 if (func_name_refcount(fp->uf_name))
3056 ++skipped;
3057 else
3058 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003059 if (func_free(fp, FALSE) == OK)
3060 {
3061 skipped = 0;
3062 break;
3063 }
3064 // did not actually free it
3065 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003066 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003067 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003068 }
3069 if (skipped == 0)
3070 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071
3072 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073}
3074#endif
3075
3076/*
3077 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003078 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003079 * "len" is the length of "name", or -1 for NUL terminated.
3080 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003081 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003082builtin_function(char_u *name, int len)
3083{
3084 char_u *p;
3085
Bram Moolenaara26b9702020-04-18 19:53:28 +02003086 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 return FALSE;
3088 p = vim_strchr(name, AUTOLOAD_CHAR);
3089 return p == NULL || (len > 0 && p > name + len);
3090}
3091
3092 int
3093func_call(
3094 char_u *name,
3095 typval_T *args,
3096 partial_T *partial,
3097 dict_T *selfdict,
3098 typval_T *rettv)
3099{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003100 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 listitem_T *item;
3102 typval_T argv[MAX_FUNC_ARGS + 1];
3103 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003104 int r = 0;
3105
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003106 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003107 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 {
3109 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3110 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003111 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 break;
3113 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003114 // Make a copy of each argument. This is needed to be able to set
3115 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 copy_tv(&item->li_tv, &argv[argc++]);
3117 }
3118
3119 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003120 {
3121 funcexe_T funcexe;
3122
Bram Moolenaara80faa82020-04-12 19:37:17 +02003123 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003124 funcexe.fe_firstline = curwin->w_cursor.lnum;
3125 funcexe.fe_lastline = curwin->w_cursor.lnum;
3126 funcexe.fe_evaluate = TRUE;
3127 funcexe.fe_partial = partial;
3128 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003129 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3130 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131
Bram Moolenaare38eab22019-12-05 21:50:01 +01003132 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133 while (argc > 0)
3134 clear_tv(&argv[--argc]);
3135
3136 return r;
3137}
3138
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003139static int callback_depth = 0;
3140
3141 int
3142get_callback_depth(void)
3143{
3144 return callback_depth;
3145}
3146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003148 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003149 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003150 */
3151 int
3152call_callback(
3153 callback_T *callback,
3154 int len, // length of "name" or -1 to use strlen()
3155 typval_T *rettv, // return value goes here
3156 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003157 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003158 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003159{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003160 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003161 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003162
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003163 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3164 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003165 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003166 funcexe.fe_evaluate = TRUE;
3167 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003168 ++callback_depth;
3169 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3170 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003171
3172 // When a :def function was called that uses :try an error would be turned
3173 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003174 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003175 {
3176 need_rethrow = FALSE;
3177 handle_did_throw();
3178 }
3179
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003180 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003181}
3182
3183/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003184 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003185 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003186 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3187 */
3188 varnumber_T
3189call_callback_retnr(
3190 callback_T *callback,
3191 int argcount, // number of "argvars"
3192 typval_T *argvars) // vars for arguments, must have "argcount"
3193 // PLUS ONE elements!
3194{
3195 typval_T rettv;
3196 varnumber_T retval;
3197
3198 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003199 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003200
3201 retval = tv_get_number_chk(&rettv, NULL);
3202 clear_tv(&rettv);
3203 return retval;
3204}
3205
3206/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003207 * Give an error message for the result of a function.
3208 * Nothing if "error" is FCERR_NONE.
3209 */
3210 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003211user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003212{
3213 switch (error)
3214 {
3215 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003216 if (funcexe->fe_found_var)
3217 semsg(_(e_not_callable_type_str), name);
3218 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003219 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003220 break;
3221 case FCERR_NOTMETHOD:
3222 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003223 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003224 break;
3225 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003226 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003227 break;
3228 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003229 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003230 break;
3231 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003232 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003233 break;
3234 case FCERR_SCRIPT:
3235 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003236 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003237 break;
3238 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003239 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3240 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003241 break;
3242 }
3243}
3244
3245/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003246 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003247 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 * Return FAIL when the function can't be called, OK otherwise.
3249 * Also returns OK when an error was encountered while executing the function.
3250 */
3251 int
3252call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003253 char_u *funcname, // name of the function
3254 int len, // length of "name" or -1 to use strlen()
3255 typval_T *rettv, // return value goes here
3256 int argcount_in, // number of "argvars"
3257 typval_T *argvars_in, // vars for arguments, must have "argcount"
3258 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003259 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003260{
3261 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003262 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003264 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 char_u fname_buf[FLEN_FIXED + 1];
3266 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003267 char_u *fname = NULL;
3268 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 int argcount = argcount_in;
3270 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003271 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003272 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003273 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003275 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003276 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003277 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003278 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003279
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003280 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3281 // even when call_func() returns FAIL.
3282 rettv->v_type = VAR_UNKNOWN;
3283
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003284 if (partial != NULL)
3285 fp = partial->pt_func;
3286 if (fp == NULL)
3287 {
3288 // Make a copy of the name, if it comes from a funcref variable it
3289 // could be changed or deleted in the called function.
3290 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3291 if (name == NULL)
3292 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003293
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003294 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3295 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003297 if (funcexe->fe_doesrange != NULL)
3298 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299
3300 if (partial != NULL)
3301 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003302 // When the function has a partial with a dict and there is a dict
3303 // argument, use the dict argument. That is backwards compatible.
3304 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003305 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003307 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003308 {
3309 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003310 {
3311 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3312 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003313 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003314 goto theend;
3315 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003317 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318 for (i = 0; i < argcount_in; ++i)
3319 argv[i + argv_clear] = argvars_in[i];
3320 argvars = argv;
3321 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003322
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003323 if (funcexe->fe_check_type != NULL
3324 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003325 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003326 // Now funcexe->fe_check_type is missing the added arguments,
3327 // make a copy of the type with the correction.
3328 check_type = *funcexe->fe_check_type;
3329 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003330 check_type.tt_args = check_type_args;
3331 CLEAR_FIELD(check_type_args);
3332 for (i = 0; i < check_type.tt_argcount; ++i)
3333 check_type_args[i + partial->pt_argc] =
3334 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003335 check_type.tt_argcount += partial->pt_argc;
3336 check_type.tt_min_argcount += partial->pt_argc;
3337 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338 }
3339 }
3340
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003341 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3342 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003343 {
3344 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003345 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003346 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003347 error = FCERR_OTHER;
3348 }
3349
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003350 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 {
3352 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003353 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
Bram Moolenaar333894b2020-08-01 18:53:07 +02003355 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003356 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003357 {
3358 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003360 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003361
Bram Moolenaare38eab22019-12-05 21:50:01 +01003362 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003364 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003366 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003367 {
3368 /*
3369 * User defined function.
3370 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003371 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003372 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373
Bram Moolenaare38eab22019-12-05 21:50:01 +01003374 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 if (fp == NULL
3376 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003377 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 && !aborting())
3379 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003380 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003381 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003383 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3385 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003386 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003387 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003389 if (fp == NULL)
3390 {
3391 char_u *p = untrans_function_name(rfname);
3392
3393 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003394 // Don't do this if the name starts with "s:".
3395 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003396 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003399 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003400 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003401#ifdef FEAT_LUA
3402 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3403 {
3404 cfunc_T cb = fp->uf_cb;
3405
3406 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3407 }
3408#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003409 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003411 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003412 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003413 argcount = funcexe->fe_argv_func(argcount, argvars,
3414 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003415
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003416 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003417 {
3418 // Method call: base->Method()
3419 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003420 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003421 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003422 argvars = argv;
3423 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003424 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003425
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003426 error = call_user_func_check(fp, argcount, argvars, rettv,
3427 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 }
3429 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003430 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003431 {
3432 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003433 * expr->method(): Find the method name in the table, call its
3434 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003435 */
3436 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003437 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003438 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 else
3440 {
3441 /*
3442 * Find the function name in the table, call its implementation.
3443 */
3444 error = call_internal_func(fname, argcount, argvars, rettv);
3445 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003446
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 /*
3448 * The function call (or "FuncUndefined" autocommand sequence) might
3449 * have been aborted by an error, an interrupt, or an explicitly thrown
3450 * exception that has not been caught so far. This situation can be
3451 * tested for by calling aborting(). For an error in an internal
3452 * function or for the "E132" error in call_user_func(), however, the
3453 * throw point at which the "force_abort" flag (temporarily reset by
3454 * emsg()) is normally updated has not been reached yet. We need to
3455 * update that flag first to make aborting() reliable.
3456 */
3457 update_force_abort();
3458 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003459 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 ret = OK;
3461
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003462theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 /*
3464 * Report an error unless the argument evaluation or function call has been
3465 * cancelled due to an aborting error, an interrupt, or an exception.
3466 */
3467 if (!aborting())
3468 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003469 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470 }
3471
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003472 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003474 clear_tv(&argv[--argv_clear + argv_base]);
3475
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476 vim_free(tofree);
3477 vim_free(name);
3478
3479 return ret;
3480}
3481
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003482 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003483printable_func_name(ufunc_T *fp)
3484{
3485 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3486}
3487
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003488/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003489 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490 */
3491 static void
3492list_func_head(ufunc_T *fp, int indent)
3493{
3494 int j;
3495
3496 msg_start();
3497 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003498 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003499 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003500 msg_puts("def ");
3501 else
3502 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003503 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 msg_putchar('(');
3505 for (j = 0; j < fp->uf_args.ga_len; ++j)
3506 {
3507 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003508 msg_puts(", ");
3509 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003510 if (fp->uf_arg_types != NULL)
3511 {
3512 char *tofree;
3513
3514 msg_puts(": ");
3515 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3516 vim_free(tofree);
3517 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003518 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3519 {
3520 msg_puts(" = ");
3521 msg_puts(((char **)(fp->uf_def_args.ga_data))
3522 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3523 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003524 }
3525 if (fp->uf_varargs)
3526 {
3527 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003528 msg_puts(", ");
3529 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003531 if (fp->uf_va_name != NULL)
3532 {
3533 if (j)
3534 msg_puts(", ");
3535 msg_puts("...");
3536 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003537 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003538 {
3539 char *tofree;
3540
3541 msg_puts(": ");
3542 msg_puts(type_name(fp->uf_va_type, &tofree));
3543 vim_free(tofree);
3544 }
3545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003547
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003548 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003549 {
3550 if (fp->uf_ret_type != &t_void)
3551 {
3552 char *tofree;
3553
3554 msg_puts(": ");
3555 msg_puts(type_name(fp->uf_ret_type, &tofree));
3556 vim_free(tofree);
3557 }
3558 }
3559 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003560 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003562 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003564 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003565 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003566 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 msg_clr_eos();
3568 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003569 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570}
3571
3572/*
3573 * Get a function name, translating "<SID>" and "<SNR>".
3574 * Also handles a Funcref in a List or Dictionary.
3575 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003576 * Set "*is_global" to TRUE when the function must be global, unless
3577 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 * flags:
3579 * TFN_INT: internal function name OK
3580 * TFN_QUIET: be quiet
3581 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003582 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 * Advances "pp" to just after the function name (if no error).
3584 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003585 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586trans_function_name(
3587 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003588 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003589 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003591 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003592 partial_T **partial, // return: partial of a FuncRef
3593 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594{
3595 char_u *name = NULL;
3596 char_u *start;
3597 char_u *end;
3598 int lead;
3599 char_u sid_buf[20];
3600 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003601 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003603 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604
3605 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003606 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 start = *pp;
3608
Bram Moolenaare38eab22019-12-05 21:50:01 +01003609 // Check for hard coded <SNR>: already translated function ID (from a user
3610 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3612 && (*pp)[2] == (int)KE_SNR)
3613 {
3614 *pp += 3;
3615 len = get_id_len(pp) + 3;
3616 return vim_strnsave(start, len);
3617 }
3618
Bram Moolenaare38eab22019-12-05 21:50:01 +01003619 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3620 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 lead = eval_fname_script(start);
3622 if (lead > 2)
3623 start += lead;
3624
Bram Moolenaare38eab22019-12-05 21:50:01 +01003625 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003626 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 lead > 2 ? 0 : FNE_CHECK_START);
3628 if (end == start)
3629 {
3630 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003631 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003632 goto theend;
3633 }
3634 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3635 {
3636 /*
3637 * Report an invalid expression in braces, unless the expression
3638 * evaluation has been cancelled due to an aborting error, an
3639 * interrupt, or an exception.
3640 */
3641 if (!aborting())
3642 {
3643 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003644 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645 }
3646 else
3647 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3648 goto theend;
3649 }
3650
3651 if (lv.ll_tv != NULL)
3652 {
3653 if (fdp != NULL)
3654 {
3655 fdp->fd_dict = lv.ll_dict;
3656 fdp->fd_newkey = lv.ll_newkey;
3657 lv.ll_newkey = NULL;
3658 fdp->fd_di = lv.ll_di;
3659 }
3660 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3661 {
3662 name = vim_strsave(lv.ll_tv->vval.v_string);
3663 *pp = end;
3664 }
3665 else if (lv.ll_tv->v_type == VAR_PARTIAL
3666 && lv.ll_tv->vval.v_partial != NULL)
3667 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003668 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 *pp = end;
3670 if (partial != NULL)
3671 *partial = lv.ll_tv->vval.v_partial;
3672 }
3673 else
3674 {
3675 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3676 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003677 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 else
3679 *pp = end;
3680 name = NULL;
3681 }
3682 goto theend;
3683 }
3684
3685 if (lv.ll_name == NULL)
3686 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003687 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 *pp = end;
3689 goto theend;
3690 }
3691
Bram Moolenaare38eab22019-12-05 21:50:01 +01003692 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 if (lv.ll_exp_name != NULL)
3694 {
3695 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003696 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003697 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 if (name == lv.ll_exp_name)
3699 name = NULL;
3700 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003701 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702 {
3703 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003704 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003705 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003706 if (name == *pp)
3707 name = NULL;
3708 }
3709 if (name != NULL)
3710 {
3711 name = vim_strsave(name);
3712 *pp = end;
3713 if (STRNCMP(name, "<SNR>", 5) == 0)
3714 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003715 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003716 name[0] = K_SPECIAL;
3717 name[1] = KS_EXTRA;
3718 name[2] = (int)KE_SNR;
3719 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3720 }
3721 goto theend;
3722 }
3723
3724 if (lv.ll_exp_name != NULL)
3725 {
3726 len = (int)STRLEN(lv.ll_exp_name);
3727 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3728 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3729 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003730 // When there was "s:" already or the name expanded to get a
3731 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732 lv.ll_name += 2;
3733 len -= 2;
3734 lead = 2;
3735 }
3736 }
3737 else
3738 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003739 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003740 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003741 {
3742 if (is_global != NULL && lv.ll_name[0] == 'g')
3743 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003745 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003746 len = (int)(end - lv.ll_name);
3747 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003748 if (len <= 0)
3749 {
3750 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003751 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003752 goto theend;
3753 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003755 // In Vim9 script a user function is script-local by default, unless it
3756 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003757 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003758 if (vim9script)
3759 {
3760 char_u *p;
3761
3762 // SomeScript#func() is a global function.
3763 for (p = start; *p != NUL && *p != '('; ++p)
3764 if (*p == AUTOLOAD_CHAR)
3765 vim9script = FALSE;
3766 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003767
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768 /*
3769 * Copy the function name to allocated memory.
3770 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3771 * Accept <SNR>123_name() outside a script.
3772 */
3773 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003774 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003775 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003777 if (!vim9script)
3778 lead = 3;
3779 if (vim9script || (lv.ll_exp_name != NULL
3780 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 || eval_fname_sid(*pp))
3782 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003783 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003784 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003786 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 goto theend;
3788 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003789 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003790 if (vim9script)
3791 extra = 3 + (int)STRLEN(sid_buf);
3792 else
3793 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 }
3795 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003796 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3797 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003799 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 goto theend;
3801 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003802 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803 {
3804 char_u *cp = vim_strchr(lv.ll_name, ':');
3805
3806 if (cp != NULL && cp < end)
3807 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003808 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 goto theend;
3810 }
3811 }
3812
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003813 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 if (name != NULL)
3815 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003816 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 {
3818 name[0] = K_SPECIAL;
3819 name[1] = KS_EXTRA;
3820 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003821 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 STRCPY(name + 3, sid_buf);
3823 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003824 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3825 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826 }
3827 *pp = end;
3828
3829theend:
3830 clear_lval(&lv);
3831 return name;
3832}
3833
3834/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003835 * Assuming "name" is the result of trans_function_name() and it was prefixed
3836 * to use the script-local name, return the unmodified name (points into
3837 * "name"). Otherwise return NULL.
3838 * This can be used to first search for a script-local function and fall back
3839 * to the global function if not found.
3840 */
3841 char_u *
3842untrans_function_name(char_u *name)
3843{
3844 char_u *p;
3845
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003846 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003847 {
3848 p = vim_strchr(name, '_');
3849 if (p != NULL)
3850 return p + 1;
3851 }
3852 return NULL;
3853}
3854
3855/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003856 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3857 * current script ID and returns the expanded function name. The caller should
3858 * free the returned name. If not called from a script context or the function
3859 * name doesn't start with these prefixes, then returns NULL.
3860 * This doesn't check whether the script-local function exists or not.
3861 */
3862 char_u *
3863get_scriptlocal_funcname(char_u *funcname)
3864{
3865 char sid_buf[25];
3866 int off;
3867 char_u *newname;
3868
3869 if (funcname == NULL)
3870 return NULL;
3871
3872 if (STRNCMP(funcname, "s:", 2) != 0
3873 && STRNCMP(funcname, "<SID>", 5) != 0)
3874 // The function name is not a script-local function name
3875 return NULL;
3876
3877 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3878 {
3879 emsg(_(e_using_sid_not_in_script_context));
3880 return NULL;
3881 }
3882 // Expand s: prefix into <SNR>nr_<name>
3883 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3884 (long)current_sctx.sc_sid);
3885 off = *funcname == 's' ? 2 : 5;
3886 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3887 if (newname == NULL)
3888 return NULL;
3889 STRCPY(newname, sid_buf);
3890 STRCAT(newname, funcname + off);
3891
3892 return newname;
3893}
3894
3895/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003896 * Call trans_function_name(), except that a lambda is returned as-is.
3897 * Returns the name in allocated memory.
3898 */
3899 char_u *
3900save_function_name(
3901 char_u **name,
3902 int *is_global,
3903 int skip,
3904 int flags,
3905 funcdict_T *fudi)
3906{
3907 char_u *p = *name;
3908 char_u *saved;
3909
3910 if (STRNCMP(p, "<lambda>", 8) == 0)
3911 {
3912 p += 8;
3913 (void)getdigits(&p);
3914 saved = vim_strnsave(*name, p - *name);
3915 if (fudi != NULL)
3916 CLEAR_POINTER(fudi);
3917 }
3918 else
3919 saved = trans_function_name(&p, is_global, skip,
3920 flags, fudi, NULL, NULL);
3921 *name = p;
3922 return saved;
3923}
3924
3925/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003926 * List functions. When "regmatch" is NULL all of then.
3927 * Otherwise functions matching "regmatch".
3928 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003929 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003930list_functions(regmatch_T *regmatch)
3931{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003932 int changed = func_hashtab.ht_changed;
3933 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003934 hashitem_T *hi;
3935
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003936 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003937 {
3938 if (!HASHITEM_EMPTY(hi))
3939 {
3940 ufunc_T *fp = HI2UF(hi);
3941
3942 --todo;
3943 if ((fp->uf_flags & FC_DEAD) == 0
3944 && (regmatch == NULL
3945 ? !message_filtered(fp->uf_name)
3946 && !func_name_refcount(fp->uf_name)
3947 : !isdigit(*fp->uf_name)
3948 && vim_regexec(regmatch, fp->uf_name, 0)))
3949 {
3950 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003951 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003952 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00003953 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003954 return;
3955 }
3956 }
3957 }
3958 }
3959}
3960
3961/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003962 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003963 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3964 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003965 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003966 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003967 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003968 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003969define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 int j;
3972 int c;
3973 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003974 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003975 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976 char_u *p;
3977 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003978 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979 char_u *line_arg = NULL;
3980 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003981 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003982 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 garray_T newlines;
3984 int varargs = FALSE;
3985 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003986 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003987 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00003988 int fp_allocated = FALSE;
3989 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003990 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991 dictitem_T *v;
3992 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003993 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003996 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003997 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003998 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999
4000 /*
4001 * ":function" without argument: list functions.
4002 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004003 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 {
4005 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004006 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004007 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004008 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004009 }
4010
4011 /*
4012 * ":function /pat": list functions matching pattern.
4013 */
4014 if (*eap->arg == '/')
4015 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004016 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 if (!eap->skip)
4018 {
4019 regmatch_T regmatch;
4020
4021 c = *p;
4022 *p = NUL;
4023 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4024 *p = c;
4025 if (regmatch.regprog != NULL)
4026 {
4027 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004028 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 vim_regfree(regmatch.regprog);
4030 }
4031 }
4032 if (*p == '/')
4033 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004034 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004035 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 }
4037
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004038 ga_init(&newargs);
4039 ga_init(&argtypes);
4040 ga_init(&default_args);
4041
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 /*
4043 * Get the function name. There are these situations:
4044 * func normal function name
4045 * "name" == func, "fudi.fd_dict" == NULL
4046 * dict.func new dictionary entry
4047 * "name" == NULL, "fudi.fd_dict" set,
4048 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4049 * dict.func existing dict entry with a Funcref
4050 * "name" == func, "fudi.fd_dict" set,
4051 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4052 * dict.func existing dict entry that's not a Funcref
4053 * "name" == NULL, "fudi.fd_dict" set,
4054 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4055 * s:func script-local function name
4056 * g:func global function name, same as "func"
4057 */
4058 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004059 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004061 // nested function, argument is (args).
4062 paren = TRUE;
4063 CLEAR_FIELD(fudi);
4064 }
4065 else
4066 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004067 name = save_function_name(&p, &is_global, eap->skip,
4068 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004069 paren = (vim_strchr(p, '(') != NULL);
4070 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004072 /*
4073 * Return on an invalid expression in braces, unless the expression
4074 * evaluation has been cancelled due to an aborting error, an
4075 * interrupt, or an exception.
4076 */
4077 if (!aborting())
4078 {
4079 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004080 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004081 vim_free(fudi.fd_newkey);
4082 return NULL;
4083 }
4084 else
4085 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004087
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004088 // For "export def FuncName()" in an autoload script the function name
4089 // is stored with the legacy autoload name "dir#script#FuncName" so
4090 // that it can also be found in legacy script.
4091 if (is_export)
4092 name = may_prefix_autoload(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 }
4094
Bram Moolenaare38eab22019-12-05 21:50:01 +01004095 // An error in a function call during evaluation of an expression in magic
4096 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 saved_did_emsg = did_emsg;
4098 did_emsg = FALSE;
4099
4100 /*
4101 * ":function func" with only function name: list function.
4102 */
4103 if (!paren)
4104 {
4105 if (!ends_excmd(*skipwhite(p)))
4106 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004107 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 goto ret_free;
4109 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004110 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 if (eap->nextcmd != NULL)
4112 *p = NUL;
4113 if (!eap->skip && !got_int)
4114 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004115 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004116 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4117 {
4118 char_u *up = untrans_function_name(name);
4119
4120 // With Vim9 script the name was made script-local, if not
4121 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004122 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004123 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004124 }
4125
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004126 if (fp != NULL)
4127 {
4128 list_func_head(fp, TRUE);
4129 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4130 {
4131 if (FUNCLINE(fp, j) == NULL)
4132 continue;
4133 msg_putchar('\n');
4134 msg_outnum((long)(j + 1));
4135 if (j < 9)
4136 msg_putchar(' ');
4137 if (j < 99)
4138 msg_putchar(' ');
4139 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004140 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 ui_breakcheck();
4142 }
4143 if (!got_int)
4144 {
4145 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004146 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004147 msg_puts(" enddef");
4148 else
4149 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150 }
4151 }
4152 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004153 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 }
4155 goto ret_free;
4156 }
4157
4158 /*
4159 * ":function name(arg1, arg2)" Define function.
4160 */
4161 p = skipwhite(p);
4162 if (*p != '(')
4163 {
4164 if (!eap->skip)
4165 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004166 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 goto ret_free;
4168 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004169 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 if (vim_strchr(p, '(') != NULL)
4171 p = vim_strchr(p, '(');
4172 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004174 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4175 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004176 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004177 goto ret_free;
4178 }
4179
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004180 // In Vim9 script only global functions can be redefined.
4181 if (vim9script && eap->forceit && !is_global)
4182 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004183 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004184 goto ret_free;
4185 }
4186
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004187 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188
Bram Moolenaar04b12692020-05-04 23:24:44 +02004189 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004191 // Check the name of the function. Unless it's a dictionary function
4192 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 if (name != NULL)
4194 arg = name;
4195 else
4196 arg = fudi.fd_newkey;
4197 if (arg != NULL && (fudi.fd_di == NULL
4198 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4199 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4200 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004201 char_u *name_base = arg;
4202 int i;
4203
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004205 {
4206 name_base = vim_strchr(arg, '_');
4207 if (name_base == NULL)
4208 name_base = arg + 3;
4209 else
4210 ++name_base;
4211 }
4212 for (i = 0; name_base[i] != NUL && (i == 0
4213 ? eval_isnamec1(name_base[i])
4214 : eval_isnamec(name_base[i])); ++i)
4215 ;
4216 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004217 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004218
4219 // In Vim9 script a function cannot have the same name as a
4220 // variable.
4221 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004222 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4223 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004224 + EVAL_VAR_NO_FUNC) == OK)
4225 {
4226 semsg(_(e_redefining_script_item_str), name_base);
4227 goto ret_free;
4228 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004230 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004232 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004233 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004234 goto ret_free;
4235 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004236 }
4237
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004238 // This may get more lines and make the pointers into the first line
4239 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004240 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004241 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004242 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004243 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004244 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004245 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004246 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004248 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004249 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004250 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004251 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004253 if (*p != ':')
4254 {
4255 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4256 p = skipwhite(p);
4257 }
4258 else if (!IS_WHITE_OR_NUL(p[1]))
4259 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004260 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004261 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004262 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004263 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004264 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004265 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004266 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004267 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004268 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004269 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004270 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004271 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004272 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004274 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004276 else
4277 // find extra arguments "range", "dict", "abort" and "closure"
4278 for (;;)
4279 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004280 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004281 p = skipwhite(p);
4282 if (STRNCMP(p, "range", 5) == 0)
4283 {
4284 flags |= FC_RANGE;
4285 p += 5;
4286 }
4287 else if (STRNCMP(p, "dict", 4) == 0)
4288 {
4289 flags |= FC_DICT;
4290 p += 4;
4291 }
4292 else if (STRNCMP(p, "abort", 5) == 0)
4293 {
4294 flags |= FC_ABORT;
4295 p += 5;
4296 }
4297 else if (STRNCMP(p, "closure", 7) == 0)
4298 {
4299 flags |= FC_CLOSURE;
4300 p += 7;
4301 if (current_funccal == NULL)
4302 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004303 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004304 name == NULL ? (char_u *)"" : name);
4305 goto erret;
4306 }
4307 }
4308 else
4309 break;
4310 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311
Bram Moolenaare38eab22019-12-05 21:50:01 +01004312 // When there is a line break use what follows for the function body.
4313 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 if (*p == '\n')
4315 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004316 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004317 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4318 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004319 && !(VIM_ISWHITE(*whitep) && *p == '#'
4320 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004321 && !eap->skip
4322 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004323 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004324
4325 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004326 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4327 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328 */
4329 if (KeyTyped)
4330 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004331 // Check if the function already exists, don't let the user type the
4332 // whole function before telling him it doesn't work! For a script we
4333 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004334 if (!eap->skip && !eap->forceit)
4335 {
4336 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004337 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004338 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004339 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 }
4341
4342 if (!eap->skip && did_emsg)
4343 goto erret;
4344
Bram Moolenaare38eab22019-12-05 21:50:01 +01004345 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 cmdline_row = msg_row;
4347 }
4348
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004349 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004350 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004351
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004352 // Do not define the function when getting the body fails and when
4353 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004354 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004355 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004356 goto erret;
4357
4358 /*
4359 * If there are no errors, add the function
4360 */
4361 if (fudi.fd_dict == NULL)
4362 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004363 hashtab_T *ht;
4364
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004365 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4367 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004368 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004369 goto erret;
4370 }
4371
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004372 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004373 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004375 char_u *uname = untrans_function_name(name);
4376
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004377 import = find_imported(uname == NULL ? name : uname, 0, FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004378 }
4379
4380 if (fp != NULL || import != NULL)
4381 {
4382 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004383
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004384 // Function can be replaced with "function!" and when sourcing the
4385 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004386 // A name that is used by an import can not be overruled.
4387 if (import != NULL
4388 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004389 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004390 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004392 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004393 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004394 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004395 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004396 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397 goto erret;
4398 }
4399 if (fp->uf_calls > 0)
4400 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004401 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004402 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004403 goto erret;
4404 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004405 if (fp->uf_refcount > 1)
4406 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004407 // This function is referenced somewhere, don't redefine it but
4408 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004409 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004410 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004411 fp = NULL;
4412 overwrite = TRUE;
4413 }
4414 else
4415 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004416 char_u *exp_name = fp->uf_name_exp;
4417
4418 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004419 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004420 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004421 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004422 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004423 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004424#ifdef FEAT_PROFILE
4425 fp->uf_profiling = FALSE;
4426 fp->uf_prof_initialized = FALSE;
4427#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004428 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004429 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004430 }
4431 }
4432 else
4433 {
4434 char numbuf[20];
4435
4436 fp = NULL;
4437 if (fudi.fd_newkey == NULL && !eap->forceit)
4438 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004439 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 goto erret;
4441 }
4442 if (fudi.fd_di == NULL)
4443 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004444 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004445 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 goto erret;
4447 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004448 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004449 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 goto erret;
4451
Bram Moolenaare38eab22019-12-05 21:50:01 +01004452 // Give the function a sequential number. Can only be used with a
4453 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004454 vim_free(name);
4455 sprintf(numbuf, "%d", ++func_nr);
4456 name = vim_strsave((char_u *)numbuf);
4457 if (name == NULL)
4458 goto erret;
4459 }
4460
4461 if (fp == NULL)
4462 {
4463 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4464 {
4465 int slen, plen;
4466 char_u *scriptname;
4467
Bram Moolenaare38eab22019-12-05 21:50:01 +01004468 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004470 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 {
4472 scriptname = autoload_name(name);
4473 if (scriptname != NULL)
4474 {
4475 p = vim_strchr(scriptname, '/');
4476 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004477 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004479 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004480 j = OK;
4481 vim_free(scriptname);
4482 }
4483 }
4484 if (j == FAIL)
4485 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004486 linenr_T save_lnum = SOURCING_LNUM;
4487
4488 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004489 semsg(_(e_function_name_does_not_match_script_file_name_str),
4490 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004491 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004492 goto erret;
4493 }
4494 }
4495
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004496 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 if (fp == NULL)
4498 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004499 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500
4501 if (fudi.fd_dict != NULL)
4502 {
4503 if (fudi.fd_di == NULL)
4504 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004505 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4507 if (fudi.fd_di == NULL)
4508 {
4509 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004510 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 goto erret;
4512 }
4513 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4514 {
4515 vim_free(fudi.fd_di);
4516 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004517 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004518 goto erret;
4519 }
4520 }
4521 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004522 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 clear_tv(&fudi.fd_di->di_tv);
4524 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004526
Bram Moolenaare38eab22019-12-05 21:50:01 +01004527 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004528 flags |= FC_DICT;
4529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530 }
4531 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004532 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004533 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004534 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004535
4536 if (eap->cmdidx == CMD_def)
4537 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004538 int lnum_save = SOURCING_LNUM;
4539 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004540
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004541 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004542
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004543 // error messages are for the first function line
4544 SOURCING_LNUM = sourcing_lnum_top;
4545
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004546 // The function may use script variables from the context.
4547 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004548
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004549 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004550 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004551 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004552 free_fp = fp_allocated;
4553 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004554 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004555 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004556
4557 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004558 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004559 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004560 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004561 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004562 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004563 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004564 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004565 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004566 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004567 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004568
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004569 if (fp_allocated)
4570 {
4571 // insert the new function in the function list
4572 set_ufunc_name(fp, name);
4573 if (overwrite)
4574 {
4575 hi = hash_find(&func_hashtab, name);
4576 hi->hi_key = UF2HIKEY(fp);
4577 }
4578 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4579 {
4580 free_fp = TRUE;
4581 goto erret;
4582 }
4583 fp->uf_refcount = 1;
4584 }
4585
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004586 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004587 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004588 if ((flags & FC_CLOSURE) != 0)
4589 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004590 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004591 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004592 }
4593 else
4594 fp->uf_scoped = NULL;
4595
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004597 if (prof_def_func())
4598 func_do_profile(fp);
4599#endif
4600 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004601 if (sandbox)
4602 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004603 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004604 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004605 fp->uf_flags = flags;
4606 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004607 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004608 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004609 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004610 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004611 if (is_export)
4612 {
4613 fp->uf_flags |= FC_EXPORT;
4614 // let ex_export() know the export worked.
4615 is_export = FALSE;
4616 }
4617
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004618 if (eap->cmdidx == CMD_def)
4619 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004620 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4621 // :func does not use Vim9 script syntax, even in a Vim9 script file
4622 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004623
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004624 goto ret_free;
4625
4626erret:
4627 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004628 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004629 if (fp != NULL)
4630 {
4631 ga_init(&fp->uf_args);
4632 ga_init(&fp->uf_def_args);
4633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634errret_2:
4635 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004636 if (fp != NULL)
4637 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004638 if (free_fp)
4639 {
4640 vim_free(fp);
4641 fp = NULL;
4642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004643ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004644 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004646 if (name != name_arg)
4647 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004648 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004649 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004650
4651 return fp;
4652}
4653
4654/*
4655 * ":function"
4656 */
4657 void
4658ex_function(exarg_T *eap)
4659{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004660 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004661
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004662 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4663 (void)define_function(eap, NULL, &lines_to_free);
4664 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004665}
4666
4667/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004668 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004669 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004670 */
4671 void
4672ex_defcompile(exarg_T *eap UNUSED)
4673{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004674 long todo = (long)func_hashtab.ht_used;
4675 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004676 hashitem_T *hi;
4677 ufunc_T *ufunc;
4678
4679 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4680 {
4681 if (!HASHITEM_EMPTY(hi))
4682 {
4683 --todo;
4684 ufunc = HI2UF(hi);
4685 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004686 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4687 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004688 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004689 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004690
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004691 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004692 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004693 // a function has been added or removed, need to start over
4694 todo = (long)func_hashtab.ht_used;
4695 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004696 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004697 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004698 }
4699 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004700 }
4701 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702}
4703
4704/*
4705 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4706 * Return 2 if "p" starts with "s:".
4707 * Return 0 otherwise.
4708 */
4709 int
4710eval_fname_script(char_u *p)
4711{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004712 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4713 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004714 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4715 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4716 return 5;
4717 if (p[0] == 's' && p[1] == ':')
4718 return 2;
4719 return 0;
4720}
4721
4722 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004723translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724{
4725 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004726 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004727 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004728}
4729
4730/*
4731 * Return TRUE when "ufunc" has old-style "..." varargs
4732 * or named varargs "...name: type".
4733 */
4734 int
4735has_varargs(ufunc_T *ufunc)
4736{
4737 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738}
4739
4740/*
4741 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004742 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004743 */
4744 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004745function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746{
4747 char_u *nm = name;
4748 char_u *p;
4749 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004750 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004751 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004753 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4754 if (no_deref)
4755 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004756 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 nm = skipwhite(nm);
4758
Bram Moolenaare38eab22019-12-05 21:50:01 +01004759 // Only accept "funcname", "funcname ", "funcname (..." and
4760 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004762 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004763 vim_free(p);
4764 return n;
4765}
4766
Bram Moolenaar113e1072019-01-20 15:30:40 +01004767#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 char_u *
4769get_expanded_name(char_u *name, int check)
4770{
4771 char_u *nm = name;
4772 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004773 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004775 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004776 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004778 if (p != NULL && *nm == NUL
4779 && (!check || translated_function_exists(p, is_global)))
4780 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004781
4782 vim_free(p);
4783 return NULL;
4784}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004785#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004787/*
4788 * Function given to ExpandGeneric() to obtain the list of user defined
4789 * function names.
4790 */
4791 char_u *
4792get_user_func_name(expand_T *xp, int idx)
4793{
4794 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004795 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004796 static hashitem_T *hi;
4797 ufunc_T *fp;
4798
4799 if (idx == 0)
4800 {
4801 done = 0;
4802 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004803 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004805 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 {
4807 if (done++ > 0)
4808 ++hi;
4809 while (HASHITEM_EMPTY(hi))
4810 ++hi;
4811 fp = HI2UF(hi);
4812
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004813 // don't show dead, dict and lambda functions
4814 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004815 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004816 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004817
4818 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004819 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820
4821 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004822 if (xp->xp_context != EXPAND_USER_FUNC
4823 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824 {
4825 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004826 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 STRCAT(IObuff, ")");
4828 }
4829 return IObuff;
4830 }
4831 return NULL;
4832}
4833
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004834/*
4835 * ":delfunction {name}"
4836 */
4837 void
4838ex_delfunction(exarg_T *eap)
4839{
4840 ufunc_T *fp = NULL;
4841 char_u *p;
4842 char_u *name;
4843 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004844 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845
4846 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004847 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4848 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 vim_free(fudi.fd_newkey);
4850 if (name == NULL)
4851 {
4852 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004853 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004854 return;
4855 }
4856 if (!ends_excmd(*skipwhite(p)))
4857 {
4858 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00004859 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 return;
4861 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004862 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863 if (eap->nextcmd != NULL)
4864 *p = NUL;
4865
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004866 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004867 {
4868 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004869 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004870 vim_free(name);
4871 return;
4872 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004874 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875 vim_free(name);
4876
4877 if (!eap->skip)
4878 {
4879 if (fp == NULL)
4880 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004881 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004882 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004883 return;
4884 }
4885 if (fp->uf_calls > 0)
4886 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004887 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888 return;
4889 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004890 if (fp->uf_flags & FC_VIM9)
4891 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004892 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004893 return;
4894 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895
4896 if (fudi.fd_dict != NULL)
4897 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004898 // Delete the dict item that refers to the function, it will
4899 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004900 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4901 }
4902 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004903 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004904 // A normal function (not a numbered function or lambda) has a
4905 // refcount of 1 for the entry in the hashtable. When deleting
4906 // it and the refcount is more than one, it should be kept.
4907 // A numbered function and lambda should be kept if the refcount is
4908 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004909 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004910 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004911 // Function is still referenced somewhere. Don't free it but
4912 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004913 if (func_remove(fp))
4914 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004915 }
4916 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004917 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004918 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919 }
4920}
4921
4922/*
4923 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004924 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004925 */
4926 void
4927func_unref(char_u *name)
4928{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004929 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004931 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004932 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004933 fp = find_func(name, FALSE, NULL);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004934 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004937 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004939 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004940 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004941 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004942}
4943
4944/*
4945 * Unreference a Function: decrement the reference count and free it when it
4946 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004947 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004948 */
4949 void
4950func_ptr_unref(ufunc_T *fp)
4951{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004952 if (fp != NULL && (--fp->uf_refcount <= 0
4953 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4954 && fp->uf_partial->pt_refcount <= 1
4955 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004956 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004957 // Only delete it when it's not being used. Otherwise it's done
4958 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004959 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004960 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004961 }
4962}
4963
4964/*
4965 * Count a reference to a Function.
4966 */
4967 void
4968func_ref(char_u *name)
4969{
4970 ufunc_T *fp;
4971
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004972 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004974 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004975 if (fp != NULL)
4976 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004977 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004978 // Only give an error for a numbered function.
4979 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004980 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004981}
4982
4983/*
4984 * Count a reference to a Function.
4985 */
4986 void
4987func_ptr_ref(ufunc_T *fp)
4988{
4989 if (fp != NULL)
4990 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004991}
4992
4993/*
4994 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4995 * referenced from anywhere that is in use.
4996 */
4997 static int
4998can_free_funccal(funccall_T *fc, int copyID)
4999{
5000 return (fc->l_varlist.lv_copyID != copyID
5001 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005002 && fc->l_avars.dv_copyID != copyID
5003 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004}
5005
5006/*
5007 * ":return [expr]"
5008 */
5009 void
5010ex_return(exarg_T *eap)
5011{
5012 char_u *arg = eap->arg;
5013 typval_T rettv;
5014 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005015 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016
5017 if (current_funccal == NULL)
5018 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005019 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005020 return;
5021 }
5022
Bram Moolenaar844fb642021-10-23 13:32:30 +01005023 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005024 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5025
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026 if (eap->skip)
5027 ++emsg_skip;
5028
5029 eap->nextcmd = NULL;
5030 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005031 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032 {
5033 if (!eap->skip)
5034 returning = do_return(eap, FALSE, TRUE, &rettv);
5035 else
5036 clear_tv(&rettv);
5037 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005038 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005039 else if (!eap->skip)
5040 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005041 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005042 update_force_abort();
5043
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005044 /*
5045 * Return unless the expression evaluation has been cancelled due to an
5046 * aborting error, an interrupt, or an exception.
5047 */
5048 if (!aborting())
5049 returning = do_return(eap, FALSE, TRUE, NULL);
5050 }
5051
Bram Moolenaare38eab22019-12-05 21:50:01 +01005052 // When skipping or the return gets pending, advance to the next command
5053 // in this line (!returning). Otherwise, ignore the rest of the line.
5054 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005055 if (returning)
5056 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005057 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005058 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005059
5060 if (eap->skip)
5061 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005062 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063}
5064
5065/*
5066 * ":1,25call func(arg1, arg2)" function call.
5067 */
5068 void
5069ex_call(exarg_T *eap)
5070{
5071 char_u *arg = eap->arg;
5072 char_u *startarg;
5073 char_u *name;
5074 char_u *tofree;
5075 int len;
5076 typval_T rettv;
5077 linenr_T lnum;
5078 int doesrange;
5079 int failed = FALSE;
5080 funcdict_T fudi;
5081 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005082 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005083 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005084 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085
Bram Moolenaare6b53242020-07-01 17:28:33 +02005086 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005087 if (eap->skip)
5088 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005089 // trans_function_name() doesn't work well when skipping, use eval0()
5090 // instead to skip to any following command, e.g. for:
5091 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005092 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005093 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005094 clear_tv(&rettv);
5095 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005096 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005097 return;
5098 }
5099
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005100 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5101 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102 if (fudi.fd_newkey != NULL)
5103 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005104 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005105 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106 vim_free(fudi.fd_newkey);
5107 }
5108 if (tofree == NULL)
5109 return;
5110
Bram Moolenaare38eab22019-12-05 21:50:01 +01005111 // Increase refcount on dictionary, it could get deleted when evaluating
5112 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005113 if (fudi.fd_dict != NULL)
5114 ++fudi.fd_dict->dv_refcount;
5115
Bram Moolenaare38eab22019-12-05 21:50:01 +01005116 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5117 // contents. For VAR_PARTIAL get its partial, unless we already have one
5118 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005119 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005120 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005121 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122
Bram Moolenaare38eab22019-12-05 21:50:01 +01005123 // Skip white space to allow ":call func ()". Not good, but required for
5124 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005125 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126 if (*startarg != '(')
5127 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005128 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005129 goto end;
5130 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005131 if (in_vim9script() && startarg > arg)
5132 {
5133 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5134 goto end;
5135 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005136
5137 /*
5138 * When skipping, evaluate the function once, to find the end of the
5139 * arguments.
5140 * When the function takes a range, this is discovered after the first
5141 * call, and the loop is broken.
5142 */
5143 if (eap->skip)
5144 {
5145 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005146 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147 }
5148 else
5149 lnum = eap->line1;
5150 for ( ; lnum <= eap->line2; ++lnum)
5151 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005152 funcexe_T funcexe;
5153
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005154 if (!eap->skip && eap->addr_count > 0)
5155 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005156 if (lnum > curbuf->b_ml.ml_line_count)
5157 {
5158 // If the function deleted lines or switched to another buffer
5159 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005160 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005161 break;
5162 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005163 curwin->w_cursor.lnum = lnum;
5164 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005166 }
5167 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005168
Bram Moolenaara80faa82020-04-12 19:37:17 +02005169 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005170 funcexe.fe_firstline = eap->line1;
5171 funcexe.fe_lastline = eap->line2;
5172 funcexe.fe_doesrange = &doesrange;
5173 funcexe.fe_evaluate = !eap->skip;
5174 funcexe.fe_partial = partial;
5175 funcexe.fe_selfdict = fudi.fd_dict;
5176 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005177 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005178 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005179 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005180 {
5181 failed = TRUE;
5182 break;
5183 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005184 if (has_watchexpr())
5185 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005186
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005187 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005188 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005189 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005190 {
5191 failed = TRUE;
5192 break;
5193 }
5194
5195 clear_tv(&rettv);
5196 if (doesrange || eap->skip)
5197 break;
5198
Bram Moolenaare38eab22019-12-05 21:50:01 +01005199 // Stop when immediately aborting on error, or when an interrupt
5200 // occurred or an exception was thrown but not caught.
5201 // get_func_tv() returned OK, so that the check for trailing
5202 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203 if (aborting())
5204 break;
5205 }
5206 if (eap->skip)
5207 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005208 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209
Bram Moolenaar1d341892021-09-18 15:25:52 +02005210 // When inside :try we need to check for following "| catch" or "| endtry".
5211 // Not when there was an error, but do check if an exception was thrown.
5212 if ((!aborting() || did_throw)
5213 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005214 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005215 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005216 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005217 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005219 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005220 {
5221 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005222 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224 }
5225 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005226 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005227 }
5228
5229end:
5230 dict_unref(fudi.fd_dict);
5231 vim_free(tofree);
5232}
5233
5234/*
5235 * Return from a function. Possibly makes the return pending. Also called
5236 * for a pending return at the ":endtry" or after returning from an extra
5237 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5238 * when called due to a ":return" command. "rettv" may point to a typval_T
5239 * with the return rettv. Returns TRUE when the return can be carried out,
5240 * FALSE when the return gets pending.
5241 */
5242 int
5243do_return(
5244 exarg_T *eap,
5245 int reanimate,
5246 int is_cmd,
5247 void *rettv)
5248{
5249 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005250 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005251
5252 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005253 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005254 current_funccal->returned = FALSE;
5255
5256 /*
5257 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5258 * not in its finally clause (which then is to be executed next) is found.
5259 * In this case, make the ":return" pending for execution at the ":endtry".
5260 * Otherwise, return normally.
5261 */
5262 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5263 if (idx >= 0)
5264 {
5265 cstack->cs_pending[idx] = CSTP_RETURN;
5266
5267 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005268 // A pending return again gets pending. "rettv" points to an
5269 // allocated variable with the rettv of the original ":return"'s
5270 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005271 cstack->cs_rettv[idx] = rettv;
5272 else
5273 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005274 // When undoing a return in order to make it pending, get the stored
5275 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005276 if (reanimate)
5277 rettv = current_funccal->rettv;
5278
5279 if (rettv != NULL)
5280 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005281 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005282 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5283 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5284 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005285 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005286 }
5287 else
5288 cstack->cs_rettv[idx] = NULL;
5289
5290 if (reanimate)
5291 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005292 // The pending return value could be overwritten by a ":return"
5293 // without argument in a finally clause; reset the default
5294 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005295 current_funccal->rettv->v_type = VAR_NUMBER;
5296 current_funccal->rettv->vval.v_number = 0;
5297 }
5298 }
5299 report_make_pending(CSTP_RETURN, rettv);
5300 }
5301 else
5302 {
5303 current_funccal->returned = TRUE;
5304
Bram Moolenaare38eab22019-12-05 21:50:01 +01005305 // If the return is carried out now, store the return value. For
5306 // a return immediately after reanimation, the value is already
5307 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005308 if (!reanimate && rettv != NULL)
5309 {
5310 clear_tv(current_funccal->rettv);
5311 *current_funccal->rettv = *(typval_T *)rettv;
5312 if (!is_cmd)
5313 vim_free(rettv);
5314 }
5315 }
5316
5317 return idx < 0;
5318}
5319
5320/*
5321 * Free the variable with a pending return value.
5322 */
5323 void
5324discard_pending_return(void *rettv)
5325{
5326 free_tv((typval_T *)rettv);
5327}
5328
5329/*
5330 * Generate a return command for producing the value of "rettv". The result
5331 * is an allocated string. Used by report_pending() for verbose messages.
5332 */
5333 char_u *
5334get_return_cmd(void *rettv)
5335{
5336 char_u *s = NULL;
5337 char_u *tofree = NULL;
5338 char_u numbuf[NUMBUFLEN];
5339
5340 if (rettv != NULL)
5341 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5342 if (s == NULL)
5343 s = (char_u *)"";
5344
5345 STRCPY(IObuff, ":return ");
5346 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5347 if (STRLEN(s) + 8 >= IOSIZE)
5348 STRCPY(IObuff + IOSIZE - 4, "...");
5349 vim_free(tofree);
5350 return vim_strsave(IObuff);
5351}
5352
5353/*
5354 * Get next function line.
5355 * Called by do_cmdline() to get the next line.
5356 * Returns allocated string, or NULL for end of function.
5357 */
5358 char_u *
5359get_func_line(
5360 int c UNUSED,
5361 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005362 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005363 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005364{
5365 funccall_T *fcp = (funccall_T *)cookie;
5366 ufunc_T *fp = fcp->func;
5367 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005368 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005369
Bram Moolenaare38eab22019-12-05 21:50:01 +01005370 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005371 if (fcp->dbg_tick != debug_tick)
5372 {
5373 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005374 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005375 fcp->dbg_tick = debug_tick;
5376 }
5377#ifdef FEAT_PROFILE
5378 if (do_profiling == PROF_YES)
5379 func_line_end(cookie);
5380#endif
5381
5382 gap = &fp->uf_lines;
5383 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5384 || fcp->returned)
5385 retval = NULL;
5386 else
5387 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005388 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005389 while (fcp->linenr < gap->ga_len
5390 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5391 ++fcp->linenr;
5392 if (fcp->linenr >= gap->ga_len)
5393 retval = NULL;
5394 else
5395 {
5396 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005397 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005398#ifdef FEAT_PROFILE
5399 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005400 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005401#endif
5402 }
5403 }
5404
Bram Moolenaare38eab22019-12-05 21:50:01 +01005405 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005406 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005407 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005408 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005409 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005410 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005411 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005412 fcp->dbg_tick = debug_tick;
5413 }
5414
5415 return retval;
5416}
5417
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005418/*
5419 * Return TRUE if the currently active function should be ended, because a
5420 * return was encountered or an error occurred. Used inside a ":while".
5421 */
5422 int
5423func_has_ended(void *cookie)
5424{
5425 funccall_T *fcp = (funccall_T *)cookie;
5426
Bram Moolenaare38eab22019-12-05 21:50:01 +01005427 // Ignore the "abort" flag if the abortion behavior has been changed due to
5428 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005429 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5430 || fcp->returned);
5431}
5432
5433/*
5434 * return TRUE if cookie indicates a function which "abort"s on errors.
5435 */
5436 int
5437func_has_abort(
5438 void *cookie)
5439{
5440 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5441}
5442
5443
5444/*
5445 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5446 * Don't do this when "Func" is already a partial that was bound
5447 * explicitly (pt_auto is FALSE).
5448 * Changes "rettv" in-place.
5449 * Returns the updated "selfdict_in".
5450 */
5451 dict_T *
5452make_partial(dict_T *selfdict_in, typval_T *rettv)
5453{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005454 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005455 char_u *tofree = NULL;
5456 ufunc_T *fp;
5457 char_u fname_buf[FLEN_FIXED + 1];
5458 int error;
5459 dict_T *selfdict = selfdict_in;
5460
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005461 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5462 fp = rettv->vval.v_partial->pt_func;
5463 else
5464 {
5465 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5466 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005467 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005468 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005469 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005470 vim_free(tofree);
5471 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005472
5473 if (fp != NULL && (fp->uf_flags & FC_DICT))
5474 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005475 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476
5477 if (pt != NULL)
5478 {
5479 pt->pt_refcount = 1;
5480 pt->pt_dict = selfdict;
5481 pt->pt_auto = TRUE;
5482 selfdict = NULL;
5483 if (rettv->v_type == VAR_FUNC)
5484 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005485 // Just a function: Take over the function name and use
5486 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005487 pt->pt_name = rettv->vval.v_string;
5488 }
5489 else
5490 {
5491 partial_T *ret_pt = rettv->vval.v_partial;
5492 int i;
5493
Bram Moolenaare38eab22019-12-05 21:50:01 +01005494 // Partial: copy the function name, use selfdict and copy
5495 // args. Can't take over name or args, the partial might
5496 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005497 if (ret_pt->pt_name != NULL)
5498 {
5499 pt->pt_name = vim_strsave(ret_pt->pt_name);
5500 func_ref(pt->pt_name);
5501 }
5502 else
5503 {
5504 pt->pt_func = ret_pt->pt_func;
5505 func_ptr_ref(pt->pt_func);
5506 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005507 if (ret_pt->pt_argc > 0)
5508 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005509 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005510 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005511 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005512 pt->pt_argc = 0;
5513 else
5514 {
5515 pt->pt_argc = ret_pt->pt_argc;
5516 for (i = 0; i < pt->pt_argc; i++)
5517 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5518 }
5519 }
5520 partial_unref(ret_pt);
5521 }
5522 rettv->v_type = VAR_PARTIAL;
5523 rettv->vval.v_partial = pt;
5524 }
5525 }
5526 return selfdict;
5527}
5528
5529/*
5530 * Return the name of the executed function.
5531 */
5532 char_u *
5533func_name(void *cookie)
5534{
5535 return ((funccall_T *)cookie)->func->uf_name;
5536}
5537
5538/*
5539 * Return the address holding the next breakpoint line for a funccall cookie.
5540 */
5541 linenr_T *
5542func_breakpoint(void *cookie)
5543{
5544 return &((funccall_T *)cookie)->breakpoint;
5545}
5546
5547/*
5548 * Return the address holding the debug tick for a funccall cookie.
5549 */
5550 int *
5551func_dbg_tick(void *cookie)
5552{
5553 return &((funccall_T *)cookie)->dbg_tick;
5554}
5555
5556/*
5557 * Return the nesting level for a funccall cookie.
5558 */
5559 int
5560func_level(void *cookie)
5561{
5562 return ((funccall_T *)cookie)->level;
5563}
5564
5565/*
5566 * Return TRUE when a function was ended by a ":return" command.
5567 */
5568 int
5569current_func_returned(void)
5570{
5571 return current_funccal->returned;
5572}
5573
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005574 int
5575free_unref_funccal(int copyID, int testing)
5576{
5577 int did_free = FALSE;
5578 int did_free_funccal = FALSE;
5579 funccall_T *fc, **pfc;
5580
5581 for (pfc = &previous_funccal; *pfc != NULL; )
5582 {
5583 if (can_free_funccal(*pfc, copyID))
5584 {
5585 fc = *pfc;
5586 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005587 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005588 did_free = TRUE;
5589 did_free_funccal = TRUE;
5590 }
5591 else
5592 pfc = &(*pfc)->caller;
5593 }
5594 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005595 // When a funccal was freed some more items might be garbage
5596 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005597 (void)garbage_collect(testing);
5598
5599 return did_free;
5600}
5601
5602/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005603 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005604 */
5605 static funccall_T *
5606get_funccal(void)
5607{
5608 int i;
5609 funccall_T *funccal;
5610 funccall_T *temp_funccal;
5611
5612 funccal = current_funccal;
5613 if (debug_backtrace_level > 0)
5614 {
5615 for (i = 0; i < debug_backtrace_level; i++)
5616 {
5617 temp_funccal = funccal->caller;
5618 if (temp_funccal)
5619 funccal = temp_funccal;
5620 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005621 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005622 debug_backtrace_level = i;
5623 }
5624 }
5625 return funccal;
5626}
5627
5628/*
5629 * Return the hashtable used for local variables in the current funccal.
5630 * Return NULL if there is no current funccal.
5631 */
5632 hashtab_T *
5633get_funccal_local_ht()
5634{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005635 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005636 return NULL;
5637 return &get_funccal()->l_vars.dv_hashtab;
5638}
5639
5640/*
5641 * Return the l: scope variable.
5642 * Return NULL if there is no current funccal.
5643 */
5644 dictitem_T *
5645get_funccal_local_var()
5646{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005647 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005648 return NULL;
5649 return &get_funccal()->l_vars_var;
5650}
5651
5652/*
5653 * Return the hashtable used for argument in the current funccal.
5654 * Return NULL if there is no current funccal.
5655 */
5656 hashtab_T *
5657get_funccal_args_ht()
5658{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005659 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005660 return NULL;
5661 return &get_funccal()->l_avars.dv_hashtab;
5662}
5663
5664/*
5665 * Return the a: scope variable.
5666 * Return NULL if there is no current funccal.
5667 */
5668 dictitem_T *
5669get_funccal_args_var()
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 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005673 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005674}
5675
5676/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005677 * List function variables, if there is a function.
5678 */
5679 void
5680list_func_vars(int *first)
5681{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005682 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005683 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005684 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005685}
5686
5687/*
5688 * If "ht" is the hashtable for local variables in the current funccal, return
5689 * the dict that contains it.
5690 * Otherwise return NULL.
5691 */
5692 dict_T *
5693get_current_funccal_dict(hashtab_T *ht)
5694{
5695 if (current_funccal != NULL
5696 && ht == &current_funccal->l_vars.dv_hashtab)
5697 return &current_funccal->l_vars;
5698 return NULL;
5699}
5700
5701/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005702 * Search hashitem in parent scope.
5703 */
5704 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005705find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005706{
5707 funccall_T *old_current_funccal = current_funccal;
5708 hashtab_T *ht;
5709 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005710 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005711
5712 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5713 return NULL;
5714
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005715 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005716 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005717 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005718 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005719 ht = find_var_ht(name, &varname);
5720 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005721 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005722 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005723 if (!HASHITEM_EMPTY(hi))
5724 {
5725 *pht = ht;
5726 break;
5727 }
5728 }
5729 if (current_funccal == current_funccal->func->uf_scoped)
5730 break;
5731 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005732 }
5733 current_funccal = old_current_funccal;
5734
5735 return hi;
5736}
5737
5738/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005739 * Search variable in parent scope.
5740 */
5741 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005742find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005743{
5744 dictitem_T *v = NULL;
5745 funccall_T *old_current_funccal = current_funccal;
5746 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005747 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005748
5749 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5750 return NULL;
5751
Bram Moolenaare38eab22019-12-05 21:50:01 +01005752 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005753 current_funccal = current_funccal->func->uf_scoped;
5754 while (current_funccal)
5755 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005756 ht = find_var_ht(name, &varname);
5757 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005758 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005759 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005760 if (v != NULL)
5761 break;
5762 }
5763 if (current_funccal == current_funccal->func->uf_scoped)
5764 break;
5765 current_funccal = current_funccal->func->uf_scoped;
5766 }
5767 current_funccal = old_current_funccal;
5768
5769 return v;
5770}
5771
5772/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005773 * Set "copyID + 1" in previous_funccal and callers.
5774 */
5775 int
5776set_ref_in_previous_funccal(int copyID)
5777{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005778 funccall_T *fc;
5779
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005780 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005781 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005782 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005783 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5784 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5785 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5786 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005787 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005788 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005789}
5790
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005791 static int
5792set_ref_in_funccal(funccall_T *fc, int copyID)
5793{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005794 if (fc->fc_copyID != copyID)
5795 {
5796 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005797 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5798 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5799 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5800 || set_ref_in_func(NULL, fc->func, copyID))
5801 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005802 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005803 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005804}
5805
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005806/*
5807 * Set "copyID" in all local vars and arguments in the call stack.
5808 */
5809 int
5810set_ref_in_call_stack(int copyID)
5811{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005812 funccall_T *fc;
5813 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005814
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005815 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5816 if (set_ref_in_funccal(fc, copyID))
5817 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005818
5819 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005820 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5821 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5822 if (set_ref_in_funccal(fc, copyID))
5823 return TRUE;
5824 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005825}
5826
5827/*
5828 * Set "copyID" in all functions available by name.
5829 */
5830 int
5831set_ref_in_functions(int copyID)
5832{
5833 int todo;
5834 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005835 ufunc_T *fp;
5836
5837 todo = (int)func_hashtab.ht_used;
5838 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005839 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005840 if (!HASHITEM_EMPTY(hi))
5841 {
5842 --todo;
5843 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005844 if (!func_name_refcount(fp->uf_name)
5845 && set_ref_in_func(NULL, fp, copyID))
5846 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005847 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005848 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005849 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005850}
5851
5852/*
5853 * Set "copyID" in all function arguments.
5854 */
5855 int
5856set_ref_in_func_args(int copyID)
5857{
5858 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005859
5860 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005861 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5862 copyID, NULL, NULL))
5863 return TRUE;
5864 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005865}
5866
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005867/*
5868 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005869 * Returns TRUE if setting references failed somehow.
5870 */
5871 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005872set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005873{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005874 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005875 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005876 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005877 char_u fname_buf[FLEN_FIXED + 1];
5878 char_u *tofree = NULL;
5879 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005880 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005881
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005882 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005883 return FALSE;
5884
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005885 if (fp_in == NULL)
5886 {
5887 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005888 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005889 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005890 if (fp != NULL)
5891 {
5892 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005893 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005894 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005895
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005896 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005897 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005898}
5899
Bram Moolenaare38eab22019-12-05 21:50:01 +01005900#endif // FEAT_EVAL