blob: fc6cea38ced7ac0ae063c1e1b57c932923969748 [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{
Bram Moolenaar54598062022-01-13 12:05:09 +00001677 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001678
Bram Moolenaar54598062022-01-13 12:05:09 +00001679 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001681 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001682 if (p != name)
1683 vim_free(p);
1684}
1685
1686/*
1687 * Allocate a variable for the result of a function.
1688 * Return OK or FAIL.
1689 */
1690 int
1691get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001692 char_u *name, // name of the function
1693 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001695 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001696 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001697 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001698{
1699 char_u *argp;
1700 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001701 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1702 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001703 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001704 int evaluate = evalarg == NULL
1705 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001706
1707 /*
1708 * Get the arguments.
1709 */
1710 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001711 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1712 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001714 // skip the '(' or ',' and possibly line breaks
1715 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1716
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 if (*argp == ')' || *argp == ',' || *argp == NUL)
1718 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001719 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720 {
1721 ret = FAIL;
1722 break;
1723 }
1724 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001725 // The comma should come right after the argument, but this wasn't
1726 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001727 if (vim9script)
1728 {
1729 if (*argp != ',' && *skipwhite(argp) == ',')
1730 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001731 if (evaluate)
1732 semsg(_(e_no_white_space_allowed_before_str_str),
1733 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001734 ret = FAIL;
1735 break;
1736 }
1737 }
1738 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001739 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 if (*argp != ',')
1741 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001742 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1743 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001744 if (evaluate)
1745 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001746 ret = FAIL;
1747 break;
1748 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001750 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751 if (*argp == ')')
1752 ++argp;
1753 else
1754 ret = FAIL;
1755
1756 if (ret == OK)
1757 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001758 int i = 0;
1759 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001760
1761 if (get_vim_var_nr(VV_TESTING))
1762 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001763 // Prepare for calling test_garbagecollect_now(), need to know
1764 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001766 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 for (i = 0; i < argcount; ++i)
1768 if (ga_grow(&funcargs, 1) == OK)
1769 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1770 &argvars[i];
1771 }
1772
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001773 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001774 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001775 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001776 // An error in a builtin function does not return FAIL, but we do
1777 // want to abort further processing if an error was given.
1778 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001779 clear_tv(rettv);
1780 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001781
1782 funcargs.ga_len -= i;
1783 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001784 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 {
1786 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001787 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001789 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790 }
1791
1792 while (--argcount >= 0)
1793 clear_tv(&argvars[argcount]);
1794
Bram Moolenaar8294d492020-08-10 22:40:56 +02001795 if (in_vim9script())
1796 *arg = argp;
1797 else
1798 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799 return ret;
1800}
1801
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802/*
1803 * Return TRUE if "p" starts with "<SID>" or "s:".
1804 * Only works if eval_fname_script() returned non-zero for "p"!
1805 */
1806 static int
1807eval_fname_sid(char_u *p)
1808{
1809 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1810}
1811
1812/*
1813 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1814 * Change <SNR>123_name() to K_SNR 123_name().
1815 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1816 * (slow).
1817 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001818 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001819fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1820{
1821 int llen;
1822 char_u *fname;
1823 int i;
1824
1825 llen = eval_fname_script(name);
1826 if (llen > 0)
1827 {
1828 fname_buf[0] = K_SPECIAL;
1829 fname_buf[1] = KS_EXTRA;
1830 fname_buf[2] = (int)KE_SNR;
1831 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001832 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001834 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001835 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001836 else
1837 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001838 sprintf((char *)fname_buf + 3, "%ld_",
1839 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001840 i = (int)STRLEN(fname_buf);
1841 }
1842 }
1843 if (i + STRLEN(name + llen) < FLEN_FIXED)
1844 {
1845 STRCPY(fname_buf + i, name + llen);
1846 fname = fname_buf;
1847 }
1848 else
1849 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001850 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001852 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 else
1854 {
1855 *tofree = fname;
1856 mch_memmove(fname, fname_buf, (size_t)i);
1857 STRCPY(fname + i, name + llen);
1858 }
1859 }
1860 }
1861 else
1862 fname = name;
1863 return fname;
1864}
1865
1866/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001867 * Find a function "name" in script "sid".
1868 */
1869 static ufunc_T *
1870find_func_with_sid(char_u *name, int sid)
1871{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001872 hashitem_T *hi;
1873 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001874
Bram Moolenaarb8822442022-01-11 15:24:05 +00001875 if (!SCRIPT_ID_VALID(sid))
1876 return NULL; // not in a script
1877
1878 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001879 buffer[0] = K_SPECIAL;
1880 buffer[1] = KS_EXTRA;
1881 buffer[2] = (int)KE_SNR;
1882 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1883 (long)sid, name);
1884 hi = hash_find(&func_hashtab, buffer);
1885 if (!HASHITEM_EMPTY(hi))
1886 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001887 return NULL;
1888}
1889
1890/*
1891 * Find a function "name" in script "sid" prefixing the autoload prefix.
1892 */
1893 static ufunc_T *
1894find_func_with_prefix(char_u *name, int sid)
1895{
1896 hashitem_T *hi;
1897 char_u buffer[200];
1898 scriptitem_T *si;
1899
1900 if (vim_strchr(name, AUTOLOAD_CHAR) != 0)
1901 return NULL; // already has the prefix
1902 if (!SCRIPT_ID_VALID(sid))
1903 return NULL; // not in a script
1904 si = SCRIPT_ITEM(sid);
1905 if (si->sn_autoload_prefix != NULL)
1906 {
1907 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1908 char_u *auto_name;
1909
1910 // An exported function in an autoload script is stored as
1911 // "dir#path#name".
1912 if (len < sizeof(buffer))
1913 auto_name = buffer;
1914 else
1915 auto_name = alloc(len);
1916 if (auto_name != NULL)
1917 {
1918 vim_snprintf((char *)auto_name, len, "%s%s",
1919 si->sn_autoload_prefix, name);
1920 hi = hash_find(&func_hashtab, auto_name);
1921 if (auto_name != buffer)
1922 vim_free(auto_name);
1923 if (!HASHITEM_EMPTY(hi))
1924 return HI2UF(hi);
1925 }
1926 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001927
1928 return NULL;
1929}
1930
1931/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001932 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001933 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934 * Return NULL for unknown function.
1935 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001936 ufunc_T *
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001937find_func_even_dead(char_u *name, int is_global, cctx_T *cctx UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938{
1939 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001940 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001941
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001942 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001943 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001944 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1945 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001946
Bram Moolenaar95006e32020-08-29 17:47:08 +02001947 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001949 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001950 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1951 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001952 if (func != NULL)
1953 return func;
1954 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956
Bram Moolenaara26b9702020-04-18 19:53:28 +02001957 hi = hash_find(&func_hashtab,
1958 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001959 if (!HASHITEM_EMPTY(hi))
1960 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001961
Bram Moolenaarb8822442022-01-11 15:24:05 +00001962 // Find autoload function if this is an autoload script.
1963 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1964 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001965}
1966
1967/*
1968 * Find a function by name, return pointer to it in ufuncs.
1969 * "cctx" is passed in a :def function to find imported functions.
1970 * Return NULL for unknown or dead function.
1971 */
1972 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001973find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001974{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001975 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001976
1977 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1978 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001979 return NULL;
1980}
1981
1982/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001983 * Return TRUE if "ufunc" is a global function.
1984 */
1985 int
1986func_is_global(ufunc_T *ufunc)
1987{
1988 return ufunc->uf_name[0] != K_SPECIAL;
1989}
1990
1991/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001992 * Copy the function name of "fp" to buffer "buf".
1993 * "buf" must be able to hold the function name plus three bytes.
1994 * Takes care of script-local function names.
1995 */
1996 static void
1997cat_func_name(char_u *buf, ufunc_T *fp)
1998{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001999 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002000 {
2001 STRCPY(buf, "<SNR>");
2002 STRCAT(buf, fp->uf_name + 3);
2003 }
2004 else
2005 STRCPY(buf, fp->uf_name);
2006}
2007
2008/*
2009 * Add a number variable "name" to dict "dp" with value "nr".
2010 */
2011 static void
2012add_nr_var(
2013 dict_T *dp,
2014 dictitem_T *v,
2015 char *name,
2016 varnumber_T nr)
2017{
2018 STRCPY(v->di_key, name);
2019 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2020 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2021 v->di_tv.v_type = VAR_NUMBER;
2022 v->di_tv.v_lock = VAR_FIXED;
2023 v->di_tv.vval.v_number = nr;
2024}
2025
2026/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002027 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002029 static void
2030free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002031{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002032 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002033
2034 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2035 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002036 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002037
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002038 // When garbage collecting a funccall_T may be freed before the
2039 // function that references it, clear its uf_scoped field.
2040 // The function may have been redefined and point to another
2041 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002042 if (fp != NULL && fp->uf_scoped == fc)
2043 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002044 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002045 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002046
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002047 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002048 vim_free(fc);
2049}
2050
2051/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002052 * Free "fc" and what it contains.
2053 * Can be called only when "fc" is kept beyond the period of it called,
2054 * i.e. after cleanup_function_call(fc).
2055 */
2056 static void
2057free_funccal_contents(funccall_T *fc)
2058{
2059 listitem_T *li;
2060
2061 // Free all l: variables.
2062 vars_clear(&fc->l_vars.dv_hashtab);
2063
2064 // Free all a: variables.
2065 vars_clear(&fc->l_avars.dv_hashtab);
2066
2067 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002068 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002069 clear_tv(&li->li_tv);
2070
2071 free_funccal(fc);
2072}
2073
2074/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002075 * Handle the last part of returning from a function: free the local hashtable.
2076 * Unless it is still in use by a closure.
2077 */
2078 static void
2079cleanup_function_call(funccall_T *fc)
2080{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002081 int may_free_fc = fc->fc_refcount <= 0;
2082 int free_fc = TRUE;
2083
Bram Moolenaar6914c642017-04-01 21:21:30 +02002084 current_funccal = fc->caller;
2085
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002086 // Free all l: variables if not referred.
2087 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2088 vars_clear(&fc->l_vars.dv_hashtab);
2089 else
2090 free_fc = FALSE;
2091
2092 // If the a:000 list and the l: and a: dicts are not referenced and
2093 // there is no closure using it, we can free the funccall_T and what's
2094 // in it.
2095 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2096 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002097 else
2098 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002099 int todo;
2100 hashitem_T *hi;
2101 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002102
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002103 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002104
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002105 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002106 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2107 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2108 {
2109 if (!HASHITEM_EMPTY(hi))
2110 {
2111 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002112 di = HI2DI(hi);
2113 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002114 }
2115 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002116 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002117
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002118 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2119 fc->l_varlist.lv_first = NULL;
2120 else
2121 {
2122 listitem_T *li;
2123
2124 free_fc = FALSE;
2125
2126 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002127 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002128 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002129 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002130
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002131 if (free_fc)
2132 free_funccal(fc);
2133 else
2134 {
2135 static int made_copy = 0;
2136
2137 // "fc" is still in use. This can happen when returning "a:000",
2138 // assigning "l:" to a global variable or defining a closure.
2139 // Link "fc" in the list for garbage collection later.
2140 fc->caller = previous_funccal;
2141 previous_funccal = fc;
2142
2143 if (want_garbage_collect)
2144 // If garbage collector is ready, clear count.
2145 made_copy = 0;
2146 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002147 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002148 // We have made a lot of copies, worth 4 Mbyte. This can happen
2149 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002150 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002151 // too much memory.
2152 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002153 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002154 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002155 }
2156}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002157
2158/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002159 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2160 */
2161 static int
2162numbered_function(char_u *name)
2163{
2164 return isdigit(*name)
2165 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2166}
2167
2168/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002169 * There are two kinds of function names:
2170 * 1. ordinary names, function defined with :function or :def
2171 * 2. numbered functions and lambdas
2172 * For the first we only count the name stored in func_hashtab as a reference,
2173 * using function() does not count as a reference, because the function is
2174 * looked up by name.
2175 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002176 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002177func_name_refcount(char_u *name)
2178{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002179 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002180}
2181
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002182/*
2183 * Unreference "fc": decrement the reference count and free it when it
2184 * becomes zero. "fp" is detached from "fc".
2185 * When "force" is TRUE we are exiting.
2186 */
2187 static void
2188funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2189{
2190 funccall_T **pfc;
2191 int i;
2192
2193 if (fc == NULL)
2194 return;
2195
2196 if (--fc->fc_refcount <= 0 && (force || (
2197 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2198 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2199 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2200 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2201 {
2202 if (fc == *pfc)
2203 {
2204 *pfc = fc->caller;
2205 free_funccal_contents(fc);
2206 return;
2207 }
2208 }
2209 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2210 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2211 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2212}
2213
2214/*
2215 * Remove the function from the function hashtable. If the function was
2216 * deleted while it still has references this was already done.
2217 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2218 */
2219 static int
2220func_remove(ufunc_T *fp)
2221{
2222 hashitem_T *hi;
2223
2224 // Return if it was already virtually deleted.
2225 if (fp->uf_flags & FC_DEAD)
2226 return FALSE;
2227
2228 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2229 if (!HASHITEM_EMPTY(hi))
2230 {
2231 // When there is a def-function index do not actually remove the
2232 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002233 // Do remove it when it's a copy.
2234 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002235 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002236 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002237 return FALSE;
2238 }
2239 hash_remove(&func_hashtab, hi);
2240 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002241 return TRUE;
2242 }
2243 return FALSE;
2244}
2245
2246 static void
2247func_clear_items(ufunc_T *fp)
2248{
2249 ga_clear_strings(&(fp->uf_args));
2250 ga_clear_strings(&(fp->uf_def_args));
2251 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002252 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002253 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002254 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002255 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002256
2257 // Increment the refcount of this function to avoid it being freed
2258 // recursively when the partial is freed.
2259 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002260 partial_unref(fp->uf_partial);
2261 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002262 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002263
2264#ifdef FEAT_LUA
2265 if (fp->uf_cb_free != NULL)
2266 {
2267 fp->uf_cb_free(fp->uf_cb_state);
2268 fp->uf_cb_free = NULL;
2269 }
2270
2271 fp->uf_cb_state = NULL;
2272 fp->uf_cb = NULL;
2273#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002274#ifdef FEAT_PROFILE
2275 VIM_CLEAR(fp->uf_tml_count);
2276 VIM_CLEAR(fp->uf_tml_total);
2277 VIM_CLEAR(fp->uf_tml_self);
2278#endif
2279}
2280
2281/*
2282 * Free all things that a function contains. Does not free the function
2283 * itself, use func_free() for that.
2284 * When "force" is TRUE we are exiting.
2285 */
2286 static void
2287func_clear(ufunc_T *fp, int force)
2288{
2289 if (fp->uf_cleared)
2290 return;
2291 fp->uf_cleared = TRUE;
2292
2293 // clear this function
2294 func_clear_items(fp);
2295 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002296 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002297}
2298
2299/*
2300 * Free a function and remove it from the list of functions. Does not free
2301 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002302 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002303 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002304 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002305 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002306func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002307{
2308 // Only remove it when not done already, otherwise we would remove a newer
2309 // version of the function with the same name.
2310 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2311 func_remove(fp);
2312
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002313 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002314 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002315 if (fp->uf_dfunc_idx > 0)
2316 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002317 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002318 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002319 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002320 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002321 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002322}
2323
2324/*
2325 * Free all things that a function contains and free the function itself.
2326 * When "force" is TRUE we are exiting.
2327 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002328 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002329func_clear_free(ufunc_T *fp, int force)
2330{
2331 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002332 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2333 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002334 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002335 else
2336 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002337}
2338
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002339/*
2340 * Copy already defined function "lambda" to a new function with name "global".
2341 * This is for when a compiled function defines a global function.
2342 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002343 int
2344copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002345{
2346 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002347 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002348
2349 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002350 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002351 semsg(_(e_lambda_function_not_found_str), lambda);
2352 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002353 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002354
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002355 fp = find_func(global, TRUE, NULL);
2356 if (fp != NULL)
2357 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002358 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002359 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002360 return FAIL;
2361 }
2362
2363 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2364 if (fp == NULL)
2365 return FAIL;
2366
2367 fp->uf_varargs = ufunc->uf_varargs;
2368 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2369 fp->uf_def_status = ufunc->uf_def_status;
2370 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2371 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2372 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2373 == FAIL
2374 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2375 goto failed;
2376
2377 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2378 : vim_strsave(ufunc->uf_name_exp);
2379 if (ufunc->uf_arg_types != NULL)
2380 {
2381 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2382 if (fp->uf_arg_types == NULL)
2383 goto failed;
2384 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2385 sizeof(type_T *) * fp->uf_args.ga_len);
2386 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002387 if (ufunc->uf_va_name != NULL)
2388 {
2389 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2390 if (fp->uf_va_name == NULL)
2391 goto failed;
2392 }
2393 fp->uf_ret_type = ufunc->uf_ret_type;
2394
2395 fp->uf_refcount = 1;
2396 STRCPY(fp->uf_name, global);
2397 hash_add(&func_hashtab, UF2HIKEY(fp));
2398
2399 // the referenced dfunc_T is now used one more time
2400 link_def_function(fp);
2401
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002402 // Create a partial to store the context of the function where it was
2403 // instantiated. Only needs to be done once. Do this on the original
2404 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002405 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2406 {
2407 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2408
2409 if (pt == NULL)
2410 goto failed;
2411 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002412 {
2413 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002414 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002415 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002416 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002417 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002418 }
2419
2420 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002421
2422failed:
2423 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002424 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002425}
2426
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002427static int funcdepth = 0;
2428
2429/*
2430 * Increment the function call depth count.
2431 * Return FAIL when going over 'maxfuncdepth'.
2432 * Otherwise return OK, must call funcdepth_decrement() later!
2433 */
2434 int
2435funcdepth_increment(void)
2436{
2437 if (funcdepth >= p_mfd)
2438 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002439 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002440 return FAIL;
2441 }
2442 ++funcdepth;
2443 return OK;
2444}
2445
2446 void
2447funcdepth_decrement(void)
2448{
2449 --funcdepth;
2450}
2451
2452/*
2453 * Get the current function call depth.
2454 */
2455 int
2456funcdepth_get(void)
2457{
2458 return funcdepth;
2459}
2460
2461/*
2462 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002463 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002464 * times as funcdepth_increment().
2465 */
2466 void
2467funcdepth_restore(int depth)
2468{
2469 funcdepth = depth;
2470}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002471
2472/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473 * Call a user function.
2474 */
2475 static void
2476call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002477 ufunc_T *fp, // pointer to function
2478 int argcount, // nr of args
2479 typval_T *argvars, // arguments
2480 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002481 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002482 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002484 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002485 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486 funccall_T *fc;
2487 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002488 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002489 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002490 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 int i;
2492 int ai;
2493 int islambda = FALSE;
2494 char_u numbuf[NUMBUFLEN];
2495 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002496 typval_T *tv_to_free[MAX_FUNC_ARGS];
2497 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002498#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002499 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002501 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502
Bram Moolenaarb2049902021-01-24 12:53:53 +01002503#ifdef FEAT_PROFILE
2504 CLEAR_FIELD(profile_info);
2505#endif
2506
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002507 // If depth of calling is getting too high, don't execute the function.
2508 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 rettv->v_type = VAR_NUMBER;
2511 rettv->vval.v_number = -1;
2512 return;
2513 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514
Bram Moolenaare38eab22019-12-05 21:50:01 +01002515 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002517 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002518 if (fc == NULL)
2519 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 fc->caller = current_funccal;
2521 current_funccal = fc;
2522 fc->func = fp;
2523 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002525 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2527 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002528 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002529 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002530 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002532 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002533 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002534#ifdef FEAT_PROFILE
2535 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2536#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002537 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002538#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002539 if (do_profiling == PROF_YES)
2540 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002541#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002542 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002543 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002544#ifdef FEAT_PROFILE
2545 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002546 || (caller != NULL && caller->uf_profiling)))
2547 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002548#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002549 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002550 free_funccal(fc);
2551 return;
2552 }
2553
Bram Moolenaar38453522021-11-28 22:00:12 +00002554 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555
2556 /*
2557 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2558 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2559 * each argument variable and saves a lot of time.
2560 */
2561 /*
2562 * Init l: variables.
2563 */
2564 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2565 if (selfdict != NULL)
2566 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002567 // Set l:self to "selfdict". Use "name" to avoid a warning from
2568 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 v = &fc->fixvar[fixvar_idx++].var;
2570 name = v->di_key;
2571 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002572 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2574 v->di_tv.v_type = VAR_DICT;
2575 v->di_tv.v_lock = 0;
2576 v->di_tv.vval.v_dict = selfdict;
2577 ++selfdict->dv_refcount;
2578 }
2579
2580 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002581 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002582 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002583 * Set a:000 to a list with room for the "..." arguments.
2584 */
2585 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002586 if ((fp->uf_flags & FC_NOARGS) == 0)
2587 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002588 (varnumber_T)(argcount >= fp->uf_args.ga_len
2589 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002590 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002591 if ((fp->uf_flags & FC_NOARGS) == 0)
2592 {
2593 // Use "name" to avoid a warning from some compiler that checks the
2594 // destination size.
2595 v = &fc->fixvar[fixvar_idx++].var;
2596 name = v->di_key;
2597 STRCPY(name, "000");
2598 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2599 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2600 v->di_tv.v_type = VAR_LIST;
2601 v->di_tv.v_lock = VAR_FIXED;
2602 v->di_tv.vval.v_list = &fc->l_varlist;
2603 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002604 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002605 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2606 fc->l_varlist.lv_lock = VAR_FIXED;
2607
2608 /*
2609 * Set a:firstline to "firstline" and a:lastline to "lastline".
2610 * Set a:name to named arguments.
2611 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002612 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002614 if ((fp->uf_flags & FC_NOARGS) == 0)
2615 {
2616 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002617 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002618 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002619 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002620 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002621 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 {
2623 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002624 typval_T def_rettv;
2625 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626
2627 ai = i - fp->uf_args.ga_len;
2628 if (ai < 0)
2629 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002630 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631 name = FUNCARG(fp, i);
2632 if (islambda)
2633 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002634
2635 // evaluate named argument default expression
2636 isdefault = ai + fp->uf_def_args.ga_len >= 0
2637 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2638 && argvars[i].vval.v_number == VVAL_NONE));
2639 if (isdefault)
2640 {
2641 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002642
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002643 def_rettv.v_type = VAR_NUMBER;
2644 def_rettv.vval.v_number = -1;
2645
2646 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2647 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002648 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002649 {
2650 default_arg_err = 1;
2651 break;
2652 }
2653 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002654 }
2655 else
2656 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002657 if ((fp->uf_flags & FC_NOARGS) != 0)
2658 // Bail out if no a: arguments used (in lambda).
2659 break;
2660
Bram Moolenaare38eab22019-12-05 21:50:01 +01002661 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 sprintf((char *)numbuf, "%d", ai + 1);
2663 name = numbuf;
2664 }
2665 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2666 {
2667 v = &fc->fixvar[fixvar_idx++].var;
2668 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002669 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670 }
2671 else
2672 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002673 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 if (v == NULL)
2675 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002676 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002679 // Note: the values are copied directly to avoid alloc/free.
2680 // "argvars" must have VAR_FIXED for v_lock.
2681 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682 v->di_tv.v_lock = VAR_FIXED;
2683
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002684 if (isdefault)
2685 // Need to free this later, no matter where it's stored.
2686 tv_to_free[tv_to_free_len++] = &v->di_tv;
2687
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688 if (addlocal)
2689 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002690 // Named arguments should be accessed without the "a:" prefix in
2691 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002692 copy_tv(&v->di_tv, &v->di_tv);
2693 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002695 else
2696 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697
2698 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2699 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002700 listitem_T *li = &fc->l_listitems[ai];
2701
2702 li->li_tv = argvars[i];
2703 li->li_tv.v_lock = VAR_FIXED;
2704 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 }
2706 }
2707
Bram Moolenaare38eab22019-12-05 21:50:01 +01002708 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002710
2711 if (fp->uf_flags & FC_SANDBOX)
2712 {
2713 using_sandbox = TRUE;
2714 ++sandbox;
2715 }
2716
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002717 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002718 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002719 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002721 ++no_wait_return;
2722 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002724 smsg(_("calling %s"), SOURCING_NAME);
2725 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002726 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002727 char_u buf[MSG_BUF_LEN];
2728 char_u numbuf2[NUMBUFLEN];
2729 char_u *tofree;
2730 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002732 msg_puts("(");
2733 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002735 if (i > 0)
2736 msg_puts(", ");
2737 if (argvars[i].v_type == VAR_NUMBER)
2738 msg_outnum((long)argvars[i].vval.v_number);
2739 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002740 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002741 // Do not want errors such as E724 here.
2742 ++emsg_off;
2743 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2744 --emsg_off;
2745 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002747 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002749 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2750 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002752 msg_puts((char *)s);
2753 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 }
2755 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002757 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002759 msg_puts("\n"); // don't overwrite this either
2760
2761 verbose_leave_scroll();
2762 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 }
2764#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002765 if (do_profiling == PROF_YES)
2766 profile_may_start_func(&profile_info, fp,
2767 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768#endif
2769
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002770 save_current_sctx = current_sctx;
2771 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 save_did_emsg = did_emsg;
2773 did_emsg = FALSE;
2774
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002775 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2776 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002777 else if (islambda)
2778 {
2779 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2780
2781 // A Lambda always has the command "return {expr}". It is much faster
2782 // to evaluate {expr} directly.
2783 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002784 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002785 --ex_nesting_level;
2786 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002787 else
2788 // call do_cmdline() to execute the lines
2789 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2791
2792 --RedrawingDisabled;
2793
Bram Moolenaare38eab22019-12-05 21:50:01 +01002794 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2796 {
2797 clear_tv(rettv);
2798 rettv->v_type = VAR_NUMBER;
2799 rettv->vval.v_number = -1;
2800 }
2801
2802#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002803 if (do_profiling == PROF_YES)
2804 {
2805 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2806
2807 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2808 profile_may_end_func(&profile_info, fp, caller);
2809 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810#endif
2811
Bram Moolenaare38eab22019-12-05 21:50:01 +01002812 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 if (p_verbose >= 12)
2814 {
2815 ++no_wait_return;
2816 verbose_enter_scroll();
2817
2818 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002819 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002821 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822 (long)fc->rettv->vval.v_number);
2823 else
2824 {
2825 char_u buf[MSG_BUF_LEN];
2826 char_u numbuf2[NUMBUFLEN];
2827 char_u *tofree;
2828 char_u *s;
2829
Bram Moolenaare38eab22019-12-05 21:50:01 +01002830 // The value may be very long. Skip the middle part, so that we
2831 // have some idea how it starts and ends. smsg() would always
2832 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002833 ++emsg_off;
2834 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2835 --emsg_off;
2836 if (s != NULL)
2837 {
2838 if (vim_strsize(s) > MSG_BUF_CLEN)
2839 {
2840 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2841 s = buf;
2842 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002843 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 vim_free(tofree);
2845 }
2846 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002847 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848
2849 verbose_leave_scroll();
2850 --no_wait_return;
2851 }
2852
Bram Moolenaare31ee862020-01-07 20:59:34 +01002853 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002854 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002855 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856#ifdef FEAT_PROFILE
2857 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002858 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002860 if (using_sandbox)
2861 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002863 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 {
2865 ++no_wait_return;
2866 verbose_enter_scroll();
2867
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002868 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002869 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870
2871 verbose_leave_scroll();
2872 --no_wait_return;
2873 }
2874
2875 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002876 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002877 for (i = 0; i < tv_to_free_len; ++i)
2878 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002879 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880}
2881
2882/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002883 * Check the argument count for user function "fp".
2884 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2885 */
2886 int
2887check_user_func_argcount(ufunc_T *fp, int argcount)
2888{
2889 int regular_args = fp->uf_args.ga_len;
2890
2891 if (argcount < regular_args - fp->uf_def_args.ga_len)
2892 return FCERR_TOOFEW;
2893 else if (!has_varargs(fp) && argcount > regular_args)
2894 return FCERR_TOOMANY;
2895 return FCERR_UNKNOWN;
2896}
2897
2898/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002899 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002900 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002901 int
2902call_user_func_check(
2903 ufunc_T *fp,
2904 int argcount,
2905 typval_T *argvars,
2906 typval_T *rettv,
2907 funcexe_T *funcexe,
2908 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002909{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002910 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002911
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002912 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2913 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002914 error = check_user_func_argcount(fp, argcount);
2915 if (error != FCERR_UNKNOWN)
2916 return error;
2917 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002918 error = FCERR_DICT;
2919 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002920 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002921 int did_save_redo = FALSE;
2922 save_redo_T save_redo;
2923
2924 /*
2925 * Call the user function.
2926 * Save and restore search patterns, script variables and
2927 * redo buffer.
2928 */
2929 save_search_patterns();
2930 if (!ins_compl_active())
2931 {
2932 saveRedobuff(&save_redo);
2933 did_save_redo = TRUE;
2934 }
2935 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002936 call_user_func(fp, argcount, argvars, rettv, funcexe,
2937 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002938 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2939 // Function was unreferenced while being used, free it now.
2940 func_clear_free(fp, FALSE);
2941 if (did_save_redo)
2942 restoreRedobuff(&save_redo);
2943 restore_search_patterns();
2944 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002945 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002946 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002947}
2948
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002949static funccal_entry_T *funccal_stack = NULL;
2950
2951/*
2952 * Save the current function call pointer, and set it to NULL.
2953 * Used when executing autocommands and for ":source".
2954 */
2955 void
2956save_funccal(funccal_entry_T *entry)
2957{
2958 entry->top_funccal = current_funccal;
2959 entry->next = funccal_stack;
2960 funccal_stack = entry;
2961 current_funccal = NULL;
2962}
2963
2964 void
2965restore_funccal(void)
2966{
2967 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002968 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002969 else
2970 {
2971 current_funccal = funccal_stack->top_funccal;
2972 funccal_stack = funccal_stack->next;
2973 }
2974}
2975
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002976 funccall_T *
2977get_current_funccal(void)
2978{
2979 return current_funccal;
2980}
2981
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002982/*
2983 * Mark all functions of script "sid" as deleted.
2984 */
2985 void
2986delete_script_functions(int sid)
2987{
2988 hashitem_T *hi;
2989 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002990 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002991 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002992 size_t len;
2993
2994 buf[0] = K_SPECIAL;
2995 buf[1] = KS_EXTRA;
2996 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002997 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002998 len = STRLEN(buf);
2999
Bram Moolenaarce658352020-07-31 23:47:12 +02003000 while (todo > 0)
3001 {
3002 todo = func_hashtab.ht_used;
3003 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3004 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003005 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003006 fp = HI2UF(hi);
3007 if (STRNCMP(fp->uf_name, buf, len) == 0)
3008 {
3009 int changed = func_hashtab.ht_changed;
3010
3011 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003012
3013 if (fp->uf_calls > 0)
3014 {
3015 // Function is executing, don't free it but do remove
3016 // it from the hashtable.
3017 if (func_remove(fp))
3018 fp->uf_refcount--;
3019 }
3020 else
3021 {
3022 func_clear(fp, TRUE);
3023 // When clearing a function another function can be
3024 // cleared as a side effect. When that happens start
3025 // over.
3026 if (changed != func_hashtab.ht_changed)
3027 break;
3028 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003029 }
3030 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003031 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003032 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003033}
3034
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035#if defined(EXITFREE) || defined(PROTO)
3036 void
3037free_all_functions(void)
3038{
3039 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003040 ufunc_T *fp;
3041 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003042 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003043 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044
Bram Moolenaare38eab22019-12-05 21:50:01 +01003045 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003046 while (current_funccal != NULL)
3047 {
3048 clear_tv(current_funccal->rettv);
3049 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003050 if (current_funccal == NULL && funccal_stack != NULL)
3051 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003052 }
3053
Bram Moolenaare38eab22019-12-05 21:50:01 +01003054 // First clear what the functions contain. Since this may lower the
3055 // reference count of a function, it may also free a function and change
3056 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003057 while (todo > 0)
3058 {
3059 todo = func_hashtab.ht_used;
3060 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3061 if (!HASHITEM_EMPTY(hi))
3062 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003063 // clear the def function index now
3064 fp = HI2UF(hi);
3065 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003066 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003067
Bram Moolenaare38eab22019-12-05 21:50:01 +01003068 // Only free functions that are not refcounted, those are
3069 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003070 if (func_name_refcount(fp->uf_name))
3071 ++skipped;
3072 else
3073 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003074 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003075 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003076 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003077 {
3078 skipped = 0;
3079 break;
3080 }
3081 }
3082 --todo;
3083 }
3084 }
3085
Bram Moolenaare38eab22019-12-05 21:50:01 +01003086 // Now actually free the functions. Need to start all over every time,
3087 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003088 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003089 while (func_hashtab.ht_used > skipped)
3090 {
3091 todo = func_hashtab.ht_used;
3092 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003093 if (!HASHITEM_EMPTY(hi))
3094 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003095 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003096 // Only free functions that are not refcounted, those are
3097 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003098 fp = HI2UF(hi);
3099 if (func_name_refcount(fp->uf_name))
3100 ++skipped;
3101 else
3102 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003103 if (func_free(fp, FALSE) == OK)
3104 {
3105 skipped = 0;
3106 break;
3107 }
3108 // did not actually free it
3109 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003110 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003112 }
3113 if (skipped == 0)
3114 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003115
3116 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003117}
3118#endif
3119
3120/*
3121 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02003122 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 * "len" is the length of "name", or -1 for NUL terminated.
3124 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003125 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126builtin_function(char_u *name, int len)
3127{
3128 char_u *p;
3129
Bram Moolenaara26b9702020-04-18 19:53:28 +02003130 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 return FALSE;
3132 p = vim_strchr(name, AUTOLOAD_CHAR);
3133 return p == NULL || (len > 0 && p > name + len);
3134}
3135
3136 int
3137func_call(
3138 char_u *name,
3139 typval_T *args,
3140 partial_T *partial,
3141 dict_T *selfdict,
3142 typval_T *rettv)
3143{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003144 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145 listitem_T *item;
3146 typval_T argv[MAX_FUNC_ARGS + 1];
3147 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 int r = 0;
3149
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003150 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003151 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 {
3153 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3154 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003155 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003156 break;
3157 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003158 // Make a copy of each argument. This is needed to be able to set
3159 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 copy_tv(&item->li_tv, &argv[argc++]);
3161 }
3162
3163 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003164 {
3165 funcexe_T funcexe;
3166
Bram Moolenaara80faa82020-04-12 19:37:17 +02003167 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003168 funcexe.fe_firstline = curwin->w_cursor.lnum;
3169 funcexe.fe_lastline = curwin->w_cursor.lnum;
3170 funcexe.fe_evaluate = TRUE;
3171 funcexe.fe_partial = partial;
3172 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003173 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3174 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175
Bram Moolenaare38eab22019-12-05 21:50:01 +01003176 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 while (argc > 0)
3178 clear_tv(&argv[--argc]);
3179
3180 return r;
3181}
3182
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003183static int callback_depth = 0;
3184
3185 int
3186get_callback_depth(void)
3187{
3188 return callback_depth;
3189}
3190
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003192 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003193 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003194 */
3195 int
3196call_callback(
3197 callback_T *callback,
3198 int len, // length of "name" or -1 to use strlen()
3199 typval_T *rettv, // return value goes here
3200 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003201 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003202 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003203{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003204 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003205 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003206
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003207 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3208 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003209 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003210 funcexe.fe_evaluate = TRUE;
3211 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003212 ++callback_depth;
3213 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3214 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003215
3216 // When a :def function was called that uses :try an error would be turned
3217 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003218 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003219 {
3220 need_rethrow = FALSE;
3221 handle_did_throw();
3222 }
3223
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003224 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003225}
3226
3227/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003228 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003229 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003230 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3231 */
3232 varnumber_T
3233call_callback_retnr(
3234 callback_T *callback,
3235 int argcount, // number of "argvars"
3236 typval_T *argvars) // vars for arguments, must have "argcount"
3237 // PLUS ONE elements!
3238{
3239 typval_T rettv;
3240 varnumber_T retval;
3241
3242 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003243 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003244
3245 retval = tv_get_number_chk(&rettv, NULL);
3246 clear_tv(&rettv);
3247 return retval;
3248}
3249
3250/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251 * Give an error message for the result of a function.
3252 * Nothing if "error" is FCERR_NONE.
3253 */
3254 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003255user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003256{
3257 switch (error)
3258 {
3259 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003260 if (funcexe->fe_found_var)
3261 semsg(_(e_not_callable_type_str), name);
3262 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003263 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003264 break;
3265 case FCERR_NOTMETHOD:
3266 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003267 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 break;
3269 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003270 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003271 break;
3272 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003273 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003274 break;
3275 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003276 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003277 break;
3278 case FCERR_SCRIPT:
3279 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003280 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003281 break;
3282 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003283 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3284 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285 break;
3286 }
3287}
3288
3289/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003290 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003291 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 * Return FAIL when the function can't be called, OK otherwise.
3293 * Also returns OK when an error was encountered while executing the function.
3294 */
3295 int
3296call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003297 char_u *funcname, // name of the function
3298 int len, // length of "name" or -1 to use strlen()
3299 typval_T *rettv, // return value goes here
3300 int argcount_in, // number of "argvars"
3301 typval_T *argvars_in, // vars for arguments, must have "argcount"
3302 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003303 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304{
3305 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003306 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003308 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 char_u fname_buf[FLEN_FIXED + 1];
3310 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003311 char_u *fname = NULL;
3312 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 int argcount = argcount_in;
3314 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003315 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003316 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003317 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003319 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003320 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003321 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003322 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003324 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3325 // even when call_func() returns FAIL.
3326 rettv->v_type = VAR_UNKNOWN;
3327
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003328 if (partial != NULL)
3329 fp = partial->pt_func;
3330 if (fp == NULL)
3331 {
3332 // Make a copy of the name, if it comes from a funcref variable it
3333 // could be changed or deleted in the called function.
3334 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3335 if (name == NULL)
3336 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003338 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3339 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003341 if (funcexe->fe_doesrange != NULL)
3342 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343
3344 if (partial != NULL)
3345 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003346 // When the function has a partial with a dict and there is a dict
3347 // argument, use the dict argument. That is backwards compatible.
3348 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003349 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003351 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 {
3353 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003354 {
3355 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3356 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003357 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003358 goto theend;
3359 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 for (i = 0; i < argcount_in; ++i)
3363 argv[i + argv_clear] = argvars_in[i];
3364 argvars = argv;
3365 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003366
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003367 if (funcexe->fe_check_type != NULL
3368 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003369 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003370 // Now funcexe->fe_check_type is missing the added arguments,
3371 // make a copy of the type with the correction.
3372 check_type = *funcexe->fe_check_type;
3373 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003374 check_type.tt_args = check_type_args;
3375 CLEAR_FIELD(check_type_args);
3376 for (i = 0; i < check_type.tt_argcount; ++i)
3377 check_type_args[i + partial->pt_argc] =
3378 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003379 check_type.tt_argcount += partial->pt_argc;
3380 check_type.tt_min_argcount += partial->pt_argc;
3381 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382 }
3383 }
3384
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003385 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3386 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003387 {
3388 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003389 if (check_argument_types(funcexe->fe_check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003390 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003391 error = FCERR_OTHER;
3392 }
3393
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003394 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395 {
3396 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003397 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398
Bram Moolenaar333894b2020-08-01 18:53:07 +02003399 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003400 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003401 {
3402 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003404 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405
Bram Moolenaare38eab22019-12-05 21:50:01 +01003406 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003408 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003410 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411 {
3412 /*
3413 * User defined function.
3414 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003415 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003416 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417
Bram Moolenaare38eab22019-12-05 21:50:01 +01003418 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419 if (fp == NULL
3420 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003421 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 && !aborting())
3423 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003424 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003425 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003427 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3429 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003430 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003431 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003432 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003433 if (fp == NULL)
3434 {
3435 char_u *p = untrans_function_name(rfname);
3436
3437 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003438 // Don't do this if the name starts with "s:".
3439 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003440 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003441 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003443 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003444 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003445#ifdef FEAT_LUA
3446 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3447 {
3448 cfunc_T cb = fp->uf_cb;
3449
3450 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3451 }
3452#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003453 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003455 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003456 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003457 argcount = funcexe->fe_argv_func(argcount, argvars,
3458 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003459
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003460 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003461 {
3462 // Method call: base->Method()
3463 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003464 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003465 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003466 argvars = argv;
3467 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003468 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003469
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 error = call_user_func_check(fp, argcount, argvars, rettv,
3471 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 }
3473 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003474 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003475 {
3476 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003477 * expr->method(): Find the method name in the table, call its
3478 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003479 */
3480 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003481 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003482 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003483 else
3484 {
3485 /*
3486 * Find the function name in the table, call its implementation.
3487 */
3488 error = call_internal_func(fname, argcount, argvars, rettv);
3489 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003490
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003491 /*
3492 * The function call (or "FuncUndefined" autocommand sequence) might
3493 * have been aborted by an error, an interrupt, or an explicitly thrown
3494 * exception that has not been caught so far. This situation can be
3495 * tested for by calling aborting(). For an error in an internal
3496 * function or for the "E132" error in call_user_func(), however, the
3497 * throw point at which the "force_abort" flag (temporarily reset by
3498 * emsg()) is normally updated has not been reached yet. We need to
3499 * update that flag first to make aborting() reliable.
3500 */
3501 update_force_abort();
3502 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003503 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 ret = OK;
3505
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003506theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 /*
3508 * Report an error unless the argument evaluation or function call has been
3509 * cancelled due to an aborting error, an interrupt, or an exception.
3510 */
3511 if (!aborting())
3512 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003513 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514 }
3515
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003516 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003517 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003518 clear_tv(&argv[--argv_clear + argv_base]);
3519
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 vim_free(tofree);
3521 vim_free(name);
3522
3523 return ret;
3524}
3525
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003526 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003527printable_func_name(ufunc_T *fp)
3528{
3529 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3530}
3531
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003533 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534 */
3535 static void
3536list_func_head(ufunc_T *fp, int indent)
3537{
3538 int j;
3539
3540 msg_start();
3541 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003542 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003543 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003544 msg_puts("def ");
3545 else
3546 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003547 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003548 msg_putchar('(');
3549 for (j = 0; j < fp->uf_args.ga_len; ++j)
3550 {
3551 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003552 msg_puts(", ");
3553 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003554 if (fp->uf_arg_types != NULL)
3555 {
3556 char *tofree;
3557
3558 msg_puts(": ");
3559 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3560 vim_free(tofree);
3561 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003562 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3563 {
3564 msg_puts(" = ");
3565 msg_puts(((char **)(fp->uf_def_args.ga_data))
3566 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3567 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 }
3569 if (fp->uf_varargs)
3570 {
3571 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003572 msg_puts(", ");
3573 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003574 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003575 if (fp->uf_va_name != NULL)
3576 {
3577 if (j)
3578 msg_puts(", ");
3579 msg_puts("...");
3580 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003581 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003582 {
3583 char *tofree;
3584
3585 msg_puts(": ");
3586 msg_puts(type_name(fp->uf_va_type, &tofree));
3587 vim_free(tofree);
3588 }
3589 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003591
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003592 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003593 {
3594 if (fp->uf_ret_type != &t_void)
3595 {
3596 char *tofree;
3597
3598 msg_puts(": ");
3599 msg_puts(type_name(fp->uf_ret_type, &tofree));
3600 vim_free(tofree);
3601 }
3602 }
3603 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003604 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003606 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003608 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003609 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003610 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 msg_clr_eos();
3612 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003613 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614}
3615
3616/*
3617 * Get a function name, translating "<SID>" and "<SNR>".
3618 * Also handles a Funcref in a List or Dictionary.
3619 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003620 * Set "*is_global" to TRUE when the function must be global, unless
3621 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 * flags:
3623 * TFN_INT: internal function name OK
3624 * TFN_QUIET: be quiet
3625 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003626 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 * Advances "pp" to just after the function name (if no error).
3628 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003629 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630trans_function_name(
3631 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003632 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003633 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003635 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003636 partial_T **partial, // return: partial of a FuncRef
3637 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638{
3639 char_u *name = NULL;
3640 char_u *start;
3641 char_u *end;
3642 int lead;
3643 char_u sid_buf[20];
3644 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003645 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003647 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648
3649 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003650 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 start = *pp;
3652
Bram Moolenaare38eab22019-12-05 21:50:01 +01003653 // Check for hard coded <SNR>: already translated function ID (from a user
3654 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3656 && (*pp)[2] == (int)KE_SNR)
3657 {
3658 *pp += 3;
3659 len = get_id_len(pp) + 3;
3660 return vim_strnsave(start, len);
3661 }
3662
Bram Moolenaare38eab22019-12-05 21:50:01 +01003663 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3664 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 lead = eval_fname_script(start);
3666 if (lead > 2)
3667 start += lead;
3668
Bram Moolenaare38eab22019-12-05 21:50:01 +01003669 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003670 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 lead > 2 ? 0 : FNE_CHECK_START);
3672 if (end == start)
3673 {
3674 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003675 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 goto theend;
3677 }
3678 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3679 {
3680 /*
3681 * Report an invalid expression in braces, unless the expression
3682 * evaluation has been cancelled due to an aborting error, an
3683 * interrupt, or an exception.
3684 */
3685 if (!aborting())
3686 {
3687 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003688 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 }
3690 else
3691 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3692 goto theend;
3693 }
3694
3695 if (lv.ll_tv != NULL)
3696 {
3697 if (fdp != NULL)
3698 {
3699 fdp->fd_dict = lv.ll_dict;
3700 fdp->fd_newkey = lv.ll_newkey;
3701 lv.ll_newkey = NULL;
3702 fdp->fd_di = lv.ll_di;
3703 }
3704 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3705 {
3706 name = vim_strsave(lv.ll_tv->vval.v_string);
3707 *pp = end;
3708 }
3709 else if (lv.ll_tv->v_type == VAR_PARTIAL
3710 && lv.ll_tv->vval.v_partial != NULL)
3711 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003712 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 *pp = end;
3714 if (partial != NULL)
3715 *partial = lv.ll_tv->vval.v_partial;
3716 }
3717 else
3718 {
3719 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3720 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003721 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 else
3723 *pp = end;
3724 name = NULL;
3725 }
3726 goto theend;
3727 }
3728
3729 if (lv.ll_name == NULL)
3730 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003731 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732 *pp = end;
3733 goto theend;
3734 }
3735
Bram Moolenaare38eab22019-12-05 21:50:01 +01003736 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 if (lv.ll_exp_name != NULL)
3738 {
3739 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003740 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003741 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742 if (name == lv.ll_exp_name)
3743 name = NULL;
3744 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003745 else if (lv.ll_sid > 0)
3746 {
3747 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3748 int cc = *lv.ll_name_end;
3749
3750 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3751 *lv.ll_name_end = NUL;
3752 if (si->sn_autoload_prefix != NULL)
3753 {
3754 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3755 }
3756 else
3757 {
3758 sid_buf[0] = K_SPECIAL;
3759 sid_buf[1] = KS_EXTRA;
3760 sid_buf[2] = (int)KE_SNR;
3761 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
3762 "%ld_", (long)current_sctx.sc_sid);
3763 name = concat_str(sid_buf, lv.ll_name);
3764 }
3765 *lv.ll_name_end = cc;
3766 *pp = end;
3767 goto theend;
3768 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003769 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003770 {
3771 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003772 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003773 flags & TFN_NO_AUTOLOAD, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 if (name == *pp)
3775 name = NULL;
3776 }
3777 if (name != NULL)
3778 {
3779 name = vim_strsave(name);
3780 *pp = end;
3781 if (STRNCMP(name, "<SNR>", 5) == 0)
3782 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003783 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003784 name[0] = K_SPECIAL;
3785 name[1] = KS_EXTRA;
3786 name[2] = (int)KE_SNR;
3787 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3788 }
3789 goto theend;
3790 }
3791
3792 if (lv.ll_exp_name != NULL)
3793 {
3794 len = (int)STRLEN(lv.ll_exp_name);
3795 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3796 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3797 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003798 // When there was "s:" already or the name expanded to get a
3799 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 lv.ll_name += 2;
3801 len -= 2;
3802 lead = 2;
3803 }
3804 }
3805 else
3806 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003807 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003809 {
3810 if (is_global != NULL && lv.ll_name[0] == 'g')
3811 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003813 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 len = (int)(end - lv.ll_name);
3815 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003816 if (len <= 0)
3817 {
3818 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003819 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003820 goto theend;
3821 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003823 // In Vim9 script a user function is script-local by default, unless it
3824 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003825 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003826 if (vim9script)
3827 {
3828 char_u *p;
3829
3830 // SomeScript#func() is a global function.
3831 for (p = start; *p != NUL && *p != '('; ++p)
3832 if (*p == AUTOLOAD_CHAR)
3833 vim9script = FALSE;
3834 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003835
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 /*
3837 * Copy the function name to allocated memory.
3838 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3839 * Accept <SNR>123_name() outside a script.
3840 */
3841 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003842 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003843 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003845 if (!vim9script)
3846 lead = 3;
3847 if (vim9script || (lv.ll_exp_name != NULL
3848 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 || eval_fname_sid(*pp))
3850 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003851 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003852 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003854 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 goto theend;
3856 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003857 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003858 if (vim9script)
3859 extra = 3 + (int)STRLEN(sid_buf);
3860 else
3861 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003862 }
3863 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003864 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3865 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003867 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 goto theend;
3869 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003870 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 {
3872 char_u *cp = vim_strchr(lv.ll_name, ':');
3873
3874 if (cp != NULL && cp < end)
3875 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003876 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 goto theend;
3878 }
3879 }
3880
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003881 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882 if (name != NULL)
3883 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003884 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885 {
3886 name[0] = K_SPECIAL;
3887 name[1] = KS_EXTRA;
3888 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003889 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003890 STRCPY(name + 3, sid_buf);
3891 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003892 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3893 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 }
3895 *pp = end;
3896
3897theend:
3898 clear_lval(&lv);
3899 return name;
3900}
3901
3902/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003903 * Assuming "name" is the result of trans_function_name() and it was prefixed
3904 * to use the script-local name, return the unmodified name (points into
3905 * "name"). Otherwise return NULL.
3906 * This can be used to first search for a script-local function and fall back
3907 * to the global function if not found.
3908 */
3909 char_u *
3910untrans_function_name(char_u *name)
3911{
3912 char_u *p;
3913
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003914 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003915 {
3916 p = vim_strchr(name, '_');
3917 if (p != NULL)
3918 return p + 1;
3919 }
3920 return NULL;
3921}
3922
3923/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003924 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3925 * current script ID and returns the expanded function name. The caller should
3926 * free the returned name. If not called from a script context or the function
3927 * name doesn't start with these prefixes, then returns NULL.
3928 * This doesn't check whether the script-local function exists or not.
3929 */
3930 char_u *
3931get_scriptlocal_funcname(char_u *funcname)
3932{
3933 char sid_buf[25];
3934 int off;
3935 char_u *newname;
3936
3937 if (funcname == NULL)
3938 return NULL;
3939
3940 if (STRNCMP(funcname, "s:", 2) != 0
3941 && STRNCMP(funcname, "<SID>", 5) != 0)
3942 // The function name is not a script-local function name
3943 return NULL;
3944
3945 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3946 {
3947 emsg(_(e_using_sid_not_in_script_context));
3948 return NULL;
3949 }
3950 // Expand s: prefix into <SNR>nr_<name>
3951 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3952 (long)current_sctx.sc_sid);
3953 off = *funcname == 's' ? 2 : 5;
3954 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3955 if (newname == NULL)
3956 return NULL;
3957 STRCPY(newname, sid_buf);
3958 STRCAT(newname, funcname + off);
3959
3960 return newname;
3961}
3962
3963/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003964 * Call trans_function_name(), except that a lambda is returned as-is.
3965 * Returns the name in allocated memory.
3966 */
3967 char_u *
3968save_function_name(
3969 char_u **name,
3970 int *is_global,
3971 int skip,
3972 int flags,
3973 funcdict_T *fudi)
3974{
3975 char_u *p = *name;
3976 char_u *saved;
3977
3978 if (STRNCMP(p, "<lambda>", 8) == 0)
3979 {
3980 p += 8;
3981 (void)getdigits(&p);
3982 saved = vim_strnsave(*name, p - *name);
3983 if (fudi != NULL)
3984 CLEAR_POINTER(fudi);
3985 }
3986 else
3987 saved = trans_function_name(&p, is_global, skip,
3988 flags, fudi, NULL, NULL);
3989 *name = p;
3990 return saved;
3991}
3992
3993/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003994 * List functions. When "regmatch" is NULL all of then.
3995 * Otherwise functions matching "regmatch".
3996 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003997 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003998list_functions(regmatch_T *regmatch)
3999{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004000 int changed = func_hashtab.ht_changed;
4001 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004002 hashitem_T *hi;
4003
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004004 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004005 {
4006 if (!HASHITEM_EMPTY(hi))
4007 {
4008 ufunc_T *fp = HI2UF(hi);
4009
4010 --todo;
4011 if ((fp->uf_flags & FC_DEAD) == 0
4012 && (regmatch == NULL
4013 ? !message_filtered(fp->uf_name)
4014 && !func_name_refcount(fp->uf_name)
4015 : !isdigit(*fp->uf_name)
4016 && vim_regexec(regmatch, fp->uf_name, 0)))
4017 {
4018 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004019 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004020 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004021 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004022 return;
4023 }
4024 }
4025 }
4026 }
4027}
4028
4029/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004030 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004031 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4032 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004033 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004034 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004036 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004037define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 int j;
4040 int c;
4041 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004042 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004043 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 char_u *p;
4045 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004046 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004047 char_u *line_arg = NULL;
4048 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004049 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004050 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004051 garray_T newlines;
4052 int varargs = FALSE;
4053 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004054 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004055 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004056 int fp_allocated = FALSE;
4057 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004058 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 dictitem_T *v;
4060 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004061 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004064 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004065 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004066 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067
4068 /*
4069 * ":function" without argument: list functions.
4070 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004071 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072 {
4073 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004074 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004075 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004076 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 }
4078
4079 /*
4080 * ":function /pat": list functions matching pattern.
4081 */
4082 if (*eap->arg == '/')
4083 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004084 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085 if (!eap->skip)
4086 {
4087 regmatch_T regmatch;
4088
4089 c = *p;
4090 *p = NUL;
4091 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4092 *p = c;
4093 if (regmatch.regprog != NULL)
4094 {
4095 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004096 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 vim_regfree(regmatch.regprog);
4098 }
4099 }
4100 if (*p == '/')
4101 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004102 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004103 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 }
4105
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004106 ga_init(&newargs);
4107 ga_init(&argtypes);
4108 ga_init(&default_args);
4109
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 /*
4111 * Get the function name. There are these situations:
4112 * func normal function name
4113 * "name" == func, "fudi.fd_dict" == NULL
4114 * dict.func new dictionary entry
4115 * "name" == NULL, "fudi.fd_dict" set,
4116 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4117 * dict.func existing dict entry with a Funcref
4118 * "name" == func, "fudi.fd_dict" set,
4119 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4120 * dict.func existing dict entry that's not a Funcref
4121 * "name" == NULL, "fudi.fd_dict" set,
4122 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4123 * s:func script-local function name
4124 * g:func global function name, same as "func"
4125 */
4126 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004127 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004129 // nested function, argument is (args).
4130 paren = TRUE;
4131 CLEAR_FIELD(fudi);
4132 }
4133 else
4134 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004135 name = save_function_name(&p, &is_global, eap->skip,
4136 TFN_NO_AUTOLOAD, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004137 paren = (vim_strchr(p, '(') != NULL);
4138 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004140 /*
4141 * Return on an invalid expression in braces, unless the expression
4142 * evaluation has been cancelled due to an aborting error, an
4143 * interrupt, or an exception.
4144 */
4145 if (!aborting())
4146 {
4147 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004148 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004149 vim_free(fudi.fd_newkey);
4150 return NULL;
4151 }
4152 else
4153 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004155
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004156 // For "export def FuncName()" in an autoload script the function name
4157 // is stored with the legacy autoload name "dir#script#FuncName" so
4158 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004159 if (is_export && name != NULL)
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004160 name = may_prefix_autoload(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004161 }
4162
Bram Moolenaare38eab22019-12-05 21:50:01 +01004163 // An error in a function call during evaluation of an expression in magic
4164 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 saved_did_emsg = did_emsg;
4166 did_emsg = FALSE;
4167
4168 /*
4169 * ":function func" with only function name: list function.
4170 */
4171 if (!paren)
4172 {
4173 if (!ends_excmd(*skipwhite(p)))
4174 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004175 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 goto ret_free;
4177 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004178 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 if (eap->nextcmd != NULL)
4180 *p = NUL;
4181 if (!eap->skip && !got_int)
4182 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004183 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004184 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4185 {
4186 char_u *up = untrans_function_name(name);
4187
4188 // With Vim9 script the name was made script-local, if not
4189 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004190 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004191 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004192 }
4193
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 if (fp != NULL)
4195 {
4196 list_func_head(fp, TRUE);
4197 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4198 {
4199 if (FUNCLINE(fp, j) == NULL)
4200 continue;
4201 msg_putchar('\n');
4202 msg_outnum((long)(j + 1));
4203 if (j < 9)
4204 msg_putchar(' ');
4205 if (j < 99)
4206 msg_putchar(' ');
4207 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004208 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209 ui_breakcheck();
4210 }
4211 if (!got_int)
4212 {
4213 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004214 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004215 msg_puts(" enddef");
4216 else
4217 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218 }
4219 }
4220 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004221 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222 }
4223 goto ret_free;
4224 }
4225
4226 /*
4227 * ":function name(arg1, arg2)" Define function.
4228 */
4229 p = skipwhite(p);
4230 if (*p != '(')
4231 {
4232 if (!eap->skip)
4233 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004234 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235 goto ret_free;
4236 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004237 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238 if (vim_strchr(p, '(') != NULL)
4239 p = vim_strchr(p, '(');
4240 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004242 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4243 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004244 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004245 goto ret_free;
4246 }
4247
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004248 // In Vim9 script only global functions can be redefined.
4249 if (vim9script && eap->forceit && !is_global)
4250 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004251 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004252 goto ret_free;
4253 }
4254
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004255 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256
Bram Moolenaar04b12692020-05-04 23:24:44 +02004257 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004259 // Check the name of the function. Unless it's a dictionary function
4260 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004261 if (name != NULL)
4262 arg = name;
4263 else
4264 arg = fudi.fd_newkey;
4265 if (arg != NULL && (fudi.fd_di == NULL
4266 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4267 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4268 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004269 char_u *name_base = arg;
4270 int i;
4271
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004272 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004273 {
4274 name_base = vim_strchr(arg, '_');
4275 if (name_base == NULL)
4276 name_base = arg + 3;
4277 else
4278 ++name_base;
4279 }
4280 for (i = 0; name_base[i] != NUL && (i == 0
4281 ? eval_isnamec1(name_base[i])
4282 : eval_isnamec(name_base[i])); ++i)
4283 ;
4284 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004285 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004286
4287 // In Vim9 script a function cannot have the same name as a
4288 // variable.
4289 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004290 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4291 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004292 + EVAL_VAR_NO_FUNC) == OK)
4293 {
4294 semsg(_(e_redefining_script_item_str), name_base);
4295 goto ret_free;
4296 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004298 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004300 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004301 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004302 goto ret_free;
4303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 }
4305
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004306 // This may get more lines and make the pointers into the first line
4307 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004308 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004309 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004310 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004311 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004312 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004314 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004316 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004318 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004319 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004321 if (*p != ':')
4322 {
4323 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4324 p = skipwhite(p);
4325 }
4326 else if (!IS_WHITE_OR_NUL(p[1]))
4327 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004328 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004329 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004330 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004331 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004332 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004333 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004334 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004335 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004336 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004337 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004338 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004339 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004340 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004342 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004344 else
4345 // find extra arguments "range", "dict", "abort" and "closure"
4346 for (;;)
4347 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004348 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004349 p = skipwhite(p);
4350 if (STRNCMP(p, "range", 5) == 0)
4351 {
4352 flags |= FC_RANGE;
4353 p += 5;
4354 }
4355 else if (STRNCMP(p, "dict", 4) == 0)
4356 {
4357 flags |= FC_DICT;
4358 p += 4;
4359 }
4360 else if (STRNCMP(p, "abort", 5) == 0)
4361 {
4362 flags |= FC_ABORT;
4363 p += 5;
4364 }
4365 else if (STRNCMP(p, "closure", 7) == 0)
4366 {
4367 flags |= FC_CLOSURE;
4368 p += 7;
4369 if (current_funccal == NULL)
4370 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004371 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004372 name == NULL ? (char_u *)"" : name);
4373 goto erret;
4374 }
4375 }
4376 else
4377 break;
4378 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004379
Bram Moolenaare38eab22019-12-05 21:50:01 +01004380 // When there is a line break use what follows for the function body.
4381 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 if (*p == '\n')
4383 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004384 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004385 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4386 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004387 && !(VIM_ISWHITE(*whitep) && *p == '#'
4388 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004389 && !eap->skip
4390 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004391 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392
4393 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004394 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4395 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396 */
4397 if (KeyTyped)
4398 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004399 // Check if the function already exists, don't let the user type the
4400 // whole function before telling him it doesn't work! For a script we
4401 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 if (!eap->skip && !eap->forceit)
4403 {
4404 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004405 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004406 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004407 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 }
4409
4410 if (!eap->skip && did_emsg)
4411 goto erret;
4412
Bram Moolenaare38eab22019-12-05 21:50:01 +01004413 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414 cmdline_row = msg_row;
4415 }
4416
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004417 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004418 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004419
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004420 // Do not define the function when getting the body fails and when
4421 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004422 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004423 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424 goto erret;
4425
4426 /*
4427 * If there are no errors, add the function
4428 */
4429 if (fudi.fd_dict == NULL)
4430 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004431 hashtab_T *ht;
4432
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004433 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4435 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004436 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 goto erret;
4438 }
4439
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004440 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004441 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004443 char_u *uname = untrans_function_name(name);
4444
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004445 import = find_imported(uname == NULL ? name : uname, 0, FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004446 }
4447
4448 if (fp != NULL || import != NULL)
4449 {
4450 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004451
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004452 // Function can be replaced with "function!" and when sourcing the
4453 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004454 // A name that is used by an import can not be overruled.
4455 if (import != NULL
4456 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004457 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004458 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004460 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004461 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004462 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004463 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004464 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 goto erret;
4466 }
4467 if (fp->uf_calls > 0)
4468 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004469 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004470 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 goto erret;
4472 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004473 if (fp->uf_refcount > 1)
4474 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004475 // This function is referenced somewhere, don't redefine it but
4476 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004477 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004478 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004479 fp = NULL;
4480 overwrite = TRUE;
4481 }
4482 else
4483 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004484 char_u *exp_name = fp->uf_name_exp;
4485
4486 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004487 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004488 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004489 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004490 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004491 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004492#ifdef FEAT_PROFILE
4493 fp->uf_profiling = FALSE;
4494 fp->uf_prof_initialized = FALSE;
4495#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004496 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004497 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004498 }
4499 }
4500 else
4501 {
4502 char numbuf[20];
4503
4504 fp = NULL;
4505 if (fudi.fd_newkey == NULL && !eap->forceit)
4506 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004507 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508 goto erret;
4509 }
4510 if (fudi.fd_di == NULL)
4511 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004512 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004513 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 goto erret;
4515 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004516 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004517 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004518 goto erret;
4519
Bram Moolenaare38eab22019-12-05 21:50:01 +01004520 // Give the function a sequential number. Can only be used with a
4521 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004522 vim_free(name);
4523 sprintf(numbuf, "%d", ++func_nr);
4524 name = vim_strsave((char_u *)numbuf);
4525 if (name == NULL)
4526 goto erret;
4527 }
4528
4529 if (fp == NULL)
4530 {
4531 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4532 {
4533 int slen, plen;
4534 char_u *scriptname;
4535
Bram Moolenaare38eab22019-12-05 21:50:01 +01004536 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004538 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539 {
4540 scriptname = autoload_name(name);
4541 if (scriptname != NULL)
4542 {
4543 p = vim_strchr(scriptname, '/');
4544 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004545 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004547 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 j = OK;
4549 vim_free(scriptname);
4550 }
4551 }
4552 if (j == FAIL)
4553 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004554 linenr_T save_lnum = SOURCING_LNUM;
4555
4556 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004557 semsg(_(e_function_name_does_not_match_script_file_name_str),
4558 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004559 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004560 goto erret;
4561 }
4562 }
4563
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004564 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565 if (fp == NULL)
4566 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004567 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568
4569 if (fudi.fd_dict != NULL)
4570 {
4571 if (fudi.fd_di == NULL)
4572 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004573 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004574 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4575 if (fudi.fd_di == NULL)
4576 {
4577 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004578 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579 goto erret;
4580 }
4581 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4582 {
4583 vim_free(fudi.fd_di);
4584 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004585 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004586 goto erret;
4587 }
4588 }
4589 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004590 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591 clear_tv(&fudi.fd_di->di_tv);
4592 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594
Bram Moolenaare38eab22019-12-05 21:50:01 +01004595 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 flags |= FC_DICT;
4597 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598 }
4599 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004600 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004601 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004602 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004603
4604 if (eap->cmdidx == CMD_def)
4605 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004606 int lnum_save = SOURCING_LNUM;
4607 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004608
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004609 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004610
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004611 // error messages are for the first function line
4612 SOURCING_LNUM = sourcing_lnum_top;
4613
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004614 // The function may use script variables from the context.
4615 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004616
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004617 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004618 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004619 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004620 free_fp = fp_allocated;
4621 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004622 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004623 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004624
4625 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004626 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004627 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004628 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004629 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004630 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004631 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004632 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004633 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004634 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004635 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004636
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004637 if (fp_allocated)
4638 {
4639 // insert the new function in the function list
4640 set_ufunc_name(fp, name);
4641 if (overwrite)
4642 {
4643 hi = hash_find(&func_hashtab, name);
4644 hi->hi_key = UF2HIKEY(fp);
4645 }
4646 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4647 {
4648 free_fp = TRUE;
4649 goto erret;
4650 }
4651 fp->uf_refcount = 1;
4652 }
4653
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004654 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004655 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004656 if ((flags & FC_CLOSURE) != 0)
4657 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004658 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004659 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004660 }
4661 else
4662 fp->uf_scoped = NULL;
4663
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665 if (prof_def_func())
4666 func_do_profile(fp);
4667#endif
4668 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004669 if (sandbox)
4670 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004671 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004672 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004673 fp->uf_flags = flags;
4674 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004675 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004676 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004677 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004678 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004679 if (is_export)
4680 {
4681 fp->uf_flags |= FC_EXPORT;
4682 // let ex_export() know the export worked.
4683 is_export = FALSE;
4684 }
4685
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004686 if (eap->cmdidx == CMD_def)
4687 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004688 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4689 // :func does not use Vim9 script syntax, even in a Vim9 script file
4690 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004691
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692 goto ret_free;
4693
4694erret:
4695 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004696 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004697 if (fp != NULL)
4698 {
4699 ga_init(&fp->uf_args);
4700 ga_init(&fp->uf_def_args);
4701 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702errret_2:
4703 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004704 if (fp != NULL)
4705 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004706 if (free_fp)
4707 {
4708 vim_free(fp);
4709 fp = NULL;
4710 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004712 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004714 if (name != name_arg)
4715 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004716 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004718
4719 return fp;
4720}
4721
4722/*
4723 * ":function"
4724 */
4725 void
4726ex_function(exarg_T *eap)
4727{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004728 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004729
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004730 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4731 (void)define_function(eap, NULL, &lines_to_free);
4732 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004733}
4734
4735/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004736 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004737 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004738 */
4739 void
4740ex_defcompile(exarg_T *eap UNUSED)
4741{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004742 long todo = (long)func_hashtab.ht_used;
4743 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004744 hashitem_T *hi;
4745 ufunc_T *ufunc;
4746
4747 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4748 {
4749 if (!HASHITEM_EMPTY(hi))
4750 {
4751 --todo;
4752 ufunc = HI2UF(hi);
4753 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004754 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4755 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004756 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004757 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004758
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004759 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004760 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004761 // a function has been added or removed, need to start over
4762 todo = (long)func_hashtab.ht_used;
4763 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004764 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004765 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004766 }
4767 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004768 }
4769 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770}
4771
4772/*
4773 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4774 * Return 2 if "p" starts with "s:".
4775 * Return 0 otherwise.
4776 */
4777 int
4778eval_fname_script(char_u *p)
4779{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004780 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4781 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4783 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4784 return 5;
4785 if (p[0] == 's' && p[1] == ':')
4786 return 2;
4787 return 0;
4788}
4789
4790 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004791translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004792{
4793 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004794 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004795 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004796}
4797
4798/*
4799 * Return TRUE when "ufunc" has old-style "..." varargs
4800 * or named varargs "...name: type".
4801 */
4802 int
4803has_varargs(ufunc_T *ufunc)
4804{
4805 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806}
4807
4808/*
4809 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004810 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 */
4812 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004813function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004814{
4815 char_u *nm = name;
4816 char_u *p;
4817 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004818 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004819 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004821 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4822 if (no_deref)
4823 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004824 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 nm = skipwhite(nm);
4826
Bram Moolenaare38eab22019-12-05 21:50:01 +01004827 // Only accept "funcname", "funcname ", "funcname (..." and
4828 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004830 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004831 vim_free(p);
4832 return n;
4833}
4834
Bram Moolenaar113e1072019-01-20 15:30:40 +01004835#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836 char_u *
4837get_expanded_name(char_u *name, int check)
4838{
4839 char_u *nm = name;
4840 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004841 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004842
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004843 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004844 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004846 if (p != NULL && *nm == NUL
4847 && (!check || translated_function_exists(p, is_global)))
4848 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849
4850 vim_free(p);
4851 return NULL;
4852}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004853#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004854
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855/*
4856 * Function given to ExpandGeneric() to obtain the list of user defined
4857 * function names.
4858 */
4859 char_u *
4860get_user_func_name(expand_T *xp, int idx)
4861{
4862 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004863 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004864 static hashitem_T *hi;
4865 ufunc_T *fp;
4866
4867 if (idx == 0)
4868 {
4869 done = 0;
4870 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004871 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004872 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004873 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 {
4875 if (done++ > 0)
4876 ++hi;
4877 while (HASHITEM_EMPTY(hi))
4878 ++hi;
4879 fp = HI2UF(hi);
4880
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004881 // don't show dead, dict and lambda functions
4882 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004883 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004884 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885
4886 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004887 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888
4889 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004890 if (xp->xp_context != EXPAND_USER_FUNC
4891 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 {
4893 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004894 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895 STRCAT(IObuff, ")");
4896 }
4897 return IObuff;
4898 }
4899 return NULL;
4900}
4901
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004902/*
4903 * ":delfunction {name}"
4904 */
4905 void
4906ex_delfunction(exarg_T *eap)
4907{
4908 ufunc_T *fp = NULL;
4909 char_u *p;
4910 char_u *name;
4911 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004912 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913
4914 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004915 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4916 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004917 vim_free(fudi.fd_newkey);
4918 if (name == NULL)
4919 {
4920 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004921 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004922 return;
4923 }
4924 if (!ends_excmd(*skipwhite(p)))
4925 {
4926 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00004927 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004928 return;
4929 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004930 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 if (eap->nextcmd != NULL)
4932 *p = NUL;
4933
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004934 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004935 {
4936 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004937 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02004938 vim_free(name);
4939 return;
4940 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004941 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004942 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943 vim_free(name);
4944
4945 if (!eap->skip)
4946 {
4947 if (fp == NULL)
4948 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004949 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004950 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004951 return;
4952 }
4953 if (fp->uf_calls > 0)
4954 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004955 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956 return;
4957 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004958 if (fp->uf_flags & FC_VIM9)
4959 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004960 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004961 return;
4962 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004963
4964 if (fudi.fd_dict != NULL)
4965 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004966 // Delete the dict item that refers to the function, it will
4967 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004968 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4969 }
4970 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004971 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004972 // A normal function (not a numbered function or lambda) has a
4973 // refcount of 1 for the entry in the hashtable. When deleting
4974 // it and the refcount is more than one, it should be kept.
4975 // A numbered function and lambda should be kept if the refcount is
4976 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004977 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004978 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004979 // Function is still referenced somewhere. Don't free it but
4980 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004981 if (func_remove(fp))
4982 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004983 }
4984 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004985 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004986 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004987 }
4988}
4989
4990/*
4991 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004992 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993 */
4994 void
4995func_unref(char_u *name)
4996{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004997 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004998
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004999 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005000 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005001 fp = find_func(name, FALSE, NULL);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005002 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005003 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005005 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005006#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005007 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005008 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005009 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005010}
5011
5012/*
5013 * Unreference a Function: decrement the reference count and free it when it
5014 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005015 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005016 */
5017 void
5018func_ptr_unref(ufunc_T *fp)
5019{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005020 if (fp != NULL && (--fp->uf_refcount <= 0
5021 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5022 && fp->uf_partial->pt_refcount <= 1
5023 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005024 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005025 // Only delete it when it's not being used. Otherwise it's done
5026 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005027 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005028 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005029 }
5030}
5031
5032/*
5033 * Count a reference to a Function.
5034 */
5035 void
5036func_ref(char_u *name)
5037{
5038 ufunc_T *fp;
5039
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005040 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005042 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005043 if (fp != NULL)
5044 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005045 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005046 // Only give an error for a numbered function.
5047 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005048 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005049}
5050
5051/*
5052 * Count a reference to a Function.
5053 */
5054 void
5055func_ptr_ref(ufunc_T *fp)
5056{
5057 if (fp != NULL)
5058 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005059}
5060
5061/*
5062 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5063 * referenced from anywhere that is in use.
5064 */
5065 static int
5066can_free_funccal(funccall_T *fc, int copyID)
5067{
5068 return (fc->l_varlist.lv_copyID != copyID
5069 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005070 && fc->l_avars.dv_copyID != copyID
5071 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005072}
5073
5074/*
5075 * ":return [expr]"
5076 */
5077 void
5078ex_return(exarg_T *eap)
5079{
5080 char_u *arg = eap->arg;
5081 typval_T rettv;
5082 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005083 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005084
5085 if (current_funccal == NULL)
5086 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005087 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005088 return;
5089 }
5090
Bram Moolenaar844fb642021-10-23 13:32:30 +01005091 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005092 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5093
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005094 if (eap->skip)
5095 ++emsg_skip;
5096
5097 eap->nextcmd = NULL;
5098 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005099 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005100 {
5101 if (!eap->skip)
5102 returning = do_return(eap, FALSE, TRUE, &rettv);
5103 else
5104 clear_tv(&rettv);
5105 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005106 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005107 else if (!eap->skip)
5108 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005109 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005110 update_force_abort();
5111
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005112 /*
5113 * Return unless the expression evaluation has been cancelled due to an
5114 * aborting error, an interrupt, or an exception.
5115 */
5116 if (!aborting())
5117 returning = do_return(eap, FALSE, TRUE, NULL);
5118 }
5119
Bram Moolenaare38eab22019-12-05 21:50:01 +01005120 // When skipping or the return gets pending, advance to the next command
5121 // in this line (!returning). Otherwise, ignore the rest of the line.
5122 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005123 if (returning)
5124 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005125 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005126 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127
5128 if (eap->skip)
5129 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005130 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005131}
5132
5133/*
5134 * ":1,25call func(arg1, arg2)" function call.
5135 */
5136 void
5137ex_call(exarg_T *eap)
5138{
5139 char_u *arg = eap->arg;
5140 char_u *startarg;
5141 char_u *name;
5142 char_u *tofree;
5143 int len;
5144 typval_T rettv;
5145 linenr_T lnum;
5146 int doesrange;
5147 int failed = FALSE;
5148 funcdict_T fudi;
5149 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005150 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005151 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005152 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153
Bram Moolenaare6b53242020-07-01 17:28:33 +02005154 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005155 if (eap->skip)
5156 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005157 // trans_function_name() doesn't work well when skipping, use eval0()
5158 // instead to skip to any following command, e.g. for:
5159 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005160 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005161 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162 clear_tv(&rettv);
5163 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005164 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165 return;
5166 }
5167
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005168 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5169 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005170 if (fudi.fd_newkey != NULL)
5171 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005172 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005173 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005174 vim_free(fudi.fd_newkey);
5175 }
5176 if (tofree == NULL)
5177 return;
5178
Bram Moolenaare38eab22019-12-05 21:50:01 +01005179 // Increase refcount on dictionary, it could get deleted when evaluating
5180 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005181 if (fudi.fd_dict != NULL)
5182 ++fudi.fd_dict->dv_refcount;
5183
Bram Moolenaare38eab22019-12-05 21:50:01 +01005184 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5185 // contents. For VAR_PARTIAL get its partial, unless we already have one
5186 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005187 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005188 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005189 in_vim9script() && type == NULL ? &type : NULL, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005190
Bram Moolenaare38eab22019-12-05 21:50:01 +01005191 // Skip white space to allow ":call func ()". Not good, but required for
5192 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005193 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005194 if (*startarg != '(')
5195 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005196 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005197 goto end;
5198 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005199 if (in_vim9script() && startarg > arg)
5200 {
5201 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5202 goto end;
5203 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005204
5205 /*
5206 * When skipping, evaluate the function once, to find the end of the
5207 * arguments.
5208 * When the function takes a range, this is discovered after the first
5209 * call, and the loop is broken.
5210 */
5211 if (eap->skip)
5212 {
5213 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005214 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215 }
5216 else
5217 lnum = eap->line1;
5218 for ( ; lnum <= eap->line2; ++lnum)
5219 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005220 funcexe_T funcexe;
5221
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005222 if (!eap->skip && eap->addr_count > 0)
5223 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005224 if (lnum > curbuf->b_ml.ml_line_count)
5225 {
5226 // If the function deleted lines or switched to another buffer
5227 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005228 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005229 break;
5230 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005231 curwin->w_cursor.lnum = lnum;
5232 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005233 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005234 }
5235 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005236
Bram Moolenaara80faa82020-04-12 19:37:17 +02005237 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005238 funcexe.fe_firstline = eap->line1;
5239 funcexe.fe_lastline = eap->line2;
5240 funcexe.fe_doesrange = &doesrange;
5241 funcexe.fe_evaluate = !eap->skip;
5242 funcexe.fe_partial = partial;
5243 funcexe.fe_selfdict = fudi.fd_dict;
5244 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005245 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005246 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005247 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005248 {
5249 failed = TRUE;
5250 break;
5251 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005252 if (has_watchexpr())
5253 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005254
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005255 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005256 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005257 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258 {
5259 failed = TRUE;
5260 break;
5261 }
5262
5263 clear_tv(&rettv);
5264 if (doesrange || eap->skip)
5265 break;
5266
Bram Moolenaare38eab22019-12-05 21:50:01 +01005267 // Stop when immediately aborting on error, or when an interrupt
5268 // occurred or an exception was thrown but not caught.
5269 // get_func_tv() returned OK, so that the check for trailing
5270 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005271 if (aborting())
5272 break;
5273 }
5274 if (eap->skip)
5275 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005276 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005277
Bram Moolenaar1d341892021-09-18 15:25:52 +02005278 // When inside :try we need to check for following "| catch" or "| endtry".
5279 // Not when there was an error, but do check if an exception was thrown.
5280 if ((!aborting() || did_throw)
5281 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005282 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005283 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005284 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005285 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005286 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005287 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005288 {
5289 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005290 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005292 }
5293 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005294 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005295 }
5296
5297end:
5298 dict_unref(fudi.fd_dict);
5299 vim_free(tofree);
5300}
5301
5302/*
5303 * Return from a function. Possibly makes the return pending. Also called
5304 * for a pending return at the ":endtry" or after returning from an extra
5305 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5306 * when called due to a ":return" command. "rettv" may point to a typval_T
5307 * with the return rettv. Returns TRUE when the return can be carried out,
5308 * FALSE when the return gets pending.
5309 */
5310 int
5311do_return(
5312 exarg_T *eap,
5313 int reanimate,
5314 int is_cmd,
5315 void *rettv)
5316{
5317 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005318 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319
5320 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005321 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005322 current_funccal->returned = FALSE;
5323
5324 /*
5325 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5326 * not in its finally clause (which then is to be executed next) is found.
5327 * In this case, make the ":return" pending for execution at the ":endtry".
5328 * Otherwise, return normally.
5329 */
5330 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5331 if (idx >= 0)
5332 {
5333 cstack->cs_pending[idx] = CSTP_RETURN;
5334
5335 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005336 // A pending return again gets pending. "rettv" points to an
5337 // allocated variable with the rettv of the original ":return"'s
5338 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339 cstack->cs_rettv[idx] = rettv;
5340 else
5341 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005342 // When undoing a return in order to make it pending, get the stored
5343 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005344 if (reanimate)
5345 rettv = current_funccal->rettv;
5346
5347 if (rettv != NULL)
5348 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005349 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005350 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5351 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5352 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005353 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005354 }
5355 else
5356 cstack->cs_rettv[idx] = NULL;
5357
5358 if (reanimate)
5359 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005360 // The pending return value could be overwritten by a ":return"
5361 // without argument in a finally clause; reset the default
5362 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005363 current_funccal->rettv->v_type = VAR_NUMBER;
5364 current_funccal->rettv->vval.v_number = 0;
5365 }
5366 }
5367 report_make_pending(CSTP_RETURN, rettv);
5368 }
5369 else
5370 {
5371 current_funccal->returned = TRUE;
5372
Bram Moolenaare38eab22019-12-05 21:50:01 +01005373 // If the return is carried out now, store the return value. For
5374 // a return immediately after reanimation, the value is already
5375 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 if (!reanimate && rettv != NULL)
5377 {
5378 clear_tv(current_funccal->rettv);
5379 *current_funccal->rettv = *(typval_T *)rettv;
5380 if (!is_cmd)
5381 vim_free(rettv);
5382 }
5383 }
5384
5385 return idx < 0;
5386}
5387
5388/*
5389 * Free the variable with a pending return value.
5390 */
5391 void
5392discard_pending_return(void *rettv)
5393{
5394 free_tv((typval_T *)rettv);
5395}
5396
5397/*
5398 * Generate a return command for producing the value of "rettv". The result
5399 * is an allocated string. Used by report_pending() for verbose messages.
5400 */
5401 char_u *
5402get_return_cmd(void *rettv)
5403{
5404 char_u *s = NULL;
5405 char_u *tofree = NULL;
5406 char_u numbuf[NUMBUFLEN];
5407
5408 if (rettv != NULL)
5409 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5410 if (s == NULL)
5411 s = (char_u *)"";
5412
5413 STRCPY(IObuff, ":return ");
5414 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5415 if (STRLEN(s) + 8 >= IOSIZE)
5416 STRCPY(IObuff + IOSIZE - 4, "...");
5417 vim_free(tofree);
5418 return vim_strsave(IObuff);
5419}
5420
5421/*
5422 * Get next function line.
5423 * Called by do_cmdline() to get the next line.
5424 * Returns allocated string, or NULL for end of function.
5425 */
5426 char_u *
5427get_func_line(
5428 int c UNUSED,
5429 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005430 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005431 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005432{
5433 funccall_T *fcp = (funccall_T *)cookie;
5434 ufunc_T *fp = fcp->func;
5435 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005436 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005437
Bram Moolenaare38eab22019-12-05 21:50:01 +01005438 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005439 if (fcp->dbg_tick != debug_tick)
5440 {
5441 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005442 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005443 fcp->dbg_tick = debug_tick;
5444 }
5445#ifdef FEAT_PROFILE
5446 if (do_profiling == PROF_YES)
5447 func_line_end(cookie);
5448#endif
5449
5450 gap = &fp->uf_lines;
5451 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5452 || fcp->returned)
5453 retval = NULL;
5454 else
5455 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005456 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005457 while (fcp->linenr < gap->ga_len
5458 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5459 ++fcp->linenr;
5460 if (fcp->linenr >= gap->ga_len)
5461 retval = NULL;
5462 else
5463 {
5464 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005465 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005466#ifdef FEAT_PROFILE
5467 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005468 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005469#endif
5470 }
5471 }
5472
Bram Moolenaare38eab22019-12-05 21:50:01 +01005473 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005474 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005475 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005476 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005477 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005478 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005479 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005480 fcp->dbg_tick = debug_tick;
5481 }
5482
5483 return retval;
5484}
5485
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005486/*
5487 * Return TRUE if the currently active function should be ended, because a
5488 * return was encountered or an error occurred. Used inside a ":while".
5489 */
5490 int
5491func_has_ended(void *cookie)
5492{
5493 funccall_T *fcp = (funccall_T *)cookie;
5494
Bram Moolenaare38eab22019-12-05 21:50:01 +01005495 // Ignore the "abort" flag if the abortion behavior has been changed due to
5496 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005497 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5498 || fcp->returned);
5499}
5500
5501/*
5502 * return TRUE if cookie indicates a function which "abort"s on errors.
5503 */
5504 int
5505func_has_abort(
5506 void *cookie)
5507{
5508 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5509}
5510
5511
5512/*
5513 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5514 * Don't do this when "Func" is already a partial that was bound
5515 * explicitly (pt_auto is FALSE).
5516 * Changes "rettv" in-place.
5517 * Returns the updated "selfdict_in".
5518 */
5519 dict_T *
5520make_partial(dict_T *selfdict_in, typval_T *rettv)
5521{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005522 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005523 char_u *tofree = NULL;
5524 ufunc_T *fp;
5525 char_u fname_buf[FLEN_FIXED + 1];
5526 int error;
5527 dict_T *selfdict = selfdict_in;
5528
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005529 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5530 fp = rettv->vval.v_partial->pt_func;
5531 else
5532 {
5533 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5534 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005535 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005536 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005537 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005538 vim_free(tofree);
5539 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005540
5541 if (fp != NULL && (fp->uf_flags & FC_DICT))
5542 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005543 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005544
5545 if (pt != NULL)
5546 {
5547 pt->pt_refcount = 1;
5548 pt->pt_dict = selfdict;
5549 pt->pt_auto = TRUE;
5550 selfdict = NULL;
5551 if (rettv->v_type == VAR_FUNC)
5552 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005553 // Just a function: Take over the function name and use
5554 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005555 pt->pt_name = rettv->vval.v_string;
5556 }
5557 else
5558 {
5559 partial_T *ret_pt = rettv->vval.v_partial;
5560 int i;
5561
Bram Moolenaare38eab22019-12-05 21:50:01 +01005562 // Partial: copy the function name, use selfdict and copy
5563 // args. Can't take over name or args, the partial might
5564 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005565 if (ret_pt->pt_name != NULL)
5566 {
5567 pt->pt_name = vim_strsave(ret_pt->pt_name);
5568 func_ref(pt->pt_name);
5569 }
5570 else
5571 {
5572 pt->pt_func = ret_pt->pt_func;
5573 func_ptr_ref(pt->pt_func);
5574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005575 if (ret_pt->pt_argc > 0)
5576 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005577 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005578 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005579 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005580 pt->pt_argc = 0;
5581 else
5582 {
5583 pt->pt_argc = ret_pt->pt_argc;
5584 for (i = 0; i < pt->pt_argc; i++)
5585 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5586 }
5587 }
5588 partial_unref(ret_pt);
5589 }
5590 rettv->v_type = VAR_PARTIAL;
5591 rettv->vval.v_partial = pt;
5592 }
5593 }
5594 return selfdict;
5595}
5596
5597/*
5598 * Return the name of the executed function.
5599 */
5600 char_u *
5601func_name(void *cookie)
5602{
5603 return ((funccall_T *)cookie)->func->uf_name;
5604}
5605
5606/*
5607 * Return the address holding the next breakpoint line for a funccall cookie.
5608 */
5609 linenr_T *
5610func_breakpoint(void *cookie)
5611{
5612 return &((funccall_T *)cookie)->breakpoint;
5613}
5614
5615/*
5616 * Return the address holding the debug tick for a funccall cookie.
5617 */
5618 int *
5619func_dbg_tick(void *cookie)
5620{
5621 return &((funccall_T *)cookie)->dbg_tick;
5622}
5623
5624/*
5625 * Return the nesting level for a funccall cookie.
5626 */
5627 int
5628func_level(void *cookie)
5629{
5630 return ((funccall_T *)cookie)->level;
5631}
5632
5633/*
5634 * Return TRUE when a function was ended by a ":return" command.
5635 */
5636 int
5637current_func_returned(void)
5638{
5639 return current_funccal->returned;
5640}
5641
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005642 int
5643free_unref_funccal(int copyID, int testing)
5644{
5645 int did_free = FALSE;
5646 int did_free_funccal = FALSE;
5647 funccall_T *fc, **pfc;
5648
5649 for (pfc = &previous_funccal; *pfc != NULL; )
5650 {
5651 if (can_free_funccal(*pfc, copyID))
5652 {
5653 fc = *pfc;
5654 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005655 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005656 did_free = TRUE;
5657 did_free_funccal = TRUE;
5658 }
5659 else
5660 pfc = &(*pfc)->caller;
5661 }
5662 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005663 // When a funccal was freed some more items might be garbage
5664 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005665 (void)garbage_collect(testing);
5666
5667 return did_free;
5668}
5669
5670/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005671 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005672 */
5673 static funccall_T *
5674get_funccal(void)
5675{
5676 int i;
5677 funccall_T *funccal;
5678 funccall_T *temp_funccal;
5679
5680 funccal = current_funccal;
5681 if (debug_backtrace_level > 0)
5682 {
5683 for (i = 0; i < debug_backtrace_level; i++)
5684 {
5685 temp_funccal = funccal->caller;
5686 if (temp_funccal)
5687 funccal = temp_funccal;
5688 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005689 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005690 debug_backtrace_level = i;
5691 }
5692 }
5693 return funccal;
5694}
5695
5696/*
5697 * Return the hashtable used for local variables in the current funccal.
5698 * Return NULL if there is no current funccal.
5699 */
5700 hashtab_T *
5701get_funccal_local_ht()
5702{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005703 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005704 return NULL;
5705 return &get_funccal()->l_vars.dv_hashtab;
5706}
5707
5708/*
5709 * Return the l: scope variable.
5710 * Return NULL if there is no current funccal.
5711 */
5712 dictitem_T *
5713get_funccal_local_var()
5714{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005715 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005716 return NULL;
5717 return &get_funccal()->l_vars_var;
5718}
5719
5720/*
5721 * Return the hashtable used for argument in the current funccal.
5722 * Return NULL if there is no current funccal.
5723 */
5724 hashtab_T *
5725get_funccal_args_ht()
5726{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005727 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005728 return NULL;
5729 return &get_funccal()->l_avars.dv_hashtab;
5730}
5731
5732/*
5733 * Return the a: scope variable.
5734 * Return NULL if there is no current funccal.
5735 */
5736 dictitem_T *
5737get_funccal_args_var()
5738{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005739 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005740 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005741 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005742}
5743
5744/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005745 * List function variables, if there is a function.
5746 */
5747 void
5748list_func_vars(int *first)
5749{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005750 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005751 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005752 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005753}
5754
5755/*
5756 * If "ht" is the hashtable for local variables in the current funccal, return
5757 * the dict that contains it.
5758 * Otherwise return NULL.
5759 */
5760 dict_T *
5761get_current_funccal_dict(hashtab_T *ht)
5762{
5763 if (current_funccal != NULL
5764 && ht == &current_funccal->l_vars.dv_hashtab)
5765 return &current_funccal->l_vars;
5766 return NULL;
5767}
5768
5769/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005770 * Search hashitem in parent scope.
5771 */
5772 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005773find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005774{
5775 funccall_T *old_current_funccal = current_funccal;
5776 hashtab_T *ht;
5777 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005778 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005779
5780 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5781 return NULL;
5782
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005783 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005784 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005785 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005786 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005787 ht = find_var_ht(name, &varname);
5788 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005789 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005790 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005791 if (!HASHITEM_EMPTY(hi))
5792 {
5793 *pht = ht;
5794 break;
5795 }
5796 }
5797 if (current_funccal == current_funccal->func->uf_scoped)
5798 break;
5799 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005800 }
5801 current_funccal = old_current_funccal;
5802
5803 return hi;
5804}
5805
5806/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005807 * Search variable in parent scope.
5808 */
5809 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005810find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005811{
5812 dictitem_T *v = NULL;
5813 funccall_T *old_current_funccal = current_funccal;
5814 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005815 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005816
5817 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5818 return NULL;
5819
Bram Moolenaare38eab22019-12-05 21:50:01 +01005820 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005821 current_funccal = current_funccal->func->uf_scoped;
5822 while (current_funccal)
5823 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005824 ht = find_var_ht(name, &varname);
5825 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005826 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005827 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005828 if (v != NULL)
5829 break;
5830 }
5831 if (current_funccal == current_funccal->func->uf_scoped)
5832 break;
5833 current_funccal = current_funccal->func->uf_scoped;
5834 }
5835 current_funccal = old_current_funccal;
5836
5837 return v;
5838}
5839
5840/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005841 * Set "copyID + 1" in previous_funccal and callers.
5842 */
5843 int
5844set_ref_in_previous_funccal(int copyID)
5845{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005846 funccall_T *fc;
5847
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005848 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005849 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005850 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005851 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5852 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5853 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5854 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005855 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005856 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005857}
5858
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005859 static int
5860set_ref_in_funccal(funccall_T *fc, int copyID)
5861{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005862 if (fc->fc_copyID != copyID)
5863 {
5864 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005865 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5866 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5867 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5868 || set_ref_in_func(NULL, fc->func, copyID))
5869 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005870 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005871 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005872}
5873
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005874/*
5875 * Set "copyID" in all local vars and arguments in the call stack.
5876 */
5877 int
5878set_ref_in_call_stack(int copyID)
5879{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005880 funccall_T *fc;
5881 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005882
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005883 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5884 if (set_ref_in_funccal(fc, copyID))
5885 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005886
5887 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005888 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5889 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5890 if (set_ref_in_funccal(fc, copyID))
5891 return TRUE;
5892 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005893}
5894
5895/*
5896 * Set "copyID" in all functions available by name.
5897 */
5898 int
5899set_ref_in_functions(int copyID)
5900{
5901 int todo;
5902 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005903 ufunc_T *fp;
5904
5905 todo = (int)func_hashtab.ht_used;
5906 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005907 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005908 if (!HASHITEM_EMPTY(hi))
5909 {
5910 --todo;
5911 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005912 if (!func_name_refcount(fp->uf_name)
5913 && set_ref_in_func(NULL, fp, copyID))
5914 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005915 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005916 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005917 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005918}
5919
5920/*
5921 * Set "copyID" in all function arguments.
5922 */
5923 int
5924set_ref_in_func_args(int copyID)
5925{
5926 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005927
5928 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005929 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5930 copyID, NULL, NULL))
5931 return TRUE;
5932 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005933}
5934
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005935/*
5936 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005937 * Returns TRUE if setting references failed somehow.
5938 */
5939 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005940set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005941{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005942 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005943 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005944 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005945 char_u fname_buf[FLEN_FIXED + 1];
5946 char_u *tofree = NULL;
5947 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005948 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005949
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005950 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005951 return FALSE;
5952
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005953 if (fp_in == NULL)
5954 {
5955 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005956 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005957 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005958 if (fp != NULL)
5959 {
5960 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005961 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005962 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005963
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005964 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005965 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005966}
5967
Bram Moolenaare38eab22019-12-05 21:50:01 +01005968#endif // FEAT_EVAL