blob: 747e4d47787228ad05ab29df2687cdb99d87e586 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020035
36 void
37func_init()
38{
39 hash_init(&func_hashtab);
40}
41
Dominique Pelle748b3082022-01-08 12:41:16 +000042#if defined(FEAT_PROFILE) || defined(PROTO)
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020043/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020044 * Return the function hash table
45 */
46 hashtab_T *
47func_tbl_get(void)
48{
49 return &func_hashtab;
50}
Dominique Pelle748b3082022-01-08 12:41:16 +000051#endif
Bram Moolenaar660a10a2019-07-14 15:48:38 +020052
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010067 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020068 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010069 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010070{
Bram Moolenaar6e949782020-04-13 17:21:00 +020071 char_u *p = arg;
72 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020073 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010074
75 while (ASCII_ISALNUM(*p) || *p == '_')
76 ++p;
77 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020078 || (argtypes == NULL
79 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
80 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010081 {
82 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000083 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010084 return arg;
85 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010086
Bram Moolenaar057e84a2021-02-28 16:55:11 +010087 // Vim9 script: cannot use script var name for argument. In function: also
88 // check local vars and arguments.
89 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
90 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010091 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010092
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010093 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
94 return arg;
95 if (newargs != NULL)
96 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010097 int c;
98 int i;
99
100 c = *p;
101 *p = NUL;
102 arg_copy = vim_strsave(arg);
103 if (arg_copy == NULL)
104 {
105 *p = c;
106 return arg;
107 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200108 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200109 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200110 // Check for duplicate argument name.
111 for (i = 0; i < newargs->ga_len; ++i)
112 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
113 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000114 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200115 vim_free(arg_copy);
116 return arg;
117 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100118 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
119 newargs->ga_len++;
120
121 *p = c;
122 }
123
124 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100125 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100126 {
127 char_u *type = NULL;
128
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
130 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200131 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 arg_copy == NULL ? arg : arg_copy);
133 p = skipwhite(p);
134 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100135 if (*p == ':')
136 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200137 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100138 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200139 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100140 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200141 return arg;
142 }
143 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200144 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100145 if (!skip)
146 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100147 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200148 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200149 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200150 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200151 arg_copy == NULL ? arg : arg_copy);
152 return arg;
153 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100154 if (!skip)
155 {
156 if (type == NULL && types_optional)
157 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200158 type = vim_strsave((char_u *)
159 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100160 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
161 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100162 }
163
164 return p;
165}
166
167/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000168 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000169 * Get a next line, store it in "eap" if appropriate and put the line in
170 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 */
172 static char_u *
173get_function_line(
174 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000175 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000176 int indent,
177 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000178{
179 char_u *theline;
180
181 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000182 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000183 else
184 theline = eap->getline(':', eap->cookie, indent, getline_options);
185 if (theline != NULL)
186 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000187 if (lines_to_free->ga_len > 0
188 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
189 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000190 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000191 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000192 }
193
194 return theline;
195}
196
197/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200198 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100199 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100200 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203get_function_args(
204 char_u **argp,
205 char_u endchar,
206 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100207 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100208 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100209 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200210 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200211 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200212 int skip,
213 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000214 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200215{
216 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100217 char_u *arg;
218 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200219 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200220 int any_default = FALSE;
221 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100222 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200223
224 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000225 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100226 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000227 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200228 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000229 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230
231 if (varargs != NULL)
232 *varargs = FALSE;
233
234 /*
235 * Isolate the arguments: "arg1, arg2, ...)"
236 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100237 arg = skipwhite(*argp);
238 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200239 while (*p != endchar)
240 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200241 while (eap != NULL && eap->getline != NULL
242 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200243 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200244 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000245 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000246 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000247
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200248 if (theline == NULL)
249 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200250 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 p = skipwhite(theline);
252 }
253
254 if (mustend && *p != endchar)
255 {
256 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000257 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100258 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200259 }
260 if (*p == endchar)
261 break;
262
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200263 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
264 {
265 if (varargs != NULL)
266 *varargs = TRUE;
267 p += 3;
268 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100269
270 if (argtypes != NULL)
271 {
272 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200273 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100275 if (!skip)
276 emsg(_(e_missing_name_after_dots));
277 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100278 }
279
280 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100281 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200282 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100283 if (p == arg)
284 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100285 if (*skipwhite(p) == '=')
286 {
287 emsg(_(e_cannot_use_default_for_variable_arguments));
288 break;
289 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100290 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200291 }
292 else
293 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200294 char_u *np;
295
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200296 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100297 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200298 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100299 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200300 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200301
Bram Moolenaar015cf102021-06-26 21:52:02 +0200302 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200303 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200304 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200305 if (*np == '=' && np[1] != '=' && np[1] != '~'
306 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200307 {
308 typval_T rettv;
309
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100310 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200311 any_default = TRUE;
312 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200313 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 p = skipwhite(p);
315 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200316 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200318 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200319 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200320 if (ga_grow(default_args, 1) == FAIL)
321 goto err_ret;
322
323 // trim trailing whitespace
324 while (p > expr && VIM_ISWHITE(p[-1]))
325 p--;
326 c = *p;
327 *p = NUL;
328 expr = vim_strsave(expr);
329 if (expr == NULL)
330 {
331 *p = c;
332 goto err_ret;
333 }
334 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200335 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200336 default_args->ga_len++;
337 *p = c;
338 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200339 }
340 else
341 mustend = TRUE;
342 }
343 else if (any_default)
344 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000345 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200346 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200347 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200348
349 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
350 {
351 // Be tolerant when skipping
352 if (!skip)
353 {
354 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
355 goto err_ret;
356 }
357 p = skipwhite(p);
358 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200359 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200360 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200361 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200362 // Don't give this error when skipping, it makes the "->" not
363 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100364 // Allow missing space after comma in legacy functions.
365 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200366 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
367 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100368 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 goto err_ret;
370 }
371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200372 else
373 mustend = TRUE;
374 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200375 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200376 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200378
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200379 if (*p != endchar)
380 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100381 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200382
383 *argp = p;
384 return OK;
385
386err_ret:
387 if (newargs != NULL)
388 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200389 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200390 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200391 return FAIL;
392}
393
394/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100395 * Parse the argument types, filling "fp->uf_arg_types".
396 * Return OK or FAIL.
397 */
398 static int
399parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
400{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200401 int len = 0;
402
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100403 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
404 if (argtypes->ga_len > 0)
405 {
406 // When "varargs" is set the last name/type goes into uf_va_name
407 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200408 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100409
410 if (len > 0)
411 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
412 if (fp->uf_arg_types != NULL)
413 {
414 int i;
415 type_T *type;
416
417 for (i = 0; i < len; ++ i)
418 {
419 char_u *p = ((char_u **)argtypes->ga_data)[i];
420
421 if (p == NULL)
422 // will get the type from the default value
423 type = &t_unknown;
424 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100425 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100426 if (type == NULL)
427 return FAIL;
428 fp->uf_arg_types[i] = type;
429 }
430 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100431 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200432
433 if (varargs)
434 {
435 char_u *p;
436
437 // Move the last argument "...name: type" to uf_va_name and
438 // uf_va_type.
439 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
440 [fp->uf_args.ga_len - 1];
441 --fp->uf_args.ga_len;
442 p = ((char_u **)argtypes->ga_data)[len];
443 if (p == NULL)
444 // TODO: get type from default value
445 fp->uf_va_type = &t_list_any;
446 else
447 {
448 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
449 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
450 {
451 semsg(_(e_variable_arguments_type_must_be_list_str),
452 ((char_u **)argtypes->ga_data)[len]);
453 return FAIL;
454 }
455 }
456 if (fp->uf_va_type == NULL)
457 return FAIL;
458 }
459
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100460 return OK;
461}
462
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100463 static int
464parse_return_type(ufunc_T *fp, char_u *ret_type)
465{
466 if (ret_type == NULL)
467 fp->uf_ret_type = &t_void;
468 else
469 {
470 char_u *p = ret_type;
471
472 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
473 if (fp->uf_ret_type == NULL)
474 {
475 fp->uf_ret_type = &t_void;
476 return FAIL;
477 }
478 }
479 return OK;
480}
481
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100482/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200483 * Register function "fp" as using "current_funccal" as its scope.
484 */
485 static int
486register_closure(ufunc_T *fp)
487{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200488 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100489 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200490 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200491 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200492 fp->uf_scoped = current_funccal;
493 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200494
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
496 return FAIL;
497 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
498 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200499 return OK;
500}
501
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100502 static void
503set_ufunc_name(ufunc_T *fp, char_u *name)
504{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100505 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
506 // actually extends beyond the struct.
507 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100508
509 if (name[0] == K_SPECIAL)
510 {
511 fp->uf_name_exp = alloc(STRLEN(name) + 3);
512 if (fp->uf_name_exp != NULL)
513 {
514 STRCPY(fp->uf_name_exp, "<SNR>");
515 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
516 }
517 }
518}
519
Bram Moolenaar58016442016-07-31 18:30:22 +0200520/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200521 * Get a name for a lambda. Returned in static memory.
522 */
523 char_u *
524get_lambda_name(void)
525{
526 static char_u name[30];
527 static int lambda_no = 0;
528
529 sprintf((char*)name, "<lambda>%d", ++lambda_no);
530 return name;
531}
532
Bram Moolenaar801ab062020-06-25 19:27:56 +0200533#if defined(FEAT_LUA) || defined(PROTO)
534/*
535 * Registers a native C callback which can be called from Vim script.
536 * Returns the name of the Vim script function.
537 */
538 char_u *
539register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
540{
541 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200542 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200543
544 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
545 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200546 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200547
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200548 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200549 fp->uf_refcount = 1;
550 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000551 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200552 fp->uf_calls = 0;
553 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200554 fp->uf_cb = cb;
555 fp->uf_cb_free = cb_free;
556 fp->uf_cb_state = state;
557
558 set_ufunc_name(fp, name);
559 hash_add(&func_hashtab, UF2HIKEY(fp));
560
561 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200562}
563#endif
564
Bram Moolenaar04b12692020-05-04 23:24:44 +0200565/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100566 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100567 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100568 * If "white_error" is not NULL check for correct use of white space and set
569 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100570 * Return NULL if no valid arrow found.
571 */
572 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100573skip_arrow(
574 char_u *start,
575 int equal_arrow,
576 char_u **ret_type,
577 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100578{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100579 char_u *s = start;
580 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100581
582 if (equal_arrow)
583 {
584 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100585 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100586 if (white_error != NULL && !VIM_ISWHITE(s[1]))
587 {
588 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100589 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return NULL;
591 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100592 s = skipwhite(s + 1);
593 *ret_type = s;
594 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100595 if (s == *ret_type)
596 {
597 emsg(_(e_missing_return_type));
598 return NULL;
599 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100600 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100601 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100602 s = skipwhite(s);
603 if (*s != '=')
604 return NULL;
605 ++s;
606 }
607 if (*s != '>')
608 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100609 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
610 || !IS_WHITE_OR_NUL(s[1])))
611 {
612 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100613 semsg(_(e_white_space_required_before_and_after_str_at_str),
614 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100615 return NULL;
616 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100617 return skipwhite(s + 1);
618}
619
620/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100621 * Check if "*cmd" points to a function command and if so advance "*cmd" and
622 * return TRUE.
623 * Otherwise return FALSE;
624 * Do not consider "function(" to be a command.
625 */
626 static int
627is_function_cmd(char_u **cmd)
628{
629 char_u *p = *cmd;
630
631 if (checkforcmd(&p, "function", 2))
632 {
633 if (*p == '(')
634 return FALSE;
635 *cmd = p;
636 return TRUE;
637 }
638 return FALSE;
639}
640
641/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200642 * Called when defining a function: The context may be needed for script
643 * variables declared in a block that is visible now but not when the function
644 * is compiled or called later.
645 */
646 static void
647function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
648{
649 if (cstack != NULL && cstack->cs_idx >= 0)
650 {
651 int count = cstack->cs_idx + 1;
652 int i;
653
654 fp->uf_block_ids = ALLOC_MULT(int, count);
655 if (fp->uf_block_ids != NULL)
656 {
657 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
658 sizeof(int) * count);
659 fp->uf_block_depth = count;
660 }
661
662 // Set flag in each block to indicate a function was defined. This
663 // is used to keep the variable when leaving the block, see
664 // hide_script_var().
665 for (i = 0; i <= cstack->cs_idx; ++i)
666 cstack->cs_flags[i] |= CSF_FUNC_DEF;
667 }
668}
669
670/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100671 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200672 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100673 * "newlines" must already have been initialized.
674 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
675 */
676 static int
677get_function_body(
678 exarg_T *eap,
679 garray_T *newlines,
680 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000681 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100682{
683 linenr_T sourcing_lnum_top = SOURCING_LNUM;
684 linenr_T sourcing_lnum_off;
685 int saved_wait_return = need_wait_return;
686 char_u *line_arg = line_arg_in;
687 int vim9_function = eap->cmdidx == CMD_def
688 || eap->cmdidx == CMD_block;
689#define MAX_FUNC_NESTING 50
690 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200691 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100692 int nesting = 0;
693 getline_opt_T getline_options;
694 int indent = 2;
695 char_u *skip_until = NULL;
696 int ret = FAIL;
697 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200698 int heredoc_concat_len = 0;
699 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100700 char_u *heredoc_trimmed = NULL;
701
Bram Moolenaar20677332021-06-06 17:02:53 +0200702 ga_init2(&heredoc_ga, 1, 500);
703
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100704 // Detect having skipped over comment lines to find the return
705 // type. Add NULL lines to keep the line count correct.
706 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
707 if (SOURCING_LNUM < sourcing_lnum_off)
708 {
709 sourcing_lnum_off -= SOURCING_LNUM;
710 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
711 goto theend;
712 while (sourcing_lnum_off-- > 0)
713 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
714 }
715
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200716 nesting_def[0] = vim9_function;
717 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100718 getline_options = vim9_function
719 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
720 for (;;)
721 {
722 char_u *theline;
723 char_u *p;
724 char_u *arg;
725
726 if (KeyTyped)
727 {
728 msg_scroll = TRUE;
729 saved_wait_return = FALSE;
730 }
731 need_wait_return = FALSE;
732
733 if (line_arg != NULL)
734 {
735 // Use eap->arg, split up in parts by line breaks.
736 theline = line_arg;
737 p = vim_strchr(theline, '\n');
738 if (p == NULL)
739 line_arg += STRLEN(line_arg);
740 else
741 {
742 *p = NUL;
743 line_arg = p + 1;
744 }
745 }
746 else
747 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000748 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100749 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100750 }
751 if (KeyTyped)
752 lines_left = Rows - 1;
753 if (theline == NULL)
754 {
755 // Use the start of the function for the line number.
756 SOURCING_LNUM = sourcing_lnum_top;
757 if (skip_until != NULL)
758 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200759 else if (nesting_inline[nesting])
760 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100761 else if (eap->cmdidx == CMD_def)
762 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100763 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000764 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100765 goto theend;
766 }
767
768 // Detect line continuation: SOURCING_LNUM increased more than one.
769 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
770 if (SOURCING_LNUM < sourcing_lnum_off)
771 sourcing_lnum_off -= SOURCING_LNUM;
772 else
773 sourcing_lnum_off = 0;
774
775 if (skip_until != NULL)
776 {
777 // Don't check for ":endfunc"/":enddef" between
778 // * ":append" and "."
779 // * ":python <<EOF" and "EOF"
780 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
781 if (heredoc_trimmed == NULL
782 || (is_heredoc && skipwhite(theline) == theline)
783 || STRNCMP(theline, heredoc_trimmed,
784 STRLEN(heredoc_trimmed)) == 0)
785 {
786 if (heredoc_trimmed == NULL)
787 p = theline;
788 else if (is_heredoc)
789 p = skipwhite(theline) == theline
790 ? theline : theline + STRLEN(heredoc_trimmed);
791 else
792 p = theline + STRLEN(heredoc_trimmed);
793 if (STRCMP(p, skip_until) == 0)
794 {
795 VIM_CLEAR(skip_until);
796 VIM_CLEAR(heredoc_trimmed);
797 getline_options = vim9_function
798 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
799 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200800
801 if (heredoc_concat_len > 0)
802 {
803 // Replace the starting line with all the concatenated
804 // lines.
805 ga_concat(&heredoc_ga, theline);
806 vim_free(((char_u **)(newlines->ga_data))[
807 heredoc_concat_len - 1]);
808 ((char_u **)(newlines->ga_data))[
809 heredoc_concat_len - 1] = heredoc_ga.ga_data;
810 ga_init(&heredoc_ga);
811 heredoc_concat_len = 0;
812 theline += STRLEN(theline); // skip the "EOF"
813 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100814 }
815 }
816 }
817 else
818 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200819 int c;
820 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100821
822 // skip ':' and blanks
823 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
824 ;
825
826 // Check for "endfunction", "enddef" or "}".
827 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200828 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100829 ? *p == '}'
830 : (checkforcmd(&p, nesting_def[nesting]
831 ? "enddef" : "endfunction", 4)
832 && *p != ':'))
833 {
834 if (nesting-- == 0)
835 {
836 char_u *nextcmd = NULL;
837
838 if (*p == '|' || *p == '}')
839 nextcmd = p + 1;
840 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
841 nextcmd = line_arg;
842 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100843 && (vim9_function || p_verbose > 0))
844 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200845 SOURCING_LNUM = sourcing_lnum_top
846 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100847 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000848 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100849 else
850 give_warning2((char_u *)
851 _("W22: Text found after :endfunction: %s"),
852 p, TRUE);
853 }
854 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100855 {
856 // Another command follows. If the line came from "eap"
857 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000858 // change "eap->cmdlinep" to point to the last fetched
859 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100860 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000861 if (lines_to_free->ga_len > 0
862 && *eap->cmdlinep !=
863 ((char_u **)lines_to_free->ga_data)
864 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100865 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000866 // *cmdlinep will be freed later, thus remove the
867 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000869 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
870 [lines_to_free->ga_len - 1];
871 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100872 }
873 }
874 break;
875 }
876 }
877
878 // Check for mismatched "endfunc" or "enddef".
879 // We don't check for "def" inside "func" thus we also can't check
880 // for "enddef".
881 // We continue to find the end of the function, although we might
882 // not find it.
883 else if (nesting_def[nesting])
884 {
885 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
886 emsg(_(e_mismatched_endfunction));
887 }
888 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
889 emsg(_(e_mismatched_enddef));
890
891 // Increase indent inside "if", "while", "for" and "try", decrease
892 // at "end".
893 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
894 indent -= 2;
895 else if (STRNCMP(p, "if", 2) == 0
896 || STRNCMP(p, "wh", 2) == 0
897 || STRNCMP(p, "for", 3) == 0
898 || STRNCMP(p, "try", 3) == 0)
899 indent += 2;
900
901 // Check for defining a function inside this function.
902 // Only recognize "def" inside "def", not inside "function",
903 // For backwards compatibility, see Test_function_python().
904 c = *p;
905 if (is_function_cmd(&p)
906 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
907 {
908 if (*p == '!')
909 p = skipwhite(p + 1);
910 p += eval_fname_script(p);
911 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
912 NULL, NULL));
913 if (*skipwhite(p) == '(')
914 {
915 if (nesting == MAX_FUNC_NESTING - 1)
916 emsg(_(e_function_nesting_too_deep));
917 else
918 {
919 ++nesting;
920 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200921 nesting_inline[nesting] = FALSE;
922 indent += 2;
923 }
924 }
925 }
926
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200927 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200928 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200929 // Not a comment line: check for nested inline function.
930 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200931 while (end > p && VIM_ISWHITE(*end))
932 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200933 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200934 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200935 int is_block;
936
937 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200938 --end;
939 while (end > p && VIM_ISWHITE(*end))
940 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200941 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
942 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200943 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200944 char_u *s = p;
945
946 // check for line starting with "au" for :autocmd or
947 // "com" for :command, these can use a {} block
948 is_block = checkforcmd_noparen(&s, "autocmd", 2)
949 || checkforcmd_noparen(&s, "command", 3);
950 }
951
952 if (is_block)
953 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200954 if (nesting == MAX_FUNC_NESTING - 1)
955 emsg(_(e_function_nesting_too_deep));
956 else
957 {
958 ++nesting;
959 nesting_def[nesting] = TRUE;
960 nesting_inline[nesting] = TRUE;
961 indent += 2;
962 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100963 }
964 }
965 }
966
967 // Check for ":append", ":change", ":insert". Not for :def.
968 p = skip_range(p, FALSE, NULL);
969 if (!vim9_function
970 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
971 || (p[0] == 'c'
972 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
973 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
974 && (STRNCMP(&p[3], "nge", 3) != 0
975 || !ASCII_ISALPHA(p[6])))))))
976 || (p[0] == 'i'
977 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
978 && (!ASCII_ISALPHA(p[2])
979 || (p[2] == 's'
980 && (!ASCII_ISALPHA(p[3])
981 || p[3] == 'e'))))))))
982 skip_until = vim_strsave((char_u *)".");
983
984 // Check for ":python <<EOF", ":tcl <<EOF", etc.
985 arg = skipwhite(skiptowhite(p));
986 if (arg[0] == '<' && arg[1] =='<'
987 && ((p[0] == 'p' && p[1] == 'y'
988 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
989 || ((p[2] == '3' || p[2] == 'x')
990 && !ASCII_ISALPHA(p[3]))))
991 || (p[0] == 'p' && p[1] == 'e'
992 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
993 || (p[0] == 't' && p[1] == 'c'
994 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
995 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
996 && !ASCII_ISALPHA(p[3]))
997 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
998 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
999 || (p[0] == 'm' && p[1] == 'z'
1000 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1001 ))
1002 {
1003 // ":python <<" continues until a dot, like ":append"
1004 p = skipwhite(arg + 2);
1005 if (STRNCMP(p, "trim", 4) == 0)
1006 {
1007 // Ignore leading white space.
1008 p = skipwhite(p + 4);
1009 heredoc_trimmed = vim_strnsave(theline,
1010 skipwhite(theline) - theline);
1011 }
1012 if (*p == NUL)
1013 skip_until = vim_strsave((char_u *)".");
1014 else
1015 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1016 getline_options = GETLINE_NONE;
1017 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001018 if (eap->cmdidx == CMD_def)
1019 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001020 }
1021
1022 // Check for ":cmd v =<< [trim] EOF"
1023 // and ":cmd [a, b] =<< [trim] EOF"
1024 // and "lines =<< [trim] EOF" for Vim9
1025 // Where "cmd" can be "let", "var", "final" or "const".
1026 arg = skipwhite(skiptowhite(p));
1027 if (*arg == '[')
1028 arg = vim_strchr(arg, ']');
1029 if (arg != NULL)
1030 {
1031 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1032 && arg[1] == '<' && arg[2] =='<');
1033
1034 if (!found)
1035 // skip over the argument after "cmd"
1036 arg = skipwhite(skiptowhite(arg));
1037 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1038 && (checkforcmd(&p, "let", 2)
1039 || checkforcmd(&p, "var", 3)
1040 || checkforcmd(&p, "final", 5)
1041 || checkforcmd(&p, "const", 5))))
1042 {
1043 p = skipwhite(arg + 3);
1044 if (STRNCMP(p, "trim", 4) == 0)
1045 {
1046 // Ignore leading white space.
1047 p = skipwhite(p + 4);
1048 heredoc_trimmed = vim_strnsave(theline,
1049 skipwhite(theline) - theline);
1050 }
1051 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1052 getline_options = GETLINE_NONE;
1053 is_heredoc = TRUE;
1054 }
1055 }
1056 }
1057
1058 // Add the line to the function.
1059 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1060 goto theend;
1061
Bram Moolenaar20677332021-06-06 17:02:53 +02001062 if (heredoc_concat_len > 0)
1063 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001064 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001065 // to be used for the instruction later.
1066 ga_concat(&heredoc_ga, theline);
1067 ga_concat(&heredoc_ga, (char_u *)"\n");
1068 p = vim_strsave((char_u *)"");
1069 }
1070 else
1071 {
1072 // Copy the line to newly allocated memory. get_one_sourceline()
1073 // allocates 250 bytes per line, this saves 80% on average. The
1074 // cost is an extra alloc/free.
1075 p = vim_strsave(theline);
1076 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001077 if (p == NULL)
1078 goto theend;
1079 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1080
1081 // Add NULL lines for continuation lines, so that the line count is
1082 // equal to the index in the growarray.
1083 while (sourcing_lnum_off-- > 0)
1084 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1085
1086 // Check for end of eap->arg.
1087 if (line_arg != NULL && *line_arg == NUL)
1088 line_arg = NULL;
1089 }
1090
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001091 // Return OK when no error was detected.
1092 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001093 ret = OK;
1094
1095theend:
1096 vim_free(skip_until);
1097 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001098 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001099 need_wait_return |= saved_wait_return;
1100 return ret;
1101}
1102
1103/*
1104 * Handle the body of a lambda. *arg points to the "{", process statements
1105 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001106 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 * When successful "rettv" is set to a funcref.
1108 */
1109 static int
1110lambda_function_body(
1111 char_u **arg,
1112 typval_T *rettv,
1113 evalarg_T *evalarg,
1114 garray_T *newargs,
1115 garray_T *argtypes,
1116 int varargs,
1117 garray_T *default_args,
1118 char_u *ret_type)
1119{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001120 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001121 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001122 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001123 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001124 exarg_T eap;
1125 garray_T newlines;
1126 char_u *cmdline = NULL;
1127 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001128 partial_T *pt;
1129 char_u *name;
1130 int lnum_save = -1;
1131 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1132
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001133 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1134 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001135 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001136 return FAIL;
1137 }
1138
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001139 CLEAR_FIELD(eap);
1140 eap.cmdidx = CMD_block;
1141 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 eap.cmdlinep = &cmdline;
1143 eap.skip = !evaluate;
1144 if (evalarg->eval_cctx != NULL)
1145 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1146 else
1147 {
1148 eap.getline = evalarg->eval_getline;
1149 eap.cookie = evalarg->eval_cookie;
1150 }
1151
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001152 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001153 if (get_function_body(&eap, &newlines, NULL,
1154 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001155 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001156
1157 // When inside a lambda must add the function lines to evalarg.eval_ga.
1158 evalarg->eval_break_count += newlines.ga_len;
1159 if (gap->ga_itemsize > 0)
1160 {
1161 int idx;
1162 char_u *last;
1163 size_t plen;
1164 char_u *pnl;
1165
1166 for (idx = 0; idx < newlines.ga_len; ++idx)
1167 {
1168 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1169
Bram Moolenaarecb66452021-05-18 15:09:18 +02001170 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001171 goto erret;
1172
1173 // Going to concatenate the lines after parsing. For an empty or
1174 // comment line use an empty string.
1175 // Insert NL characters at the start of each line, the string will
1176 // be split again later in .get_lambda_tv().
1177 if (*p == NUL || vim9_comment_start(p))
1178 p = (char_u *)"";
1179 plen = STRLEN(p);
1180 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1181 if (pnl != NULL)
1182 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001183 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1184 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001185 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001186 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001187 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001188 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001189 // more is following after the "}", which was skipped
1190 last = cmdline;
1191 else
1192 // nothing is following the "}"
1193 last = (char_u *)"}";
1194 plen = STRLEN(last);
1195 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1196 if (pnl != NULL)
1197 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001198 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1199 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001200 }
1201
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001202 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001203 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001204 garray_T *tfgap = &evalarg->eval_tofree_ga;
1205
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 // Something comes after the "}".
1207 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001208
1209 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001210 if (ga_grow(tfgap, 1) == OK)
1211 {
1212 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1213 evalarg->eval_using_cmdline = TRUE;
1214 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001215 }
1216 else
1217 *arg = (char_u *)"";
1218
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001219 if (!evaluate)
1220 {
1221 ret = OK;
1222 goto erret;
1223 }
1224
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001225 name = get_lambda_name();
1226 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1227 if (ufunc == NULL)
1228 goto erret;
1229 set_ufunc_name(ufunc, name);
1230 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001231 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001232 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001233 ufunc->uf_refcount = 1;
1234 ufunc->uf_args = *newargs;
1235 newargs->ga_data = NULL;
1236 ufunc->uf_def_args = *default_args;
1237 default_args->ga_data = NULL;
1238 ufunc->uf_func_type = &t_func_any;
1239
1240 // error messages are for the first function line
1241 lnum_save = SOURCING_LNUM;
1242 SOURCING_LNUM = sourcing_lnum_top;
1243
1244 // parse argument types
1245 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1246 {
1247 SOURCING_LNUM = lnum_save;
1248 goto erret;
1249 }
1250
1251 // parse the return type, if any
1252 if (parse_return_type(ufunc, ret_type) == FAIL)
1253 goto erret;
1254
1255 pt = ALLOC_CLEAR_ONE(partial_T);
1256 if (pt == NULL)
1257 goto erret;
1258 pt->pt_func = ufunc;
1259 pt->pt_refcount = 1;
1260
1261 ufunc->uf_lines = newlines;
1262 newlines.ga_data = NULL;
1263 if (sandbox)
1264 ufunc->uf_flags |= FC_SANDBOX;
1265 if (!ASCII_ISUPPER(*ufunc->uf_name))
1266 ufunc->uf_flags |= FC_VIM9;
1267 ufunc->uf_script_ctx = current_sctx;
1268 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1269 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1270 set_function_type(ufunc);
1271
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001272 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1273
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001274 rettv->vval.v_partial = pt;
1275 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001276 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001277 ret = OK;
1278
1279erret:
1280 if (lnum_save >= 0)
1281 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001283 if (newargs != NULL)
1284 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001286 if (ufunc != NULL)
1287 {
1288 func_clear(ufunc, TRUE);
1289 func_free(ufunc, TRUE);
1290 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001291 return ret;
1292}
1293
1294/*
1295 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001296 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001297 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001298 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1299 */
1300 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001301get_lambda_tv(
1302 char_u **arg,
1303 typval_T *rettv,
1304 int types_optional,
1305 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001306{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001307 int evaluate = evalarg != NULL
1308 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309 garray_T newargs;
1310 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001311 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001312 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001313 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001315 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001316 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001317 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001318 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001319 char_u *s;
1320 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001321 int *old_eval_lavars = eval_lavars_used;
1322 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001323 char_u *tofree1 = NULL;
1324 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001325 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001326 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001327 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001328
1329 if (equal_arrow && !in_vim9script())
1330 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001331
1332 ga_init(&newargs);
1333 ga_init(&newlines);
1334
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001335 // First, check if this is really a lambda expression. "->" or "=>" must
1336 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001337 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001338 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001339 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001340 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001341 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001342 {
1343 if (types_optional)
1344 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001345 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001348 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001349 if (evaluate)
1350 pnewargs = &newargs;
1351 else
1352 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001353 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001354 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001355 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001356 &varargs, &default_args,
1357 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001358 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001359 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001360 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001361 {
1362 if (types_optional)
1363 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001364 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001365 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001366 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001367 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001368
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001369 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1370 if (ret_type != NULL)
1371 {
1372 ret_type = vim_strsave(ret_type);
1373 tofree2 = ret_type;
1374 }
1375
Bram Moolenaare38eab22019-12-05 21:50:01 +01001376 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001377 if (evaluate)
1378 eval_lavars_used = &eval_lavars;
1379
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380 *arg = skipwhite_and_linebreak(*arg, evalarg);
1381
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001382 // Recognize "{" as the start of a function body.
1383 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001384 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001385 if (evalarg == NULL)
1386 // cannot happen?
1387 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001388 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1389 types_optional ? &argtypes : NULL, varargs,
1390 &default_args, ret_type) == FAIL)
1391 goto errret;
1392 goto theend;
1393 }
1394 if (default_args.ga_len > 0)
1395 {
1396 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001397 goto errret;
1398 }
1399
Bram Moolenaare38eab22019-12-05 21:50:01 +01001400 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001401 start = *arg;
1402 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001403 if (ret == FAIL)
1404 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001405 if (evalarg != NULL)
1406 {
1407 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001408 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001409 evalarg->eval_tofree = NULL;
1410 }
1411
Bram Moolenaar65c44152020-12-24 15:14:01 +01001412 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001413 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001414 *arg = skipwhite_and_linebreak(*arg, evalarg);
1415 if (**arg != '}')
1416 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001417 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001418 goto errret;
1419 }
1420 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422
1423 if (evaluate)
1424 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001425 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001426 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001427 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001428 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001429 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001430
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001431 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 if (fp == NULL)
1433 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001434 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001435 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001436 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001437 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001439 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 if (ga_grow(&newlines, 1) == FAIL)
1441 goto errret;
1442
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001443 // If there are line breaks, we need to split up the string.
1444 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001445 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001446 line_end = end;
1447
1448 // Add "return " before the expression (or the first line).
1449 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001450 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 if (p == NULL)
1452 goto errret;
1453 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1454 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001455 vim_strncpy(p + 7, start, line_end - start);
1456
1457 if (line_end != end)
1458 {
1459 // Add more lines, split by line breaks. Thus is used when a
1460 // lambda with { cmds } is encountered.
1461 while (*line_end == '\n')
1462 {
1463 if (ga_grow(&newlines, 1) == FAIL)
1464 goto errret;
1465 start = line_end + 1;
1466 line_end = vim_strchr(start, '\n');
1467 if (line_end == NULL)
1468 line_end = end;
1469 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1470 vim_strnsave(start, line_end - start);
1471 }
1472 }
1473
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001474 if (strstr((char *)p + 7, "a:") == NULL)
1475 // No a: variables are used for sure.
1476 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477
1478 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001479 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001481 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001482 if (types_optional)
1483 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001484 if (parse_argument_types(fp, &argtypes,
1485 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001486 goto errret;
1487 if (ret_type != NULL)
1488 {
1489 fp->uf_ret_type = parse_type(&ret_type,
1490 &fp->uf_type_list, TRUE);
1491 if (fp->uf_ret_type == NULL)
1492 goto errret;
1493 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001494 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001495 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001496 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001497
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001499 if (current_funccal != NULL && eval_lavars)
1500 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001501 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001502 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001503 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001504 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505
1506#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 if (prof_def_func())
1508 func_do_profile(fp);
1509#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001510 if (sandbox)
1511 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001512 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001513 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1514 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001515 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001517 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001518 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001520 function_using_block_scopes(fp, evalarg->eval_cstack);
1521
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001522 pt->pt_func = fp;
1523 pt->pt_refcount = 1;
1524 rettv->vval.v_partial = pt;
1525 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001526
1527 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001530theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001531 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001532 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001533 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001534 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001535 vim_free(tofree1);
1536 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001537 if (types_optional)
1538 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001539
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001540 return OK;
1541
1542errret:
1543 ga_clear_strings(&newargs);
1544 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001545 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001546 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001547 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001548 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001549 if (fp != NULL)
1550 vim_free(fp->uf_arg_types);
1551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001553 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001554 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001555 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001556 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001557 vim_free(tofree1);
1558 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001559 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 return FAIL;
1561}
1562
1563/*
1564 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1565 * name it contains, otherwise return "name".
1566 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1567 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001568 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1569 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001570 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001571 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 */
1573 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001574deref_func_name(
1575 char_u *name,
1576 int *lenp,
1577 partial_T **partialp,
1578 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001579 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001580 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001581 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582{
1583 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001584 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001585 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001586 char_u *s = NULL;
1587 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001588 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589
1590 if (partialp != NULL)
1591 *partialp = NULL;
1592
1593 cc = name[*lenp];
1594 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001595
Bram Moolenaar71f21932022-01-07 18:20:55 +00001596 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001598 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001600 tv = &v->di_tv;
1601 }
1602 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1603 {
1604 imported_T *import;
1605 char_u *p = name;
1606 int len = *lenp;
1607
1608 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001610 p = name + 2;
1611 len -= 2;
1612 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001613 import = find_imported(p, len, FALSE, NULL);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001614
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001615 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001616 if (import != NULL)
1617 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001618 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001619 if (new_function)
1620 semsg(_(e_redefining_imported_item_str), name);
1621 else
1622 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001623 name[len] = cc;
1624 *lenp = 0;
1625 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001626 }
1627 }
1628
1629 if (tv != NULL)
1630 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001631 if (found_var != NULL)
1632 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001633 if (tv->v_type == VAR_FUNC)
1634 {
1635 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636 {
1637 *lenp = 0;
1638 return (char_u *)""; // just in case
1639 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001640 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001641 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001643
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001644 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001646 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001647
1648 if (pt == NULL)
1649 {
1650 *lenp = 0;
1651 return (char_u *)""; // just in case
1652 }
1653 if (partialp != NULL)
1654 *partialp = pt;
1655 s = partial_name(pt);
1656 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001658
1659 if (s != NULL)
1660 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001661 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001662 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001663 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001664
1665 if (sv != NULL)
1666 *type = sv->sv_type;
1667 }
1668 return s;
1669 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001670 }
1671
1672 return name;
1673}
1674
1675/*
1676 * Give an error message with a function name. Handle <SNR> things.
1677 * "ermsg" is to be passed without translation, use N_() instead of _().
1678 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001679 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680emsg_funcname(char *ermsg, char_u *name)
1681{
Bram Moolenaar54598062022-01-13 12:05:09 +00001682 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683
Bram Moolenaar54598062022-01-13 12:05:09 +00001684 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001686 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687 if (p != name)
1688 vim_free(p);
1689}
1690
1691/*
1692 * Allocate a variable for the result of a function.
1693 * Return OK or FAIL.
1694 */
1695 int
1696get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001697 char_u *name, // name of the function
1698 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001699 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001700 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001701 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001702 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703{
1704 char_u *argp;
1705 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001706 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1707 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001708 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001709 int evaluate = evalarg == NULL
1710 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001711
1712 /*
1713 * Get the arguments.
1714 */
1715 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001716 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1717 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001719 // skip the '(' or ',' and possibly line breaks
1720 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1721
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 if (*argp == ')' || *argp == ',' || *argp == NUL)
1723 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001724 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 {
1726 ret = FAIL;
1727 break;
1728 }
1729 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001730 // The comma should come right after the argument, but this wasn't
1731 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001732 if (vim9script)
1733 {
1734 if (*argp != ',' && *skipwhite(argp) == ',')
1735 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001736 if (evaluate)
1737 semsg(_(e_no_white_space_allowed_before_str_str),
1738 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001739 ret = FAIL;
1740 break;
1741 }
1742 }
1743 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001744 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 if (*argp != ',')
1746 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001747 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1748 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001749 if (evaluate)
1750 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001751 ret = FAIL;
1752 break;
1753 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001755 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001756 if (*argp == ')')
1757 ++argp;
1758 else
1759 ret = FAIL;
1760
1761 if (ret == OK)
1762 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001763 int i = 0;
1764 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765
1766 if (get_vim_var_nr(VV_TESTING))
1767 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001768 // Prepare for calling test_garbagecollect_now(), need to know
1769 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001770 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001771 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001772 for (i = 0; i < argcount; ++i)
1773 if (ga_grow(&funcargs, 1) == OK)
1774 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1775 &argvars[i];
1776 }
1777
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001778 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001779 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001780 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001781 // An error in a builtin function does not return FAIL, but we do
1782 // want to abort further processing if an error was given.
1783 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001784 clear_tv(rettv);
1785 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001786
1787 funcargs.ga_len -= i;
1788 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001789 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790 {
1791 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001792 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001794 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795 }
1796
1797 while (--argcount >= 0)
1798 clear_tv(&argvars[argcount]);
1799
Bram Moolenaar8294d492020-08-10 22:40:56 +02001800 if (in_vim9script())
1801 *arg = argp;
1802 else
1803 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804 return ret;
1805}
1806
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807/*
1808 * Return TRUE if "p" starts with "<SID>" or "s:".
1809 * Only works if eval_fname_script() returned non-zero for "p"!
1810 */
1811 static int
1812eval_fname_sid(char_u *p)
1813{
1814 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1815}
1816
1817/*
1818 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1819 * Change <SNR>123_name() to K_SNR 123_name().
1820 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1821 * (slow).
1822 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001823 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001824fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1825{
1826 int llen;
1827 char_u *fname;
1828 int i;
1829
1830 llen = eval_fname_script(name);
1831 if (llen > 0)
1832 {
1833 fname_buf[0] = K_SPECIAL;
1834 fname_buf[1] = KS_EXTRA;
1835 fname_buf[2] = (int)KE_SNR;
1836 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001837 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001839 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001840 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 else
1842 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001843 sprintf((char *)fname_buf + 3, "%ld_",
1844 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 i = (int)STRLEN(fname_buf);
1846 }
1847 }
1848 if (i + STRLEN(name + llen) < FLEN_FIXED)
1849 {
1850 STRCPY(fname_buf + i, name + llen);
1851 fname = fname_buf;
1852 }
1853 else
1854 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001855 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001857 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 else
1859 {
1860 *tofree = fname;
1861 mch_memmove(fname, fname_buf, (size_t)i);
1862 STRCPY(fname + i, name + llen);
1863 }
1864 }
1865 }
1866 else
1867 fname = name;
1868 return fname;
1869}
1870
1871/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001872 * Find a function "name" in script "sid".
1873 */
1874 static ufunc_T *
1875find_func_with_sid(char_u *name, int sid)
1876{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001877 hashitem_T *hi;
1878 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001879
Bram Moolenaarb8822442022-01-11 15:24:05 +00001880 if (!SCRIPT_ID_VALID(sid))
1881 return NULL; // not in a script
1882
1883 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001884 buffer[0] = K_SPECIAL;
1885 buffer[1] = KS_EXTRA;
1886 buffer[2] = (int)KE_SNR;
1887 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1888 (long)sid, name);
1889 hi = hash_find(&func_hashtab, buffer);
1890 if (!HASHITEM_EMPTY(hi))
1891 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001892 return NULL;
1893}
1894
1895/*
1896 * Find a function "name" in script "sid" prefixing the autoload prefix.
1897 */
1898 static ufunc_T *
1899find_func_with_prefix(char_u *name, int sid)
1900{
1901 hashitem_T *hi;
1902 char_u buffer[200];
1903 scriptitem_T *si;
1904
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001905 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001906 return NULL; // already has the prefix
1907 if (!SCRIPT_ID_VALID(sid))
1908 return NULL; // not in a script
1909 si = SCRIPT_ITEM(sid);
1910 if (si->sn_autoload_prefix != NULL)
1911 {
1912 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1913 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001914 char_u *namep;
1915
1916 // skip a "<SNR>99_" prefix
1917 namep = untrans_function_name(name);
1918 if (namep == NULL)
1919 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001920
1921 // An exported function in an autoload script is stored as
1922 // "dir#path#name".
1923 if (len < sizeof(buffer))
1924 auto_name = buffer;
1925 else
1926 auto_name = alloc(len);
1927 if (auto_name != NULL)
1928 {
1929 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001930 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001931 hi = hash_find(&func_hashtab, auto_name);
1932 if (auto_name != buffer)
1933 vim_free(auto_name);
1934 if (!HASHITEM_EMPTY(hi))
1935 return HI2UF(hi);
1936 }
1937 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001938
1939 return NULL;
1940}
1941
1942/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001944 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1945 * functions.
1946 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 * Return NULL for unknown function.
1948 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001949 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001950find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951{
1952 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001953 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001955 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001956 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001957 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1958 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001959
Bram Moolenaar95006e32020-08-29 17:47:08 +02001960 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001961 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001962 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001963 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1964 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001965 if (func != NULL)
1966 return func;
1967 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001968 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001969
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001970 if ((flags & FFED_NO_GLOBAL) == 0)
1971 {
1972 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02001973 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001974 if (!HASHITEM_EMPTY(hi))
1975 return HI2UF(hi);
1976 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001977
Bram Moolenaarb8822442022-01-11 15:24:05 +00001978 // Find autoload function if this is an autoload script.
1979 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1980 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001981}
1982
1983/*
1984 * Find a function by name, return pointer to it in ufuncs.
1985 * "cctx" is passed in a :def function to find imported functions.
1986 * Return NULL for unknown or dead function.
1987 */
1988 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001989find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001990{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001991 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001992
1993 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1994 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001995 return NULL;
1996}
1997
1998/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001999 * Return TRUE if "ufunc" is a global function.
2000 */
2001 int
2002func_is_global(ufunc_T *ufunc)
2003{
2004 return ufunc->uf_name[0] != K_SPECIAL;
2005}
2006
2007/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002008 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2009 */
2010 int
2011func_requires_g_prefix(ufunc_T *ufunc)
2012{
2013 return ufunc->uf_name[0] != K_SPECIAL
2014 && (ufunc->uf_flags & FC_LAMBDA) == 0
2015 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2016}
2017
2018/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002019 * Copy the function name of "fp" to buffer "buf".
2020 * "buf" must be able to hold the function name plus three bytes.
2021 * Takes care of script-local function names.
2022 */
2023 static void
2024cat_func_name(char_u *buf, ufunc_T *fp)
2025{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002026 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002027 {
2028 STRCPY(buf, "<SNR>");
2029 STRCAT(buf, fp->uf_name + 3);
2030 }
2031 else
2032 STRCPY(buf, fp->uf_name);
2033}
2034
2035/*
2036 * Add a number variable "name" to dict "dp" with value "nr".
2037 */
2038 static void
2039add_nr_var(
2040 dict_T *dp,
2041 dictitem_T *v,
2042 char *name,
2043 varnumber_T nr)
2044{
2045 STRCPY(v->di_key, name);
2046 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2047 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2048 v->di_tv.v_type = VAR_NUMBER;
2049 v->di_tv.v_lock = VAR_FIXED;
2050 v->di_tv.vval.v_number = nr;
2051}
2052
2053/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002054 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002055 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002056 static void
2057free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002058{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002059 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002060
2061 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2062 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002063 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002064
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002065 // When garbage collecting a funccall_T may be freed before the
2066 // function that references it, clear its uf_scoped field.
2067 // The function may have been redefined and point to another
2068 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002069 if (fp != NULL && fp->uf_scoped == fc)
2070 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002071 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002072 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002073
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002074 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002075 vim_free(fc);
2076}
2077
2078/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002079 * Free "fc" and what it contains.
2080 * Can be called only when "fc" is kept beyond the period of it called,
2081 * i.e. after cleanup_function_call(fc).
2082 */
2083 static void
2084free_funccal_contents(funccall_T *fc)
2085{
2086 listitem_T *li;
2087
2088 // Free all l: variables.
2089 vars_clear(&fc->l_vars.dv_hashtab);
2090
2091 // Free all a: variables.
2092 vars_clear(&fc->l_avars.dv_hashtab);
2093
2094 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002095 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002096 clear_tv(&li->li_tv);
2097
2098 free_funccal(fc);
2099}
2100
2101/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002102 * Handle the last part of returning from a function: free the local hashtable.
2103 * Unless it is still in use by a closure.
2104 */
2105 static void
2106cleanup_function_call(funccall_T *fc)
2107{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002108 int may_free_fc = fc->fc_refcount <= 0;
2109 int free_fc = TRUE;
2110
Bram Moolenaar6914c642017-04-01 21:21:30 +02002111 current_funccal = fc->caller;
2112
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002113 // Free all l: variables if not referred.
2114 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2115 vars_clear(&fc->l_vars.dv_hashtab);
2116 else
2117 free_fc = FALSE;
2118
2119 // If the a:000 list and the l: and a: dicts are not referenced and
2120 // there is no closure using it, we can free the funccall_T and what's
2121 // in it.
2122 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2123 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002124 else
2125 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002126 int todo;
2127 hashitem_T *hi;
2128 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002129
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002130 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002131
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002132 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002133 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2134 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2135 {
2136 if (!HASHITEM_EMPTY(hi))
2137 {
2138 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002139 di = HI2DI(hi);
2140 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002141 }
2142 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002143 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002144
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002145 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2146 fc->l_varlist.lv_first = NULL;
2147 else
2148 {
2149 listitem_T *li;
2150
2151 free_fc = FALSE;
2152
2153 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002154 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002155 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002156 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002157
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002158 if (free_fc)
2159 free_funccal(fc);
2160 else
2161 {
2162 static int made_copy = 0;
2163
2164 // "fc" is still in use. This can happen when returning "a:000",
2165 // assigning "l:" to a global variable or defining a closure.
2166 // Link "fc" in the list for garbage collection later.
2167 fc->caller = previous_funccal;
2168 previous_funccal = fc;
2169
2170 if (want_garbage_collect)
2171 // If garbage collector is ready, clear count.
2172 made_copy = 0;
2173 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002174 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002175 // We have made a lot of copies, worth 4 Mbyte. This can happen
2176 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002177 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002178 // too much memory.
2179 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002180 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002181 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002182 }
2183}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002184
2185/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002186 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2187 */
2188 static int
2189numbered_function(char_u *name)
2190{
2191 return isdigit(*name)
2192 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2193}
2194
2195/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002196 * There are two kinds of function names:
2197 * 1. ordinary names, function defined with :function or :def
2198 * 2. numbered functions and lambdas
2199 * For the first we only count the name stored in func_hashtab as a reference,
2200 * using function() does not count as a reference, because the function is
2201 * looked up by name.
2202 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002203 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002204func_name_refcount(char_u *name)
2205{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002206 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002207}
2208
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002209/*
2210 * Unreference "fc": decrement the reference count and free it when it
2211 * becomes zero. "fp" is detached from "fc".
2212 * When "force" is TRUE we are exiting.
2213 */
2214 static void
2215funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2216{
2217 funccall_T **pfc;
2218 int i;
2219
2220 if (fc == NULL)
2221 return;
2222
2223 if (--fc->fc_refcount <= 0 && (force || (
2224 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2225 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2226 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2227 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2228 {
2229 if (fc == *pfc)
2230 {
2231 *pfc = fc->caller;
2232 free_funccal_contents(fc);
2233 return;
2234 }
2235 }
2236 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2237 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2238 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2239}
2240
2241/*
2242 * Remove the function from the function hashtable. If the function was
2243 * deleted while it still has references this was already done.
2244 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2245 */
2246 static int
2247func_remove(ufunc_T *fp)
2248{
2249 hashitem_T *hi;
2250
2251 // Return if it was already virtually deleted.
2252 if (fp->uf_flags & FC_DEAD)
2253 return FALSE;
2254
2255 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2256 if (!HASHITEM_EMPTY(hi))
2257 {
2258 // When there is a def-function index do not actually remove the
2259 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002260 // Do remove it when it's a copy.
2261 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002262 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002263 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002264 return FALSE;
2265 }
2266 hash_remove(&func_hashtab, hi);
2267 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002268 return TRUE;
2269 }
2270 return FALSE;
2271}
2272
2273 static void
2274func_clear_items(ufunc_T *fp)
2275{
2276 ga_clear_strings(&(fp->uf_args));
2277 ga_clear_strings(&(fp->uf_def_args));
2278 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002279 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002280 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002281 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002282 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002283
2284 // Increment the refcount of this function to avoid it being freed
2285 // recursively when the partial is freed.
2286 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002287 partial_unref(fp->uf_partial);
2288 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002289 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002290
2291#ifdef FEAT_LUA
2292 if (fp->uf_cb_free != NULL)
2293 {
2294 fp->uf_cb_free(fp->uf_cb_state);
2295 fp->uf_cb_free = NULL;
2296 }
2297
2298 fp->uf_cb_state = NULL;
2299 fp->uf_cb = NULL;
2300#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002301#ifdef FEAT_PROFILE
2302 VIM_CLEAR(fp->uf_tml_count);
2303 VIM_CLEAR(fp->uf_tml_total);
2304 VIM_CLEAR(fp->uf_tml_self);
2305#endif
2306}
2307
2308/*
2309 * Free all things that a function contains. Does not free the function
2310 * itself, use func_free() for that.
2311 * When "force" is TRUE we are exiting.
2312 */
2313 static void
2314func_clear(ufunc_T *fp, int force)
2315{
2316 if (fp->uf_cleared)
2317 return;
2318 fp->uf_cleared = TRUE;
2319
2320 // clear this function
2321 func_clear_items(fp);
2322 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002323 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002324}
2325
2326/*
2327 * Free a function and remove it from the list of functions. Does not free
2328 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002329 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002330 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002331 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002332 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002333func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002334{
2335 // Only remove it when not done already, otherwise we would remove a newer
2336 // version of the function with the same name.
2337 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2338 func_remove(fp);
2339
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002340 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002341 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002342 if (fp->uf_dfunc_idx > 0)
2343 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002344 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002345 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002346 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002347 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002348 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002349}
2350
2351/*
2352 * Free all things that a function contains and free the function itself.
2353 * When "force" is TRUE we are exiting.
2354 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002355 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002356func_clear_free(ufunc_T *fp, int force)
2357{
2358 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002359 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2360 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002361 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002362 else
2363 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002364}
2365
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002366/*
2367 * Copy already defined function "lambda" to a new function with name "global".
2368 * This is for when a compiled function defines a global function.
2369 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002370 int
2371copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002372{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002373 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002374 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002375
2376 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002377 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002378 semsg(_(e_lambda_function_not_found_str), lambda);
2379 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002380 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002381
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002382 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002383 if (fp != NULL)
2384 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002385 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002386 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002387 return FAIL;
2388 }
2389
2390 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2391 if (fp == NULL)
2392 return FAIL;
2393
2394 fp->uf_varargs = ufunc->uf_varargs;
2395 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2396 fp->uf_def_status = ufunc->uf_def_status;
2397 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2398 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2399 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2400 == FAIL
2401 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2402 goto failed;
2403
2404 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2405 : vim_strsave(ufunc->uf_name_exp);
2406 if (ufunc->uf_arg_types != NULL)
2407 {
2408 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2409 if (fp->uf_arg_types == NULL)
2410 goto failed;
2411 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2412 sizeof(type_T *) * fp->uf_args.ga_len);
2413 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002414 if (ufunc->uf_va_name != NULL)
2415 {
2416 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2417 if (fp->uf_va_name == NULL)
2418 goto failed;
2419 }
2420 fp->uf_ret_type = ufunc->uf_ret_type;
2421
2422 fp->uf_refcount = 1;
2423 STRCPY(fp->uf_name, global);
2424 hash_add(&func_hashtab, UF2HIKEY(fp));
2425
2426 // the referenced dfunc_T is now used one more time
2427 link_def_function(fp);
2428
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002429 // Create a partial to store the context of the function where it was
2430 // instantiated. Only needs to be done once. Do this on the original
2431 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002432 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2433 {
2434 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2435
2436 if (pt == NULL)
2437 goto failed;
2438 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002439 {
2440 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002441 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002442 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002443 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002444 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002445 }
2446
2447 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002448
2449failed:
2450 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002451 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002452}
2453
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002454static int funcdepth = 0;
2455
2456/*
2457 * Increment the function call depth count.
2458 * Return FAIL when going over 'maxfuncdepth'.
2459 * Otherwise return OK, must call funcdepth_decrement() later!
2460 */
2461 int
2462funcdepth_increment(void)
2463{
2464 if (funcdepth >= p_mfd)
2465 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002466 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002467 return FAIL;
2468 }
2469 ++funcdepth;
2470 return OK;
2471}
2472
2473 void
2474funcdepth_decrement(void)
2475{
2476 --funcdepth;
2477}
2478
2479/*
2480 * Get the current function call depth.
2481 */
2482 int
2483funcdepth_get(void)
2484{
2485 return funcdepth;
2486}
2487
2488/*
2489 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002490 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002491 * times as funcdepth_increment().
2492 */
2493 void
2494funcdepth_restore(int depth)
2495{
2496 funcdepth = depth;
2497}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002498
2499/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 * Call a user function.
2501 */
2502 static void
2503call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002504 ufunc_T *fp, // pointer to function
2505 int argcount, // nr of args
2506 typval_T *argvars, // arguments
2507 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002508 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002509 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002511 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002512 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513 funccall_T *fc;
2514 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002515 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002517 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 int i;
2519 int ai;
2520 int islambda = FALSE;
2521 char_u numbuf[NUMBUFLEN];
2522 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002523 typval_T *tv_to_free[MAX_FUNC_ARGS];
2524 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002526 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002527#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002528 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529
Bram Moolenaarb2049902021-01-24 12:53:53 +01002530#ifdef FEAT_PROFILE
2531 CLEAR_FIELD(profile_info);
2532#endif
2533
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002534 // If depth of calling is getting too high, don't execute the function.
2535 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537 rettv->v_type = VAR_NUMBER;
2538 rettv->vval.v_number = -1;
2539 return;
2540 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541
Bram Moolenaare38eab22019-12-05 21:50:01 +01002542 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002544 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002545 if (fc == NULL)
2546 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 fc->caller = current_funccal;
2548 current_funccal = fc;
2549 fc->func = fp;
2550 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002551 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002552 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2554 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002555 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002556 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002557 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002559 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002560 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002561#ifdef FEAT_PROFILE
2562 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2563#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002564 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002565#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002566 if (do_profiling == PROF_YES)
2567 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002568#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002569 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002570 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002571#ifdef FEAT_PROFILE
2572 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002573 || (caller != NULL && caller->uf_profiling)))
2574 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002575#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002576 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002577 free_funccal(fc);
2578 return;
2579 }
2580
Bram Moolenaar38453522021-11-28 22:00:12 +00002581 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582
2583 /*
2584 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2585 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2586 * each argument variable and saves a lot of time.
2587 */
2588 /*
2589 * Init l: variables.
2590 */
2591 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2592 if (selfdict != NULL)
2593 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002594 // Set l:self to "selfdict". Use "name" to avoid a warning from
2595 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002596 v = &fc->fixvar[fixvar_idx++].var;
2597 name = v->di_key;
2598 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002599 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002600 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2601 v->di_tv.v_type = VAR_DICT;
2602 v->di_tv.v_lock = 0;
2603 v->di_tv.vval.v_dict = selfdict;
2604 ++selfdict->dv_refcount;
2605 }
2606
2607 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002608 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002609 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 * Set a:000 to a list with room for the "..." arguments.
2611 */
2612 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002613 if ((fp->uf_flags & FC_NOARGS) == 0)
2614 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002615 (varnumber_T)(argcount >= fp->uf_args.ga_len
2616 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002617 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002618 if ((fp->uf_flags & FC_NOARGS) == 0)
2619 {
2620 // Use "name" to avoid a warning from some compiler that checks the
2621 // destination size.
2622 v = &fc->fixvar[fixvar_idx++].var;
2623 name = v->di_key;
2624 STRCPY(name, "000");
2625 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2626 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2627 v->di_tv.v_type = VAR_LIST;
2628 v->di_tv.v_lock = VAR_FIXED;
2629 v->di_tv.vval.v_list = &fc->l_varlist;
2630 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002631 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2633 fc->l_varlist.lv_lock = VAR_FIXED;
2634
2635 /*
2636 * Set a:firstline to "firstline" and a:lastline to "lastline".
2637 * Set a:name to named arguments.
2638 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002639 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002641 if ((fp->uf_flags & FC_NOARGS) == 0)
2642 {
2643 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002644 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002645 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002646 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002647 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002648 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 {
2650 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002651 typval_T def_rettv;
2652 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653
2654 ai = i - fp->uf_args.ga_len;
2655 if (ai < 0)
2656 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002657 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002658 name = FUNCARG(fp, i);
2659 if (islambda)
2660 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002661
2662 // evaluate named argument default expression
2663 isdefault = ai + fp->uf_def_args.ga_len >= 0
2664 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2665 && argvars[i].vval.v_number == VVAL_NONE));
2666 if (isdefault)
2667 {
2668 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002669
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002670 def_rettv.v_type = VAR_NUMBER;
2671 def_rettv.vval.v_number = -1;
2672
2673 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2674 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002675 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002676 {
2677 default_arg_err = 1;
2678 break;
2679 }
2680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 }
2682 else
2683 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002684 if ((fp->uf_flags & FC_NOARGS) != 0)
2685 // Bail out if no a: arguments used (in lambda).
2686 break;
2687
Bram Moolenaare38eab22019-12-05 21:50:01 +01002688 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689 sprintf((char *)numbuf, "%d", ai + 1);
2690 name = numbuf;
2691 }
2692 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2693 {
2694 v = &fc->fixvar[fixvar_idx++].var;
2695 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002696 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697 }
2698 else
2699 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002700 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701 if (v == NULL)
2702 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002703 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002706 // Note: the values are copied directly to avoid alloc/free.
2707 // "argvars" must have VAR_FIXED for v_lock.
2708 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 v->di_tv.v_lock = VAR_FIXED;
2710
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002711 if (isdefault)
2712 // Need to free this later, no matter where it's stored.
2713 tv_to_free[tv_to_free_len++] = &v->di_tv;
2714
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 if (addlocal)
2716 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002717 // Named arguments should be accessed without the "a:" prefix in
2718 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002719 copy_tv(&v->di_tv, &v->di_tv);
2720 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002722 else
2723 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724
2725 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2726 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002727 listitem_T *li = &fc->l_listitems[ai];
2728
2729 li->li_tv = argvars[i];
2730 li->li_tv.v_lock = VAR_FIXED;
2731 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002732 }
2733 }
2734
Bram Moolenaare38eab22019-12-05 21:50:01 +01002735 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002737
2738 if (fp->uf_flags & FC_SANDBOX)
2739 {
2740 using_sandbox = TRUE;
2741 ++sandbox;
2742 }
2743
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002744 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002745 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002746 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002748 ++no_wait_return;
2749 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002751 smsg(_("calling %s"), SOURCING_NAME);
2752 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002754 char_u buf[MSG_BUF_LEN];
2755 char_u numbuf2[NUMBUFLEN];
2756 char_u *tofree;
2757 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002758
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002759 msg_puts("(");
2760 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002762 if (i > 0)
2763 msg_puts(", ");
2764 if (argvars[i].v_type == VAR_NUMBER)
2765 msg_outnum((long)argvars[i].vval.v_number);
2766 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002768 // Do not want errors such as E724 here.
2769 ++emsg_off;
2770 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2771 --emsg_off;
2772 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002774 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002776 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2777 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002779 msg_puts((char *)s);
2780 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 }
2782 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002784 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002786 msg_puts("\n"); // don't overwrite this either
2787
2788 verbose_leave_scroll();
2789 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 }
2791#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002792 if (do_profiling == PROF_YES)
2793 profile_may_start_func(&profile_info, fp,
2794 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795#endif
2796
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002797 save_current_sctx = current_sctx;
2798 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799 save_did_emsg = did_emsg;
2800 did_emsg = FALSE;
2801
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002802 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2803 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002804 else if (islambda)
2805 {
2806 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2807
2808 // A Lambda always has the command "return {expr}". It is much faster
2809 // to evaluate {expr} directly.
2810 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002811 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002812 --ex_nesting_level;
2813 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002814 else
2815 // call do_cmdline() to execute the lines
2816 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2818
2819 --RedrawingDisabled;
2820
Bram Moolenaare38eab22019-12-05 21:50:01 +01002821 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2823 {
2824 clear_tv(rettv);
2825 rettv->v_type = VAR_NUMBER;
2826 rettv->vval.v_number = -1;
2827 }
2828
2829#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002830 if (do_profiling == PROF_YES)
2831 {
2832 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2833
2834 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2835 profile_may_end_func(&profile_info, fp, caller);
2836 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837#endif
2838
Bram Moolenaare38eab22019-12-05 21:50:01 +01002839 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840 if (p_verbose >= 12)
2841 {
2842 ++no_wait_return;
2843 verbose_enter_scroll();
2844
2845 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002846 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002848 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 (long)fc->rettv->vval.v_number);
2850 else
2851 {
2852 char_u buf[MSG_BUF_LEN];
2853 char_u numbuf2[NUMBUFLEN];
2854 char_u *tofree;
2855 char_u *s;
2856
Bram Moolenaare38eab22019-12-05 21:50:01 +01002857 // The value may be very long. Skip the middle part, so that we
2858 // have some idea how it starts and ends. smsg() would always
2859 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 ++emsg_off;
2861 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2862 --emsg_off;
2863 if (s != NULL)
2864 {
2865 if (vim_strsize(s) > MSG_BUF_CLEN)
2866 {
2867 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2868 s = buf;
2869 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002870 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 vim_free(tofree);
2872 }
2873 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002874 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875
2876 verbose_leave_scroll();
2877 --no_wait_return;
2878 }
2879
Bram Moolenaare31ee862020-01-07 20:59:34 +01002880 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002881 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002882 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883#ifdef FEAT_PROFILE
2884 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002885 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002886#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002887 if (using_sandbox)
2888 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002890 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002891 {
2892 ++no_wait_return;
2893 verbose_enter_scroll();
2894
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002895 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002896 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897
2898 verbose_leave_scroll();
2899 --no_wait_return;
2900 }
2901
2902 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002903 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002904 for (i = 0; i < tv_to_free_len; ++i)
2905 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002906 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907}
2908
2909/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002910 * Check the argument count for user function "fp".
2911 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2912 */
2913 int
2914check_user_func_argcount(ufunc_T *fp, int argcount)
2915{
2916 int regular_args = fp->uf_args.ga_len;
2917
2918 if (argcount < regular_args - fp->uf_def_args.ga_len)
2919 return FCERR_TOOFEW;
2920 else if (!has_varargs(fp) && argcount > regular_args)
2921 return FCERR_TOOMANY;
2922 return FCERR_UNKNOWN;
2923}
2924
2925/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002926 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002927 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002928 int
2929call_user_func_check(
2930 ufunc_T *fp,
2931 int argcount,
2932 typval_T *argvars,
2933 typval_T *rettv,
2934 funcexe_T *funcexe,
2935 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002936{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002937 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002938
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002939 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2940 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002941 error = check_user_func_argcount(fp, argcount);
2942 if (error != FCERR_UNKNOWN)
2943 return error;
2944 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002945 error = FCERR_DICT;
2946 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002947 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002948 int did_save_redo = FALSE;
2949 save_redo_T save_redo;
2950
2951 /*
2952 * Call the user function.
2953 * Save and restore search patterns, script variables and
2954 * redo buffer.
2955 */
2956 save_search_patterns();
2957 if (!ins_compl_active())
2958 {
2959 saveRedobuff(&save_redo);
2960 did_save_redo = TRUE;
2961 }
2962 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002963 call_user_func(fp, argcount, argvars, rettv, funcexe,
2964 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002965 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2966 // Function was unreferenced while being used, free it now.
2967 func_clear_free(fp, FALSE);
2968 if (did_save_redo)
2969 restoreRedobuff(&save_redo);
2970 restore_search_patterns();
2971 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002972 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002973 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002974}
2975
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002976static funccal_entry_T *funccal_stack = NULL;
2977
2978/*
2979 * Save the current function call pointer, and set it to NULL.
2980 * Used when executing autocommands and for ":source".
2981 */
2982 void
2983save_funccal(funccal_entry_T *entry)
2984{
2985 entry->top_funccal = current_funccal;
2986 entry->next = funccal_stack;
2987 funccal_stack = entry;
2988 current_funccal = NULL;
2989}
2990
2991 void
2992restore_funccal(void)
2993{
2994 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002995 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002996 else
2997 {
2998 current_funccal = funccal_stack->top_funccal;
2999 funccal_stack = funccal_stack->next;
3000 }
3001}
3002
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003003 funccall_T *
3004get_current_funccal(void)
3005{
3006 return current_funccal;
3007}
3008
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003009/*
3010 * Mark all functions of script "sid" as deleted.
3011 */
3012 void
3013delete_script_functions(int sid)
3014{
3015 hashitem_T *hi;
3016 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003017 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003018 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003019 size_t len;
3020
3021 buf[0] = K_SPECIAL;
3022 buf[1] = KS_EXTRA;
3023 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003024 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003025 len = STRLEN(buf);
3026
Bram Moolenaarce658352020-07-31 23:47:12 +02003027 while (todo > 0)
3028 {
3029 todo = func_hashtab.ht_used;
3030 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3031 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003032 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003033 fp = HI2UF(hi);
3034 if (STRNCMP(fp->uf_name, buf, len) == 0)
3035 {
3036 int changed = func_hashtab.ht_changed;
3037
3038 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003039
3040 if (fp->uf_calls > 0)
3041 {
3042 // Function is executing, don't free it but do remove
3043 // it from the hashtable.
3044 if (func_remove(fp))
3045 fp->uf_refcount--;
3046 }
3047 else
3048 {
3049 func_clear(fp, TRUE);
3050 // When clearing a function another function can be
3051 // cleared as a side effect. When that happens start
3052 // over.
3053 if (changed != func_hashtab.ht_changed)
3054 break;
3055 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003056 }
3057 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003058 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003059 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003060}
3061
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062#if defined(EXITFREE) || defined(PROTO)
3063 void
3064free_all_functions(void)
3065{
3066 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003067 ufunc_T *fp;
3068 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003069 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003070 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003071
Bram Moolenaare38eab22019-12-05 21:50:01 +01003072 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003073 while (current_funccal != NULL)
3074 {
3075 clear_tv(current_funccal->rettv);
3076 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003077 if (current_funccal == NULL && funccal_stack != NULL)
3078 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003079 }
3080
Bram Moolenaare38eab22019-12-05 21:50:01 +01003081 // First clear what the functions contain. Since this may lower the
3082 // reference count of a function, it may also free a function and change
3083 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003084 while (todo > 0)
3085 {
3086 todo = func_hashtab.ht_used;
3087 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3088 if (!HASHITEM_EMPTY(hi))
3089 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003090 // clear the def function index now
3091 fp = HI2UF(hi);
3092 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003093 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003094
Bram Moolenaare38eab22019-12-05 21:50:01 +01003095 // Only free functions that are not refcounted, those are
3096 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003097 if (func_name_refcount(fp->uf_name))
3098 ++skipped;
3099 else
3100 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003101 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003102 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003103 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003104 {
3105 skipped = 0;
3106 break;
3107 }
3108 }
3109 --todo;
3110 }
3111 }
3112
Bram Moolenaare38eab22019-12-05 21:50:01 +01003113 // Now actually free the functions. Need to start all over every time,
3114 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003115 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003116 while (func_hashtab.ht_used > skipped)
3117 {
3118 todo = func_hashtab.ht_used;
3119 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120 if (!HASHITEM_EMPTY(hi))
3121 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003122 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003123 // Only free functions that are not refcounted, those are
3124 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003125 fp = HI2UF(hi);
3126 if (func_name_refcount(fp->uf_name))
3127 ++skipped;
3128 else
3129 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003130 if (func_free(fp, FALSE) == OK)
3131 {
3132 skipped = 0;
3133 break;
3134 }
3135 // did not actually free it
3136 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003137 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003139 }
3140 if (skipped == 0)
3141 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003142
3143 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144}
3145#endif
3146
3147/*
3148 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003149 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3150 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 * "len" is the length of "name", or -1 for NUL terminated.
3152 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003153 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003154builtin_function(char_u *name, int len)
3155{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003156 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157
Bram Moolenaara26b9702020-04-18 19:53:28 +02003158 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003159 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003160 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3161 {
3162 if (name[i] == AUTOLOAD_CHAR)
3163 return FALSE;
3164 if (!eval_isnamec(name[i]))
3165 {
3166 // "name.something" is not a builtin function
3167 if (name[i] == '.')
3168 return FALSE;
3169 break;
3170 }
3171 }
3172 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003173}
3174
3175 int
3176func_call(
3177 char_u *name,
3178 typval_T *args,
3179 partial_T *partial,
3180 dict_T *selfdict,
3181 typval_T *rettv)
3182{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003183 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 listitem_T *item;
3185 typval_T argv[MAX_FUNC_ARGS + 1];
3186 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003187 int r = 0;
3188
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003189 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003190 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191 {
3192 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3193 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003194 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195 break;
3196 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003197 // Make a copy of each argument. This is needed to be able to set
3198 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003199 copy_tv(&item->li_tv, &argv[argc++]);
3200 }
3201
3202 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003203 {
3204 funcexe_T funcexe;
3205
Bram Moolenaara80faa82020-04-12 19:37:17 +02003206 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003207 funcexe.fe_firstline = curwin->w_cursor.lnum;
3208 funcexe.fe_lastline = curwin->w_cursor.lnum;
3209 funcexe.fe_evaluate = TRUE;
3210 funcexe.fe_partial = partial;
3211 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003212 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3213 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214
Bram Moolenaare38eab22019-12-05 21:50:01 +01003215 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 while (argc > 0)
3217 clear_tv(&argv[--argc]);
3218
3219 return r;
3220}
3221
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003222static int callback_depth = 0;
3223
3224 int
3225get_callback_depth(void)
3226{
3227 return callback_depth;
3228}
3229
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003231 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003232 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003233 */
3234 int
3235call_callback(
3236 callback_T *callback,
3237 int len, // length of "name" or -1 to use strlen()
3238 typval_T *rettv, // return value goes here
3239 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003240 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003241 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003242{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003243 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003244 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003245
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003246 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3247 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003248 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003249 funcexe.fe_evaluate = TRUE;
3250 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003251 ++callback_depth;
3252 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3253 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003254
3255 // When a :def function was called that uses :try an error would be turned
3256 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003257 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003258 {
3259 need_rethrow = FALSE;
3260 handle_did_throw();
3261 }
3262
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003263 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003264}
3265
3266/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003267 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003268 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003269 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3270 */
3271 varnumber_T
3272call_callback_retnr(
3273 callback_T *callback,
3274 int argcount, // number of "argvars"
3275 typval_T *argvars) // vars for arguments, must have "argcount"
3276 // PLUS ONE elements!
3277{
3278 typval_T rettv;
3279 varnumber_T retval;
3280
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003281 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003282 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003283
3284 retval = tv_get_number_chk(&rettv, NULL);
3285 clear_tv(&rettv);
3286 return retval;
3287}
3288
3289/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003290 * Give an error message for the result of a function.
3291 * Nothing if "error" is FCERR_NONE.
3292 */
3293 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003294user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003295{
3296 switch (error)
3297 {
3298 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003299 if (funcexe->fe_found_var)
3300 semsg(_(e_not_callable_type_str), name);
3301 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003302 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003303 break;
3304 case FCERR_NOTMETHOD:
3305 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003306 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307 break;
3308 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003309 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 break;
3311 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003312 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003313 break;
3314 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003315 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003316 break;
3317 case FCERR_SCRIPT:
3318 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003319 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 break;
3321 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003322 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3323 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003324 break;
3325 }
3326}
3327
3328/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003330 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331 * Return FAIL when the function can't be called, OK otherwise.
3332 * Also returns OK when an error was encountered while executing the function.
3333 */
3334 int
3335call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003336 char_u *funcname, // name of the function
3337 int len, // length of "name" or -1 to use strlen()
3338 typval_T *rettv, // return value goes here
3339 int argcount_in, // number of "argvars"
3340 typval_T *argvars_in, // vars for arguments, must have "argcount"
3341 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003342 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343{
3344 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003345 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003347 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003348 char_u fname_buf[FLEN_FIXED + 1];
3349 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003350 char_u *fname = NULL;
3351 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 int argcount = argcount_in;
3353 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003354 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003355 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003356 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003358 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003359 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003360 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003361 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003363 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3364 // even when call_func() returns FAIL.
3365 rettv->v_type = VAR_UNKNOWN;
3366
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003367 if (partial != NULL)
3368 fp = partial->pt_func;
3369 if (fp == NULL)
3370 {
3371 // Make a copy of the name, if it comes from a funcref variable it
3372 // could be changed or deleted in the called function.
3373 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3374 if (name == NULL)
3375 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003377 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3378 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003379
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003380 if (funcexe->fe_doesrange != NULL)
3381 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382
3383 if (partial != NULL)
3384 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003385 // When the function has a partial with a dict and there is a dict
3386 // argument, use the dict argument. That is backwards compatible.
3387 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003388 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003390 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003391 {
3392 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003393 {
3394 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3395 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003396 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003397 goto theend;
3398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003400 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 for (i = 0; i < argcount_in; ++i)
3402 argv[i + argv_clear] = argvars_in[i];
3403 argvars = argv;
3404 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003405
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003406 if (funcexe->fe_check_type != NULL
3407 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003408 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003409 // Now funcexe->fe_check_type is missing the added arguments,
3410 // make a copy of the type with the correction.
3411 check_type = *funcexe->fe_check_type;
3412 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003413 check_type.tt_args = check_type_args;
3414 CLEAR_FIELD(check_type_args);
3415 for (i = 0; i < check_type.tt_argcount; ++i)
3416 check_type_args[i + partial->pt_argc] =
3417 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003418 check_type.tt_argcount += partial->pt_argc;
3419 check_type.tt_min_argcount += partial->pt_argc;
3420 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 }
3422 }
3423
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003424 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3425 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003426 {
3427 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003428 if (check_argument_types(funcexe->fe_check_type,
3429 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003430 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003431 error = FCERR_OTHER;
3432 }
3433
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003434 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 {
3436 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003437 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438
Bram Moolenaar333894b2020-08-01 18:53:07 +02003439 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003440 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003441 {
3442 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003444 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445
Bram Moolenaare38eab22019-12-05 21:50:01 +01003446 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003448 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003450 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003451 {
3452 /*
3453 * User defined function.
3454 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003455 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003456 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003457 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003458 if (fp != NULL && !is_global && in_vim9script()
3459 && func_requires_g_prefix(fp))
3460 // In Vim9 script g: is required to find a global
3461 // non-autoload function.
3462 fp = NULL;
3463 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003464
Bram Moolenaare38eab22019-12-05 21:50:01 +01003465 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 if (fp == NULL
3467 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003468 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003469 && !aborting())
3470 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003471 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003472 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003474 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003475 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3476 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003477 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003478 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003480 if (fp == NULL)
3481 {
3482 char_u *p = untrans_function_name(rfname);
3483
3484 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003485 // Don't do this if the name starts with "s:".
3486 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003487 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003488 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003490 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003491 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003492#ifdef FEAT_LUA
3493 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3494 {
3495 cfunc_T cb = fp->uf_cb;
3496
3497 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3498 }
3499#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003500 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003502 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003503 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003504 argcount = funcexe->fe_argv_func(argcount, argvars,
3505 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003506
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003507 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003508 {
3509 // Method call: base->Method()
3510 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003511 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003512 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003513 argvars = argv;
3514 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003515 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003516
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003517 error = call_user_func_check(fp, argcount, argvars, rettv,
3518 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003519 }
3520 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003521 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003522 {
3523 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003524 * expr->method(): Find the method name in the table, call its
3525 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003526 */
3527 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003528 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 else
3531 {
3532 /*
3533 * Find the function name in the table, call its implementation.
3534 */
3535 error = call_internal_func(fname, argcount, argvars, rettv);
3536 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003537
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538 /*
3539 * The function call (or "FuncUndefined" autocommand sequence) might
3540 * have been aborted by an error, an interrupt, or an explicitly thrown
3541 * exception that has not been caught so far. This situation can be
3542 * tested for by calling aborting(). For an error in an internal
3543 * function or for the "E132" error in call_user_func(), however, the
3544 * throw point at which the "force_abort" flag (temporarily reset by
3545 * emsg()) is normally updated has not been reached yet. We need to
3546 * update that flag first to make aborting() reliable.
3547 */
3548 update_force_abort();
3549 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003550 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 ret = OK;
3552
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003553theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 /*
3555 * Report an error unless the argument evaluation or function call has been
3556 * cancelled due to an aborting error, an interrupt, or an exception.
3557 */
3558 if (!aborting())
3559 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003560 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 }
3562
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003563 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003565 clear_tv(&argv[--argv_clear + argv_base]);
3566
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 vim_free(tofree);
3568 vim_free(name);
3569
3570 return ret;
3571}
3572
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003573 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003574printable_func_name(ufunc_T *fp)
3575{
3576 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3577}
3578
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003580 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 */
3582 static void
3583list_func_head(ufunc_T *fp, int indent)
3584{
3585 int j;
3586
3587 msg_start();
3588 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003589 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003590 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003591 msg_puts("def ");
3592 else
3593 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003594 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 msg_putchar('(');
3596 for (j = 0; j < fp->uf_args.ga_len; ++j)
3597 {
3598 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003599 msg_puts(", ");
3600 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003601 if (fp->uf_arg_types != NULL)
3602 {
3603 char *tofree;
3604
3605 msg_puts(": ");
3606 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3607 vim_free(tofree);
3608 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003609 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3610 {
3611 msg_puts(" = ");
3612 msg_puts(((char **)(fp->uf_def_args.ga_data))
3613 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3614 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003615 }
3616 if (fp->uf_varargs)
3617 {
3618 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003619 msg_puts(", ");
3620 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003622 if (fp->uf_va_name != NULL)
3623 {
3624 if (j)
3625 msg_puts(", ");
3626 msg_puts("...");
3627 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003628 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003629 {
3630 char *tofree;
3631
3632 msg_puts(": ");
3633 msg_puts(type_name(fp->uf_va_type, &tofree));
3634 vim_free(tofree);
3635 }
3636 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003637 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003638
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003639 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003640 {
3641 if (fp->uf_ret_type != &t_void)
3642 {
3643 char *tofree;
3644
3645 msg_puts(": ");
3646 msg_puts(type_name(fp->uf_ret_type, &tofree));
3647 vim_free(tofree);
3648 }
3649 }
3650 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003651 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003653 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003655 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003656 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003657 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658 msg_clr_eos();
3659 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003660 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661}
3662
3663/*
3664 * Get a function name, translating "<SID>" and "<SNR>".
3665 * Also handles a Funcref in a List or Dictionary.
3666 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003667 * Set "*is_global" to TRUE when the function must be global, unless
3668 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 * flags:
3670 * TFN_INT: internal function name OK
3671 * TFN_QUIET: be quiet
3672 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003673 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 * Advances "pp" to just after the function name (if no error).
3675 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003676 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677trans_function_name(
3678 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003679 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003680 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003682 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003683 partial_T **partial, // return: partial of a FuncRef
3684 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685{
3686 char_u *name = NULL;
3687 char_u *start;
3688 char_u *end;
3689 int lead;
3690 char_u sid_buf[20];
3691 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003692 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003693 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003695 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696
3697 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003698 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 start = *pp;
3700
Bram Moolenaare38eab22019-12-05 21:50:01 +01003701 // Check for hard coded <SNR>: already translated function ID (from a user
3702 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3704 && (*pp)[2] == (int)KE_SNR)
3705 {
3706 *pp += 3;
3707 len = get_id_len(pp) + 3;
3708 return vim_strnsave(start, len);
3709 }
3710
Bram Moolenaare38eab22019-12-05 21:50:01 +01003711 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3712 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 lead = eval_fname_script(start);
3714 if (lead > 2)
3715 start += lead;
3716
Bram Moolenaare38eab22019-12-05 21:50:01 +01003717 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003718 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaare6a42002022-01-21 10:32:58 +00003720 if (end == start || (in_vim9script() && end != NULL
3721 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 {
3723 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003724 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 goto theend;
3726 }
3727 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3728 {
3729 /*
3730 * Report an invalid expression in braces, unless the expression
3731 * evaluation has been cancelled due to an aborting error, an
3732 * interrupt, or an exception.
3733 */
3734 if (!aborting())
3735 {
3736 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003737 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 }
3739 else
3740 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3741 goto theend;
3742 }
3743
3744 if (lv.ll_tv != NULL)
3745 {
3746 if (fdp != NULL)
3747 {
3748 fdp->fd_dict = lv.ll_dict;
3749 fdp->fd_newkey = lv.ll_newkey;
3750 lv.ll_newkey = NULL;
3751 fdp->fd_di = lv.ll_di;
3752 }
3753 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3754 {
3755 name = vim_strsave(lv.ll_tv->vval.v_string);
3756 *pp = end;
3757 }
3758 else if (lv.ll_tv->v_type == VAR_PARTIAL
3759 && lv.ll_tv->vval.v_partial != NULL)
3760 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003761 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003762 *pp = end;
3763 if (partial != NULL)
3764 *partial = lv.ll_tv->vval.v_partial;
3765 }
3766 else
3767 {
3768 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3769 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003770 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 else
3772 *pp = end;
3773 name = NULL;
3774 }
3775 goto theend;
3776 }
3777
3778 if (lv.ll_name == NULL)
3779 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003780 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 *pp = end;
3782 goto theend;
3783 }
3784
Bram Moolenaare38eab22019-12-05 21:50:01 +01003785 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 if (lv.ll_exp_name != NULL)
3787 {
3788 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003789 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003790 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 if (name == lv.ll_exp_name)
3792 name = NULL;
3793 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003794 else if (lv.ll_sid > 0)
3795 {
3796 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3797 int cc = *lv.ll_name_end;
3798
3799 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3800 *lv.ll_name_end = NUL;
3801 if (si->sn_autoload_prefix != NULL)
3802 {
3803 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3804 }
3805 else
3806 {
3807 sid_buf[0] = K_SPECIAL;
3808 sid_buf[1] = KS_EXTRA;
3809 sid_buf[2] = (int)KE_SNR;
3810 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003811 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003812 name = concat_str(sid_buf, lv.ll_name);
3813 }
3814 *lv.ll_name_end = cc;
3815 *pp = end;
3816 goto theend;
3817 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003818 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 {
3820 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003821 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003822 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 if (name == *pp)
3824 name = NULL;
3825 }
3826 if (name != NULL)
3827 {
3828 name = vim_strsave(name);
3829 *pp = end;
3830 if (STRNCMP(name, "<SNR>", 5) == 0)
3831 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003832 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 name[0] = K_SPECIAL;
3834 name[1] = KS_EXTRA;
3835 name[2] = (int)KE_SNR;
3836 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3837 }
3838 goto theend;
3839 }
3840
3841 if (lv.ll_exp_name != NULL)
3842 {
3843 len = (int)STRLEN(lv.ll_exp_name);
3844 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3845 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3846 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003847 // When there was "s:" already or the name expanded to get a
3848 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 lv.ll_name += 2;
3850 len -= 2;
3851 lead = 2;
3852 }
3853 }
3854 else
3855 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003856 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003858 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003859 if (lv.ll_name[0] == 'g')
3860 {
3861 if (is_global != NULL)
3862 {
3863 *is_global = TRUE;
3864 }
3865 else
3866 {
3867 // dropping "g:" without setting "is_global" won't work in
3868 // Vim9script, put it back later
3869 prefix_g = TRUE;
3870 extra = 2;
3871 }
3872 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003874 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003875 len = (int)(end - lv.ll_name);
3876 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003877 if (len <= 0)
3878 {
3879 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003880 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003881 goto theend;
3882 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003883
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003884 // In Vim9 script a user function is script-local by default, unless it
3885 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003886 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003887 if (vim9script)
3888 {
3889 char_u *p;
3890
3891 // SomeScript#func() is a global function.
3892 for (p = start; *p != NUL && *p != '('; ++p)
3893 if (*p == AUTOLOAD_CHAR)
3894 vim9script = FALSE;
3895 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003896
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897 /*
3898 * Copy the function name to allocated memory.
3899 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3900 * Accept <SNR>123_name() outside a script.
3901 */
3902 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003903 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003904 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003906 if (!vim9script)
3907 lead = 3;
3908 if (vim9script || (lv.ll_exp_name != NULL
3909 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910 || eval_fname_sid(*pp))
3911 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003912 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003913 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003915 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916 goto theend;
3917 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003918 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003919 if (vim9script)
3920 extra = 3 + (int)STRLEN(sid_buf);
3921 else
3922 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003923 }
3924 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003925 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3926 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003928 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003929 goto theend;
3930 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003931 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003932 {
3933 char_u *cp = vim_strchr(lv.ll_name, ':');
3934
3935 if (cp != NULL && cp < end)
3936 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003937 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 goto theend;
3939 }
3940 }
3941
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003942 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 if (name != NULL)
3944 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003945 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 {
3947 name[0] = K_SPECIAL;
3948 name[1] = KS_EXTRA;
3949 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003950 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003951 STRCPY(name + 3, sid_buf);
3952 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003953 else if (prefix_g)
3954 {
3955 name[0] = 'g';
3956 name[1] = ':';
3957 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003958 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3959 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 }
3961 *pp = end;
3962
3963theend:
3964 clear_lval(&lv);
3965 return name;
3966}
3967
3968/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003969 * Assuming "name" is the result of trans_function_name() and it was prefixed
3970 * to use the script-local name, return the unmodified name (points into
3971 * "name"). Otherwise return NULL.
3972 * This can be used to first search for a script-local function and fall back
3973 * to the global function if not found.
3974 */
3975 char_u *
3976untrans_function_name(char_u *name)
3977{
3978 char_u *p;
3979
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003980 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003981 {
3982 p = vim_strchr(name, '_');
3983 if (p != NULL)
3984 return p + 1;
3985 }
3986 return NULL;
3987}
3988
3989/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003990 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3991 * current script ID and returns the expanded function name. The caller should
3992 * free the returned name. If not called from a script context or the function
3993 * name doesn't start with these prefixes, then returns NULL.
3994 * This doesn't check whether the script-local function exists or not.
3995 */
3996 char_u *
3997get_scriptlocal_funcname(char_u *funcname)
3998{
3999 char sid_buf[25];
4000 int off;
4001 char_u *newname;
4002
4003 if (funcname == NULL)
4004 return NULL;
4005
4006 if (STRNCMP(funcname, "s:", 2) != 0
4007 && STRNCMP(funcname, "<SID>", 5) != 0)
4008 // The function name is not a script-local function name
4009 return NULL;
4010
4011 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4012 {
4013 emsg(_(e_using_sid_not_in_script_context));
4014 return NULL;
4015 }
4016 // Expand s: prefix into <SNR>nr_<name>
4017 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4018 (long)current_sctx.sc_sid);
4019 off = *funcname == 's' ? 2 : 5;
4020 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
4021 if (newname == NULL)
4022 return NULL;
4023 STRCPY(newname, sid_buf);
4024 STRCAT(newname, funcname + off);
4025
4026 return newname;
4027}
4028
4029/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004030 * Call trans_function_name(), except that a lambda is returned as-is.
4031 * Returns the name in allocated memory.
4032 */
4033 char_u *
4034save_function_name(
4035 char_u **name,
4036 int *is_global,
4037 int skip,
4038 int flags,
4039 funcdict_T *fudi)
4040{
4041 char_u *p = *name;
4042 char_u *saved;
4043
4044 if (STRNCMP(p, "<lambda>", 8) == 0)
4045 {
4046 p += 8;
4047 (void)getdigits(&p);
4048 saved = vim_strnsave(*name, p - *name);
4049 if (fudi != NULL)
4050 CLEAR_POINTER(fudi);
4051 }
4052 else
4053 saved = trans_function_name(&p, is_global, skip,
4054 flags, fudi, NULL, NULL);
4055 *name = p;
4056 return saved;
4057}
4058
4059/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004060 * List functions. When "regmatch" is NULL all of then.
4061 * Otherwise functions matching "regmatch".
4062 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004063 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004064list_functions(regmatch_T *regmatch)
4065{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004066 int changed = func_hashtab.ht_changed;
4067 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004068 hashitem_T *hi;
4069
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004070 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004071 {
4072 if (!HASHITEM_EMPTY(hi))
4073 {
4074 ufunc_T *fp = HI2UF(hi);
4075
4076 --todo;
4077 if ((fp->uf_flags & FC_DEAD) == 0
4078 && (regmatch == NULL
4079 ? !message_filtered(fp->uf_name)
4080 && !func_name_refcount(fp->uf_name)
4081 : !isdigit(*fp->uf_name)
4082 && vim_regexec(regmatch, fp->uf_name, 0)))
4083 {
4084 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004085 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004086 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004087 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004088 return;
4089 }
4090 }
4091 }
4092 }
4093}
4094
4095/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004096 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004097 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4098 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004099 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004100 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004102 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004103define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004105 int j;
4106 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004107 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004108 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004109 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 char_u *p;
4111 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004112 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113 char_u *line_arg = NULL;
4114 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004115 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004116 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 garray_T newlines;
4118 int varargs = FALSE;
4119 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004120 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004121 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004122 int fp_allocated = FALSE;
4123 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004124 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004125 dictitem_T *v;
4126 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004127 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004130 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004131 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004132 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133
4134 /*
4135 * ":function" without argument: list functions.
4136 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004137 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138 {
4139 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004140 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004141 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004142 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004143 }
4144
4145 /*
4146 * ":function /pat": list functions matching pattern.
4147 */
4148 if (*eap->arg == '/')
4149 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004150 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151 if (!eap->skip)
4152 {
4153 regmatch_T regmatch;
4154
4155 c = *p;
4156 *p = NUL;
4157 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4158 *p = c;
4159 if (regmatch.regprog != NULL)
4160 {
4161 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004162 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163 vim_regfree(regmatch.regprog);
4164 }
4165 }
4166 if (*p == '/')
4167 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004168 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004169 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 }
4171
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004172 ga_init(&newargs);
4173 ga_init(&argtypes);
4174 ga_init(&default_args);
4175
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 /*
4177 * Get the function name. There are these situations:
4178 * func normal function name
4179 * "name" == func, "fudi.fd_dict" == NULL
4180 * dict.func new dictionary entry
4181 * "name" == NULL, "fudi.fd_dict" set,
4182 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4183 * dict.func existing dict entry with a Funcref
4184 * "name" == func, "fudi.fd_dict" set,
4185 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4186 * dict.func existing dict entry that's not a Funcref
4187 * "name" == NULL, "fudi.fd_dict" set,
4188 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4189 * s:func script-local function name
4190 * g:func global function name, same as "func"
4191 */
4192 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004193 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004195 // nested function, argument is (args).
4196 paren = TRUE;
4197 CLEAR_FIELD(fudi);
4198 }
4199 else
4200 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004201 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004202 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004203 paren = (vim_strchr(p, '(') != NULL);
4204 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004205 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004206 /*
4207 * Return on an invalid expression in braces, unless the expression
4208 * evaluation has been cancelled due to an aborting error, an
4209 * interrupt, or an exception.
4210 */
4211 if (!aborting())
4212 {
4213 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004214 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004215 vim_free(fudi.fd_newkey);
4216 return NULL;
4217 }
4218 else
4219 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004221
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004222 // For "export def FuncName()" in an autoload script the function name
4223 // is stored with the legacy autoload name "dir#script#FuncName" so
4224 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004225 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004226 {
4227 char_u *prefixed = may_prefix_autoload(name);
4228
4229 if (prefixed != NULL && prefixed != name)
4230 {
4231 vim_free(name);
4232 name = prefixed;
4233 }
4234 }
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004235 else if (vim9script && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4236 {
4237 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4238 goto ret_free;
4239 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240 }
4241
Bram Moolenaare38eab22019-12-05 21:50:01 +01004242 // An error in a function call during evaluation of an expression in magic
4243 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004244 saved_did_emsg = did_emsg;
4245 did_emsg = FALSE;
4246
4247 /*
4248 * ":function func" with only function name: list function.
4249 */
4250 if (!paren)
4251 {
4252 if (!ends_excmd(*skipwhite(p)))
4253 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004254 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004255 goto ret_free;
4256 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004257 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258 if (eap->nextcmd != NULL)
4259 *p = NUL;
4260 if (!eap->skip && !got_int)
4261 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004262 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004263 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4264 {
4265 char_u *up = untrans_function_name(name);
4266
4267 // With Vim9 script the name was made script-local, if not
4268 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004269 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004270 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004271 }
4272
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 if (fp != NULL)
4274 {
4275 list_func_head(fp, TRUE);
4276 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4277 {
4278 if (FUNCLINE(fp, j) == NULL)
4279 continue;
4280 msg_putchar('\n');
4281 msg_outnum((long)(j + 1));
4282 if (j < 9)
4283 msg_putchar(' ');
4284 if (j < 99)
4285 msg_putchar(' ');
4286 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004287 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288 ui_breakcheck();
4289 }
4290 if (!got_int)
4291 {
4292 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004293 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004294 msg_puts(" enddef");
4295 else
4296 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 }
4298 }
4299 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004300 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 }
4302 goto ret_free;
4303 }
4304
4305 /*
4306 * ":function name(arg1, arg2)" Define function.
4307 */
4308 p = skipwhite(p);
4309 if (*p != '(')
4310 {
4311 if (!eap->skip)
4312 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004313 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 goto ret_free;
4315 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004316 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 if (vim_strchr(p, '(') != NULL)
4318 p = vim_strchr(p, '(');
4319 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004321 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4322 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004323 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004324 goto ret_free;
4325 }
4326
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004327 // In Vim9 script only global functions can be redefined.
4328 if (vim9script && eap->forceit && !is_global)
4329 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004330 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004331 goto ret_free;
4332 }
4333
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004334 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335
Bram Moolenaar04b12692020-05-04 23:24:44 +02004336 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004338 // Check the name of the function. Unless it's a dictionary function
4339 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 if (name != NULL)
4341 arg = name;
4342 else
4343 arg = fudi.fd_newkey;
4344 if (arg != NULL && (fudi.fd_di == NULL
4345 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4346 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4347 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004348 char_u *name_base = arg;
4349 int i;
4350
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004352 {
4353 name_base = vim_strchr(arg, '_');
4354 if (name_base == NULL)
4355 name_base = arg + 3;
4356 else
4357 ++name_base;
4358 }
4359 for (i = 0; name_base[i] != NUL && (i == 0
4360 ? eval_isnamec1(name_base[i])
4361 : eval_isnamec(name_base[i])); ++i)
4362 ;
4363 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004364 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004365
4366 // In Vim9 script a function cannot have the same name as a
4367 // variable.
4368 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004369 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4370 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004371 + EVAL_VAR_NO_FUNC) == OK)
4372 {
4373 semsg(_(e_redefining_script_item_str), name_base);
4374 goto ret_free;
4375 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004377 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004379 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004380 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004381 goto ret_free;
4382 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383 }
4384
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004385 // This may get more lines and make the pointers into the first line
4386 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004387 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004388 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004389 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004390 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004391 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004393 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004395 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004397 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004398 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004400 if (*p != ':')
4401 {
4402 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4403 p = skipwhite(p);
4404 }
4405 else if (!IS_WHITE_OR_NUL(p[1]))
4406 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004407 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004408 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004409 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004410 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004411 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004412 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004413 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004414 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004415 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004416 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004417 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004418 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004419 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004421 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004422 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004423 else
4424 // find extra arguments "range", "dict", "abort" and "closure"
4425 for (;;)
4426 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004427 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004428 p = skipwhite(p);
4429 if (STRNCMP(p, "range", 5) == 0)
4430 {
4431 flags |= FC_RANGE;
4432 p += 5;
4433 }
4434 else if (STRNCMP(p, "dict", 4) == 0)
4435 {
4436 flags |= FC_DICT;
4437 p += 4;
4438 }
4439 else if (STRNCMP(p, "abort", 5) == 0)
4440 {
4441 flags |= FC_ABORT;
4442 p += 5;
4443 }
4444 else if (STRNCMP(p, "closure", 7) == 0)
4445 {
4446 flags |= FC_CLOSURE;
4447 p += 7;
4448 if (current_funccal == NULL)
4449 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004450 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004451 name == NULL ? (char_u *)"" : name);
4452 goto erret;
4453 }
4454 }
4455 else
4456 break;
4457 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458
Bram Moolenaare38eab22019-12-05 21:50:01 +01004459 // When there is a line break use what follows for the function body.
4460 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461 if (*p == '\n')
4462 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004463 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004464 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4465 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004466 && !(VIM_ISWHITE(*whitep) && *p == '#'
4467 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004468 && !eap->skip
4469 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004470 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471
4472 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004473 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4474 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004475 */
4476 if (KeyTyped)
4477 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004478 // Check if the function already exists, don't let the user type the
4479 // whole function before telling him it doesn't work! For a script we
4480 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 if (!eap->skip && !eap->forceit)
4482 {
4483 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004484 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004485 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004486 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 }
4488
4489 if (!eap->skip && did_emsg)
4490 goto erret;
4491
Bram Moolenaare38eab22019-12-05 21:50:01 +01004492 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493 cmdline_row = msg_row;
4494 }
4495
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004496 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004497 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004498
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004499 // Do not define the function when getting the body fails and when
4500 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004501 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004502 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004503 goto erret;
4504
4505 /*
4506 * If there are no errors, add the function
4507 */
4508 if (fudi.fd_dict == NULL)
4509 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004510 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004511 char_u *find_name = name;
4512 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004513 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004514
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004515 v = find_var(name, &ht, TRUE);
Bram Moolenaar6f0ddbf2022-01-20 19:56:49 +00004516 if (v != NULL && (in_vim9script() || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004517 var_conflict = TRUE;
4518
4519 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4520 {
4521 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4522
4523 if (si->sn_autoload_prefix != NULL)
4524 {
4525 if (is_export)
4526 {
4527 find_name = name + STRLEN(si->sn_autoload_prefix);
4528 v = find_var(find_name, &ht, TRUE);
4529 if (v != NULL)
4530 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004531 // Only check if the function already exists in the script,
4532 // global functions can be shadowed.
4533 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004534 }
4535 else
4536 {
4537 char_u *prefixed = may_prefix_autoload(name);
4538
4539 if (prefixed != NULL)
4540 {
4541 v = find_var(prefixed, &ht, TRUE);
4542 if (v != NULL)
4543 var_conflict = TRUE;
4544 vim_free(prefixed);
4545 }
4546 }
4547 }
4548 }
4549 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004551 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 goto erret;
4553 }
4554
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004555 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004556 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004558 char_u *uname = untrans_function_name(name);
4559
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004560 import = find_imported(uname == NULL ? name : uname, 0,
4561 FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004562 }
4563
4564 if (fp != NULL || import != NULL)
4565 {
4566 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004567
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004568 // Function can be replaced with "function!" and when sourcing the
4569 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004570 // A name that is used by an import can not be overruled.
4571 if (import != NULL
4572 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004573 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004574 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004576 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004577 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004578 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004579 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004580 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 goto erret;
4582 }
4583 if (fp->uf_calls > 0)
4584 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004585 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004586 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 goto erret;
4588 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004589 if (fp->uf_refcount > 1)
4590 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004591 // This function is referenced somewhere, don't redefine it but
4592 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004593 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004594 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004595 fp = NULL;
4596 overwrite = TRUE;
4597 }
4598 else
4599 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004600 char_u *exp_name = fp->uf_name_exp;
4601
4602 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004603 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004604 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004605 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004606 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004607 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004608#ifdef FEAT_PROFILE
4609 fp->uf_profiling = FALSE;
4610 fp->uf_prof_initialized = FALSE;
4611#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004612 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004613 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614 }
4615 }
4616 else
4617 {
4618 char numbuf[20];
4619
4620 fp = NULL;
4621 if (fudi.fd_newkey == NULL && !eap->forceit)
4622 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004623 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004624 goto erret;
4625 }
4626 if (fudi.fd_di == NULL)
4627 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004628 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004629 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630 goto erret;
4631 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004632 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004633 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634 goto erret;
4635
Bram Moolenaare38eab22019-12-05 21:50:01 +01004636 // Give the function a sequential number. Can only be used with a
4637 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004638 vim_free(name);
4639 sprintf(numbuf, "%d", ++func_nr);
4640 name = vim_strsave((char_u *)numbuf);
4641 if (name == NULL)
4642 goto erret;
4643 }
4644
4645 if (fp == NULL)
4646 {
4647 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4648 {
4649 int slen, plen;
4650 char_u *scriptname;
4651
Bram Moolenaare38eab22019-12-05 21:50:01 +01004652 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004653 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004654 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655 {
4656 scriptname = autoload_name(name);
4657 if (scriptname != NULL)
4658 {
4659 p = vim_strchr(scriptname, '/');
4660 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004661 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004663 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664 j = OK;
4665 vim_free(scriptname);
4666 }
4667 }
4668 if (j == FAIL)
4669 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004670 linenr_T save_lnum = SOURCING_LNUM;
4671
4672 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004673 semsg(_(e_function_name_does_not_match_script_file_name_str),
4674 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004675 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676 goto erret;
4677 }
4678 }
4679
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004680 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 if (fp == NULL)
4682 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004683 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684
4685 if (fudi.fd_dict != NULL)
4686 {
4687 if (fudi.fd_di == NULL)
4688 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004689 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4691 if (fudi.fd_di == NULL)
4692 {
4693 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004694 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004695 goto erret;
4696 }
4697 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4698 {
4699 vim_free(fudi.fd_di);
4700 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004701 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 goto erret;
4703 }
4704 }
4705 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004706 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 clear_tv(&fudi.fd_di->di_tv);
4708 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004710
Bram Moolenaare38eab22019-12-05 21:50:01 +01004711 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004712 flags |= FC_DICT;
4713 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004714 }
4715 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004716 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004717 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004718 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004719
4720 if (eap->cmdidx == CMD_def)
4721 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004722 int lnum_save = SOURCING_LNUM;
4723 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004724
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004725 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004726
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004727 // error messages are for the first function line
4728 SOURCING_LNUM = sourcing_lnum_top;
4729
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004730 // The function may use script variables from the context.
4731 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004732
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004733 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004734 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004735 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004736 free_fp = fp_allocated;
4737 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004738 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004739 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004740
4741 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004742 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004743 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004744 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004745 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004746 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004747 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004748 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004749 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004750 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004751 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004752
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004753 if (fp_allocated)
4754 {
4755 // insert the new function in the function list
4756 set_ufunc_name(fp, name);
4757 if (overwrite)
4758 {
4759 hi = hash_find(&func_hashtab, name);
4760 hi->hi_key = UF2HIKEY(fp);
4761 }
4762 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4763 {
4764 free_fp = TRUE;
4765 goto erret;
4766 }
4767 fp->uf_refcount = 1;
4768 }
4769
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004771 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004772 if ((flags & FC_CLOSURE) != 0)
4773 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004774 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004775 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004776 }
4777 else
4778 fp->uf_scoped = NULL;
4779
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004781 if (prof_def_func())
4782 func_do_profile(fp);
4783#endif
4784 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004785 if (sandbox)
4786 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004787 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004788 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789 fp->uf_flags = flags;
4790 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004791 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004792 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004793 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004794 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004795 if (is_export)
4796 {
4797 fp->uf_flags |= FC_EXPORT;
4798 // let ex_export() know the export worked.
4799 is_export = FALSE;
4800 }
4801
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004802 if (eap->cmdidx == CMD_def)
4803 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004804 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4805 // :func does not use Vim9 script syntax, even in a Vim9 script file
4806 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004807
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004808 goto ret_free;
4809
4810erret:
4811 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004812 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004813 if (fp != NULL)
4814 {
4815 ga_init(&fp->uf_args);
4816 ga_init(&fp->uf_def_args);
4817 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818errret_2:
4819 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004820 if (fp != NULL)
4821 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004822 if (free_fp)
4823 {
4824 vim_free(fp);
4825 fp = NULL;
4826 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004828 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004830 if (name != name_arg)
4831 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004832 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004834
4835 return fp;
4836}
4837
4838/*
4839 * ":function"
4840 */
4841 void
4842ex_function(exarg_T *eap)
4843{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004844 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004845
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004846 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4847 (void)define_function(eap, NULL, &lines_to_free);
4848 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004849}
4850
4851/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004852 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004853 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004854 */
4855 void
4856ex_defcompile(exarg_T *eap UNUSED)
4857{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004858 long todo = (long)func_hashtab.ht_used;
4859 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004860 hashitem_T *hi;
4861 ufunc_T *ufunc;
4862
4863 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4864 {
4865 if (!HASHITEM_EMPTY(hi))
4866 {
4867 --todo;
4868 ufunc = HI2UF(hi);
4869 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004870 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4871 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004872 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004873 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004874
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004875 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004876 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004877 // a function has been added or removed, need to start over
4878 todo = (long)func_hashtab.ht_used;
4879 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004880 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004881 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004882 }
4883 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004884 }
4885 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004886}
4887
4888/*
4889 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4890 * Return 2 if "p" starts with "s:".
4891 * Return 0 otherwise.
4892 */
4893 int
4894eval_fname_script(char_u *p)
4895{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004896 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4897 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4899 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4900 return 5;
4901 if (p[0] == 's' && p[1] == ':')
4902 return 2;
4903 return 0;
4904}
4905
4906 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004907translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908{
4909 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004910 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004911 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004912}
4913
4914/*
4915 * Return TRUE when "ufunc" has old-style "..." varargs
4916 * or named varargs "...name: type".
4917 */
4918 int
4919has_varargs(ufunc_T *ufunc)
4920{
4921 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004922}
4923
4924/*
4925 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004926 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927 */
4928 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004929function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930{
4931 char_u *nm = name;
4932 char_u *p;
4933 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004934 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004935 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004937 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4938 if (no_deref)
4939 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004940 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004941 nm = skipwhite(nm);
4942
Bram Moolenaare38eab22019-12-05 21:50:01 +01004943 // Only accept "funcname", "funcname ", "funcname (..." and
4944 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004946 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004947 vim_free(p);
4948 return n;
4949}
4950
Bram Moolenaar113e1072019-01-20 15:30:40 +01004951#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004952 char_u *
4953get_expanded_name(char_u *name, int check)
4954{
4955 char_u *nm = name;
4956 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004957 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004958
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004959 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004960 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004961
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004962 if (p != NULL && *nm == NUL
4963 && (!check || translated_function_exists(p, is_global)))
4964 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965
4966 vim_free(p);
4967 return NULL;
4968}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004969#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004970
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971/*
4972 * Function given to ExpandGeneric() to obtain the list of user defined
4973 * function names.
4974 */
4975 char_u *
4976get_user_func_name(expand_T *xp, int idx)
4977{
4978 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004979 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980 static hashitem_T *hi;
4981 ufunc_T *fp;
4982
4983 if (idx == 0)
4984 {
4985 done = 0;
4986 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004987 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004989 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004990 {
4991 if (done++ > 0)
4992 ++hi;
4993 while (HASHITEM_EMPTY(hi))
4994 ++hi;
4995 fp = HI2UF(hi);
4996
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004997 // don't show dead, dict and lambda functions
4998 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004999 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005000 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005001
5002 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005003 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004
5005 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005006 if (xp->xp_context != EXPAND_USER_FUNC
5007 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005008 {
5009 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005010 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011 STRCAT(IObuff, ")");
5012 }
5013 return IObuff;
5014 }
5015 return NULL;
5016}
5017
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005018/*
5019 * ":delfunction {name}"
5020 */
5021 void
5022ex_delfunction(exarg_T *eap)
5023{
5024 ufunc_T *fp = NULL;
5025 char_u *p;
5026 char_u *name;
5027 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005028 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005029
5030 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005031 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5032 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005033 vim_free(fudi.fd_newkey);
5034 if (name == NULL)
5035 {
5036 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005037 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005038 return;
5039 }
5040 if (!ends_excmd(*skipwhite(p)))
5041 {
5042 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005043 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005044 return;
5045 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005046 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047 if (eap->nextcmd != NULL)
5048 *p = NUL;
5049
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005050 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005051 {
5052 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005053 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005054 vim_free(name);
5055 return;
5056 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005057 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005058 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005059 vim_free(name);
5060
5061 if (!eap->skip)
5062 {
5063 if (fp == NULL)
5064 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005065 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005066 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067 return;
5068 }
5069 if (fp->uf_calls > 0)
5070 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005071 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005072 return;
5073 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005074 if (fp->uf_flags & FC_VIM9)
5075 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005076 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005077 return;
5078 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005079
5080 if (fudi.fd_dict != NULL)
5081 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005082 // Delete the dict item that refers to the function, it will
5083 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005084 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5085 }
5086 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005087 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005088 // A normal function (not a numbered function or lambda) has a
5089 // refcount of 1 for the entry in the hashtable. When deleting
5090 // it and the refcount is more than one, it should be kept.
5091 // A numbered function and lambda should be kept if the refcount is
5092 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005093 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005094 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005095 // Function is still referenced somewhere. Don't free it but
5096 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005097 if (func_remove(fp))
5098 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005099 }
5100 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005101 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005102 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005103 }
5104}
5105
5106/*
5107 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005108 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109 */
5110 void
5111func_unref(char_u *name)
5112{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005113 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005114
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005115 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005116 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005117 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005118 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005119 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005120#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005121 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005123 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005125 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005126}
5127
5128/*
5129 * Unreference a Function: decrement the reference count and free it when it
5130 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005131 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005132 */
5133 void
5134func_ptr_unref(ufunc_T *fp)
5135{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005136 if (fp != NULL && (--fp->uf_refcount <= 0
5137 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5138 && fp->uf_partial->pt_refcount <= 1
5139 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005140 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005141 // Only delete it when it's not being used. Otherwise it's done
5142 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005143 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005144 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145 }
5146}
5147
5148/*
5149 * Count a reference to a Function.
5150 */
5151 void
5152func_ref(char_u *name)
5153{
5154 ufunc_T *fp;
5155
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005156 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005157 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005158 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005159 if (fp != NULL)
5160 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005161 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005162 // Only give an error for a numbered function.
5163 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005164 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005165}
5166
5167/*
5168 * Count a reference to a Function.
5169 */
5170 void
5171func_ptr_ref(ufunc_T *fp)
5172{
5173 if (fp != NULL)
5174 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175}
5176
5177/*
5178 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5179 * referenced from anywhere that is in use.
5180 */
5181 static int
5182can_free_funccal(funccall_T *fc, int copyID)
5183{
5184 return (fc->l_varlist.lv_copyID != copyID
5185 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005186 && fc->l_avars.dv_copyID != copyID
5187 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005188}
5189
5190/*
5191 * ":return [expr]"
5192 */
5193 void
5194ex_return(exarg_T *eap)
5195{
5196 char_u *arg = eap->arg;
5197 typval_T rettv;
5198 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005199 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200
5201 if (current_funccal == NULL)
5202 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005203 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005204 return;
5205 }
5206
Bram Moolenaar844fb642021-10-23 13:32:30 +01005207 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005208 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5209
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005210 if (eap->skip)
5211 ++emsg_skip;
5212
5213 eap->nextcmd = NULL;
5214 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005215 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 {
5217 if (!eap->skip)
5218 returning = do_return(eap, FALSE, TRUE, &rettv);
5219 else
5220 clear_tv(&rettv);
5221 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005222 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223 else if (!eap->skip)
5224 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005225 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005226 update_force_abort();
5227
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005228 /*
5229 * Return unless the expression evaluation has been cancelled due to an
5230 * aborting error, an interrupt, or an exception.
5231 */
5232 if (!aborting())
5233 returning = do_return(eap, FALSE, TRUE, NULL);
5234 }
5235
Bram Moolenaare38eab22019-12-05 21:50:01 +01005236 // When skipping or the return gets pending, advance to the next command
5237 // in this line (!returning). Otherwise, ignore the rest of the line.
5238 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005239 if (returning)
5240 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005241 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005242 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005243
5244 if (eap->skip)
5245 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005246 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247}
5248
5249/*
5250 * ":1,25call func(arg1, arg2)" function call.
5251 */
5252 void
5253ex_call(exarg_T *eap)
5254{
5255 char_u *arg = eap->arg;
5256 char_u *startarg;
5257 char_u *name;
5258 char_u *tofree;
5259 int len;
5260 typval_T rettv;
5261 linenr_T lnum;
5262 int doesrange;
5263 int failed = FALSE;
5264 funcdict_T fudi;
5265 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005266 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005267 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005268 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005269
Bram Moolenaare6b53242020-07-01 17:28:33 +02005270 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005271 if (eap->skip)
5272 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005273 // trans_function_name() doesn't work well when skipping, use eval0()
5274 // instead to skip to any following command, e.g. for:
5275 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005276 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005277 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005278 clear_tv(&rettv);
5279 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005280 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005281 return;
5282 }
5283
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005284 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5285 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005286 if (fudi.fd_newkey != NULL)
5287 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005288 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005289 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005290 vim_free(fudi.fd_newkey);
5291 }
5292 if (tofree == NULL)
5293 return;
5294
Bram Moolenaare38eab22019-12-05 21:50:01 +01005295 // Increase refcount on dictionary, it could get deleted when evaluating
5296 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 if (fudi.fd_dict != NULL)
5298 ++fudi.fd_dict->dv_refcount;
5299
Bram Moolenaare38eab22019-12-05 21:50:01 +01005300 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5301 // contents. For VAR_PARTIAL get its partial, unless we already have one
5302 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005303 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005304 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005305 in_vim9script() && type == NULL ? &type : NULL,
5306 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005307
Bram Moolenaare38eab22019-12-05 21:50:01 +01005308 // Skip white space to allow ":call func ()". Not good, but required for
5309 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005310 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005311 if (*startarg != '(')
5312 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005313 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 goto end;
5315 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005316 if (in_vim9script() && startarg > arg)
5317 {
5318 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5319 goto end;
5320 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005321
5322 /*
5323 * When skipping, evaluate the function once, to find the end of the
5324 * arguments.
5325 * When the function takes a range, this is discovered after the first
5326 * call, and the loop is broken.
5327 */
5328 if (eap->skip)
5329 {
5330 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005331 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005332 }
5333 else
5334 lnum = eap->line1;
5335 for ( ; lnum <= eap->line2; ++lnum)
5336 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005337 funcexe_T funcexe;
5338
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339 if (!eap->skip && eap->addr_count > 0)
5340 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005341 if (lnum > curbuf->b_ml.ml_line_count)
5342 {
5343 // If the function deleted lines or switched to another buffer
5344 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005345 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005346 break;
5347 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 curwin->w_cursor.lnum = lnum;
5349 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005350 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351 }
5352 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005353
Bram Moolenaara80faa82020-04-12 19:37:17 +02005354 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005355 funcexe.fe_firstline = eap->line1;
5356 funcexe.fe_lastline = eap->line2;
5357 funcexe.fe_doesrange = &doesrange;
5358 funcexe.fe_evaluate = !eap->skip;
5359 funcexe.fe_partial = partial;
5360 funcexe.fe_selfdict = fudi.fd_dict;
5361 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005362 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005363 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005364 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005365 {
5366 failed = TRUE;
5367 break;
5368 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005369 if (has_watchexpr())
5370 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005371
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005372 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005373 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005374 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005375 {
5376 failed = TRUE;
5377 break;
5378 }
5379
5380 clear_tv(&rettv);
5381 if (doesrange || eap->skip)
5382 break;
5383
Bram Moolenaare38eab22019-12-05 21:50:01 +01005384 // Stop when immediately aborting on error, or when an interrupt
5385 // occurred or an exception was thrown but not caught.
5386 // get_func_tv() returned OK, so that the check for trailing
5387 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005388 if (aborting())
5389 break;
5390 }
5391 if (eap->skip)
5392 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005393 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005394
Bram Moolenaar1d341892021-09-18 15:25:52 +02005395 // When inside :try we need to check for following "| catch" or "| endtry".
5396 // Not when there was an error, but do check if an exception was thrown.
5397 if ((!aborting() || did_throw)
5398 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005400 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005401 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005402 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005403 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005404 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005405 {
5406 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005407 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005408 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005409 }
5410 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005411 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005412 }
5413
5414end:
5415 dict_unref(fudi.fd_dict);
5416 vim_free(tofree);
5417}
5418
5419/*
5420 * Return from a function. Possibly makes the return pending. Also called
5421 * for a pending return at the ":endtry" or after returning from an extra
5422 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5423 * when called due to a ":return" command. "rettv" may point to a typval_T
5424 * with the return rettv. Returns TRUE when the return can be carried out,
5425 * FALSE when the return gets pending.
5426 */
5427 int
5428do_return(
5429 exarg_T *eap,
5430 int reanimate,
5431 int is_cmd,
5432 void *rettv)
5433{
5434 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005435 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005436
5437 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005438 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005439 current_funccal->returned = FALSE;
5440
5441 /*
5442 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5443 * not in its finally clause (which then is to be executed next) is found.
5444 * In this case, make the ":return" pending for execution at the ":endtry".
5445 * Otherwise, return normally.
5446 */
5447 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5448 if (idx >= 0)
5449 {
5450 cstack->cs_pending[idx] = CSTP_RETURN;
5451
5452 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005453 // A pending return again gets pending. "rettv" points to an
5454 // allocated variable with the rettv of the original ":return"'s
5455 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005456 cstack->cs_rettv[idx] = rettv;
5457 else
5458 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005459 // When undoing a return in order to make it pending, get the stored
5460 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461 if (reanimate)
5462 rettv = current_funccal->rettv;
5463
5464 if (rettv != NULL)
5465 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005466 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005467 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5468 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5469 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005470 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005471 }
5472 else
5473 cstack->cs_rettv[idx] = NULL;
5474
5475 if (reanimate)
5476 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005477 // The pending return value could be overwritten by a ":return"
5478 // without argument in a finally clause; reset the default
5479 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005480 current_funccal->rettv->v_type = VAR_NUMBER;
5481 current_funccal->rettv->vval.v_number = 0;
5482 }
5483 }
5484 report_make_pending(CSTP_RETURN, rettv);
5485 }
5486 else
5487 {
5488 current_funccal->returned = TRUE;
5489
Bram Moolenaare38eab22019-12-05 21:50:01 +01005490 // If the return is carried out now, store the return value. For
5491 // a return immediately after reanimation, the value is already
5492 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005493 if (!reanimate && rettv != NULL)
5494 {
5495 clear_tv(current_funccal->rettv);
5496 *current_funccal->rettv = *(typval_T *)rettv;
5497 if (!is_cmd)
5498 vim_free(rettv);
5499 }
5500 }
5501
5502 return idx < 0;
5503}
5504
5505/*
5506 * Free the variable with a pending return value.
5507 */
5508 void
5509discard_pending_return(void *rettv)
5510{
5511 free_tv((typval_T *)rettv);
5512}
5513
5514/*
5515 * Generate a return command for producing the value of "rettv". The result
5516 * is an allocated string. Used by report_pending() for verbose messages.
5517 */
5518 char_u *
5519get_return_cmd(void *rettv)
5520{
5521 char_u *s = NULL;
5522 char_u *tofree = NULL;
5523 char_u numbuf[NUMBUFLEN];
5524
5525 if (rettv != NULL)
5526 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5527 if (s == NULL)
5528 s = (char_u *)"";
5529
5530 STRCPY(IObuff, ":return ");
5531 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5532 if (STRLEN(s) + 8 >= IOSIZE)
5533 STRCPY(IObuff + IOSIZE - 4, "...");
5534 vim_free(tofree);
5535 return vim_strsave(IObuff);
5536}
5537
5538/*
5539 * Get next function line.
5540 * Called by do_cmdline() to get the next line.
5541 * Returns allocated string, or NULL for end of function.
5542 */
5543 char_u *
5544get_func_line(
5545 int c UNUSED,
5546 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005547 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005548 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005549{
5550 funccall_T *fcp = (funccall_T *)cookie;
5551 ufunc_T *fp = fcp->func;
5552 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005553 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005554
Bram Moolenaare38eab22019-12-05 21:50:01 +01005555 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005556 if (fcp->dbg_tick != debug_tick)
5557 {
5558 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005559 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005560 fcp->dbg_tick = debug_tick;
5561 }
5562#ifdef FEAT_PROFILE
5563 if (do_profiling == PROF_YES)
5564 func_line_end(cookie);
5565#endif
5566
5567 gap = &fp->uf_lines;
5568 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5569 || fcp->returned)
5570 retval = NULL;
5571 else
5572 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005573 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005574 while (fcp->linenr < gap->ga_len
5575 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5576 ++fcp->linenr;
5577 if (fcp->linenr >= gap->ga_len)
5578 retval = NULL;
5579 else
5580 {
5581 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005582 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005583#ifdef FEAT_PROFILE
5584 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005585 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005586#endif
5587 }
5588 }
5589
Bram Moolenaare38eab22019-12-05 21:50:01 +01005590 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005591 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005592 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005593 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005594 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005595 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005596 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005597 fcp->dbg_tick = debug_tick;
5598 }
5599
5600 return retval;
5601}
5602
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005603/*
5604 * Return TRUE if the currently active function should be ended, because a
5605 * return was encountered or an error occurred. Used inside a ":while".
5606 */
5607 int
5608func_has_ended(void *cookie)
5609{
5610 funccall_T *fcp = (funccall_T *)cookie;
5611
Bram Moolenaare38eab22019-12-05 21:50:01 +01005612 // Ignore the "abort" flag if the abortion behavior has been changed due to
5613 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005614 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5615 || fcp->returned);
5616}
5617
5618/*
5619 * return TRUE if cookie indicates a function which "abort"s on errors.
5620 */
5621 int
5622func_has_abort(
5623 void *cookie)
5624{
5625 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5626}
5627
5628
5629/*
5630 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5631 * Don't do this when "Func" is already a partial that was bound
5632 * explicitly (pt_auto is FALSE).
5633 * Changes "rettv" in-place.
5634 * Returns the updated "selfdict_in".
5635 */
5636 dict_T *
5637make_partial(dict_T *selfdict_in, typval_T *rettv)
5638{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005639 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005640 char_u *tofree = NULL;
5641 ufunc_T *fp;
5642 char_u fname_buf[FLEN_FIXED + 1];
5643 int error;
5644 dict_T *selfdict = selfdict_in;
5645
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005646 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5647 fp = rettv->vval.v_partial->pt_func;
5648 else
5649 {
5650 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5651 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005652 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005653 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005654 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005655 vim_free(tofree);
5656 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005657
5658 if (fp != NULL && (fp->uf_flags & FC_DICT))
5659 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005660 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005661
5662 if (pt != NULL)
5663 {
5664 pt->pt_refcount = 1;
5665 pt->pt_dict = selfdict;
5666 pt->pt_auto = TRUE;
5667 selfdict = NULL;
5668 if (rettv->v_type == VAR_FUNC)
5669 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005670 // Just a function: Take over the function name and use
5671 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005672 pt->pt_name = rettv->vval.v_string;
5673 }
5674 else
5675 {
5676 partial_T *ret_pt = rettv->vval.v_partial;
5677 int i;
5678
Bram Moolenaare38eab22019-12-05 21:50:01 +01005679 // Partial: copy the function name, use selfdict and copy
5680 // args. Can't take over name or args, the partial might
5681 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005682 if (ret_pt->pt_name != NULL)
5683 {
5684 pt->pt_name = vim_strsave(ret_pt->pt_name);
5685 func_ref(pt->pt_name);
5686 }
5687 else
5688 {
5689 pt->pt_func = ret_pt->pt_func;
5690 func_ptr_ref(pt->pt_func);
5691 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005692 if (ret_pt->pt_argc > 0)
5693 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005694 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005695 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005696 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005697 pt->pt_argc = 0;
5698 else
5699 {
5700 pt->pt_argc = ret_pt->pt_argc;
5701 for (i = 0; i < pt->pt_argc; i++)
5702 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5703 }
5704 }
5705 partial_unref(ret_pt);
5706 }
5707 rettv->v_type = VAR_PARTIAL;
5708 rettv->vval.v_partial = pt;
5709 }
5710 }
5711 return selfdict;
5712}
5713
5714/*
5715 * Return the name of the executed function.
5716 */
5717 char_u *
5718func_name(void *cookie)
5719{
5720 return ((funccall_T *)cookie)->func->uf_name;
5721}
5722
5723/*
5724 * Return the address holding the next breakpoint line for a funccall cookie.
5725 */
5726 linenr_T *
5727func_breakpoint(void *cookie)
5728{
5729 return &((funccall_T *)cookie)->breakpoint;
5730}
5731
5732/*
5733 * Return the address holding the debug tick for a funccall cookie.
5734 */
5735 int *
5736func_dbg_tick(void *cookie)
5737{
5738 return &((funccall_T *)cookie)->dbg_tick;
5739}
5740
5741/*
5742 * Return the nesting level for a funccall cookie.
5743 */
5744 int
5745func_level(void *cookie)
5746{
5747 return ((funccall_T *)cookie)->level;
5748}
5749
5750/*
5751 * Return TRUE when a function was ended by a ":return" command.
5752 */
5753 int
5754current_func_returned(void)
5755{
5756 return current_funccal->returned;
5757}
5758
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005759 int
5760free_unref_funccal(int copyID, int testing)
5761{
5762 int did_free = FALSE;
5763 int did_free_funccal = FALSE;
5764 funccall_T *fc, **pfc;
5765
5766 for (pfc = &previous_funccal; *pfc != NULL; )
5767 {
5768 if (can_free_funccal(*pfc, copyID))
5769 {
5770 fc = *pfc;
5771 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005772 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005773 did_free = TRUE;
5774 did_free_funccal = TRUE;
5775 }
5776 else
5777 pfc = &(*pfc)->caller;
5778 }
5779 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005780 // When a funccal was freed some more items might be garbage
5781 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005782 (void)garbage_collect(testing);
5783
5784 return did_free;
5785}
5786
5787/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005788 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005789 */
5790 static funccall_T *
5791get_funccal(void)
5792{
5793 int i;
5794 funccall_T *funccal;
5795 funccall_T *temp_funccal;
5796
5797 funccal = current_funccal;
5798 if (debug_backtrace_level > 0)
5799 {
5800 for (i = 0; i < debug_backtrace_level; i++)
5801 {
5802 temp_funccal = funccal->caller;
5803 if (temp_funccal)
5804 funccal = temp_funccal;
5805 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005806 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005807 debug_backtrace_level = i;
5808 }
5809 }
5810 return funccal;
5811}
5812
5813/*
5814 * Return the hashtable used for local variables in the current funccal.
5815 * Return NULL if there is no current funccal.
5816 */
5817 hashtab_T *
5818get_funccal_local_ht()
5819{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005820 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005821 return NULL;
5822 return &get_funccal()->l_vars.dv_hashtab;
5823}
5824
5825/*
5826 * Return the l: scope variable.
5827 * Return NULL if there is no current funccal.
5828 */
5829 dictitem_T *
5830get_funccal_local_var()
5831{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005832 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005833 return NULL;
5834 return &get_funccal()->l_vars_var;
5835}
5836
5837/*
5838 * Return the hashtable used for argument in the current funccal.
5839 * Return NULL if there is no current funccal.
5840 */
5841 hashtab_T *
5842get_funccal_args_ht()
5843{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005844 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005845 return NULL;
5846 return &get_funccal()->l_avars.dv_hashtab;
5847}
5848
5849/*
5850 * Return the a: scope variable.
5851 * Return NULL if there is no current funccal.
5852 */
5853 dictitem_T *
5854get_funccal_args_var()
5855{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005856 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005857 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005858 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005859}
5860
5861/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005862 * List function variables, if there is a function.
5863 */
5864 void
5865list_func_vars(int *first)
5866{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005867 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005868 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005869 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005870}
5871
5872/*
5873 * If "ht" is the hashtable for local variables in the current funccal, return
5874 * the dict that contains it.
5875 * Otherwise return NULL.
5876 */
5877 dict_T *
5878get_current_funccal_dict(hashtab_T *ht)
5879{
5880 if (current_funccal != NULL
5881 && ht == &current_funccal->l_vars.dv_hashtab)
5882 return &current_funccal->l_vars;
5883 return NULL;
5884}
5885
5886/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005887 * Search hashitem in parent scope.
5888 */
5889 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005890find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005891{
5892 funccall_T *old_current_funccal = current_funccal;
5893 hashtab_T *ht;
5894 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005895 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005896
5897 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5898 return NULL;
5899
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005900 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005901 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005902 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005903 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005904 ht = find_var_ht(name, &varname);
5905 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005906 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005907 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005908 if (!HASHITEM_EMPTY(hi))
5909 {
5910 *pht = ht;
5911 break;
5912 }
5913 }
5914 if (current_funccal == current_funccal->func->uf_scoped)
5915 break;
5916 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005917 }
5918 current_funccal = old_current_funccal;
5919
5920 return hi;
5921}
5922
5923/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005924 * Search variable in parent scope.
5925 */
5926 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005927find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005928{
5929 dictitem_T *v = NULL;
5930 funccall_T *old_current_funccal = current_funccal;
5931 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005932 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005933
5934 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5935 return NULL;
5936
Bram Moolenaare38eab22019-12-05 21:50:01 +01005937 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005938 current_funccal = current_funccal->func->uf_scoped;
5939 while (current_funccal)
5940 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005941 ht = find_var_ht(name, &varname);
5942 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005943 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005944 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005945 if (v != NULL)
5946 break;
5947 }
5948 if (current_funccal == current_funccal->func->uf_scoped)
5949 break;
5950 current_funccal = current_funccal->func->uf_scoped;
5951 }
5952 current_funccal = old_current_funccal;
5953
5954 return v;
5955}
5956
5957/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005958 * Set "copyID + 1" in previous_funccal and callers.
5959 */
5960 int
5961set_ref_in_previous_funccal(int copyID)
5962{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005963 funccall_T *fc;
5964
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005965 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005966 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005967 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005968 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5969 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5970 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5971 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005972 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005973 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005974}
5975
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005976 static int
5977set_ref_in_funccal(funccall_T *fc, int copyID)
5978{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005979 if (fc->fc_copyID != copyID)
5980 {
5981 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005982 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5983 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5984 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5985 || set_ref_in_func(NULL, fc->func, copyID))
5986 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005987 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005988 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005989}
5990
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005991/*
5992 * Set "copyID" in all local vars and arguments in the call stack.
5993 */
5994 int
5995set_ref_in_call_stack(int copyID)
5996{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005997 funccall_T *fc;
5998 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005999
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006000 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6001 if (set_ref_in_funccal(fc, copyID))
6002 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006003
6004 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006005 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6006 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6007 if (set_ref_in_funccal(fc, copyID))
6008 return TRUE;
6009 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006010}
6011
6012/*
6013 * Set "copyID" in all functions available by name.
6014 */
6015 int
6016set_ref_in_functions(int copyID)
6017{
6018 int todo;
6019 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006020 ufunc_T *fp;
6021
6022 todo = (int)func_hashtab.ht_used;
6023 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006024 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006025 if (!HASHITEM_EMPTY(hi))
6026 {
6027 --todo;
6028 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006029 if (!func_name_refcount(fp->uf_name)
6030 && set_ref_in_func(NULL, fp, copyID))
6031 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006032 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006033 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006034 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006035}
6036
6037/*
6038 * Set "copyID" in all function arguments.
6039 */
6040 int
6041set_ref_in_func_args(int copyID)
6042{
6043 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006044
6045 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006046 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6047 copyID, NULL, NULL))
6048 return TRUE;
6049 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006050}
6051
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006052/*
6053 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006054 * Returns TRUE if setting references failed somehow.
6055 */
6056 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006057set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006058{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006059 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006060 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006061 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006062 char_u fname_buf[FLEN_FIXED + 1];
6063 char_u *tofree = NULL;
6064 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006065 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006066
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006067 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006068 return FALSE;
6069
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006070 if (fp_in == NULL)
6071 {
6072 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006073 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006074 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006075 if (fp != NULL)
6076 {
6077 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006078 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006079 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006080
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006081 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006082 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006083}
6084
Bram Moolenaare38eab22019-12-05 21:50:01 +01006085#endif // FEAT_EVAL