blob: 014ec5524387497e0a71d7aca6306dc7660afaf2 [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
1905 if (vim_strchr(name, AUTOLOAD_CHAR) != 0)
1906 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 Moolenaar4c17ad92020-04-27 22:47:51 +02001944 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001945 * Return NULL for unknown function.
1946 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001947 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001948find_func_even_dead(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001949{
1950 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001951 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001952
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001953 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001955 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1956 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957
Bram Moolenaar95006e32020-08-29 17:47:08 +02001958 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001959 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001960 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001961 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1962 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001963 if (func != NULL)
1964 return func;
1965 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001966 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001967
Bram Moolenaara26b9702020-04-18 19:53:28 +02001968 hi = hash_find(&func_hashtab,
1969 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001970 if (!HASHITEM_EMPTY(hi))
1971 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001972
Bram Moolenaarb8822442022-01-11 15:24:05 +00001973 // Find autoload function if this is an autoload script.
1974 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1975 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001976}
1977
1978/*
1979 * Find a function by name, return pointer to it in ufuncs.
1980 * "cctx" is passed in a :def function to find imported functions.
1981 * Return NULL for unknown or dead function.
1982 */
1983 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001984find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001985{
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001986 ufunc_T *fp = find_func_even_dead(name, is_global);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001987
1988 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1989 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001990 return NULL;
1991}
1992
1993/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001994 * Return TRUE if "ufunc" is a global function.
1995 */
1996 int
1997func_is_global(ufunc_T *ufunc)
1998{
1999 return ufunc->uf_name[0] != K_SPECIAL;
2000}
2001
2002/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002003 * Copy the function name of "fp" to buffer "buf".
2004 * "buf" must be able to hold the function name plus three bytes.
2005 * Takes care of script-local function names.
2006 */
2007 static void
2008cat_func_name(char_u *buf, ufunc_T *fp)
2009{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002010 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002011 {
2012 STRCPY(buf, "<SNR>");
2013 STRCAT(buf, fp->uf_name + 3);
2014 }
2015 else
2016 STRCPY(buf, fp->uf_name);
2017}
2018
2019/*
2020 * Add a number variable "name" to dict "dp" with value "nr".
2021 */
2022 static void
2023add_nr_var(
2024 dict_T *dp,
2025 dictitem_T *v,
2026 char *name,
2027 varnumber_T nr)
2028{
2029 STRCPY(v->di_key, name);
2030 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2031 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2032 v->di_tv.v_type = VAR_NUMBER;
2033 v->di_tv.v_lock = VAR_FIXED;
2034 v->di_tv.vval.v_number = nr;
2035}
2036
2037/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002038 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002040 static void
2041free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002042{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002043 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002044
2045 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2046 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002047 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002048
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002049 // When garbage collecting a funccall_T may be freed before the
2050 // function that references it, clear its uf_scoped field.
2051 // The function may have been redefined and point to another
2052 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002053 if (fp != NULL && fp->uf_scoped == fc)
2054 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002055 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002056 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002057
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002058 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002059 vim_free(fc);
2060}
2061
2062/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002063 * Free "fc" and what it contains.
2064 * Can be called only when "fc" is kept beyond the period of it called,
2065 * i.e. after cleanup_function_call(fc).
2066 */
2067 static void
2068free_funccal_contents(funccall_T *fc)
2069{
2070 listitem_T *li;
2071
2072 // Free all l: variables.
2073 vars_clear(&fc->l_vars.dv_hashtab);
2074
2075 // Free all a: variables.
2076 vars_clear(&fc->l_avars.dv_hashtab);
2077
2078 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002079 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002080 clear_tv(&li->li_tv);
2081
2082 free_funccal(fc);
2083}
2084
2085/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002086 * Handle the last part of returning from a function: free the local hashtable.
2087 * Unless it is still in use by a closure.
2088 */
2089 static void
2090cleanup_function_call(funccall_T *fc)
2091{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002092 int may_free_fc = fc->fc_refcount <= 0;
2093 int free_fc = TRUE;
2094
Bram Moolenaar6914c642017-04-01 21:21:30 +02002095 current_funccal = fc->caller;
2096
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002097 // Free all l: variables if not referred.
2098 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2099 vars_clear(&fc->l_vars.dv_hashtab);
2100 else
2101 free_fc = FALSE;
2102
2103 // If the a:000 list and the l: and a: dicts are not referenced and
2104 // there is no closure using it, we can free the funccall_T and what's
2105 // in it.
2106 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2107 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002108 else
2109 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002110 int todo;
2111 hashitem_T *hi;
2112 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002113
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002114 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002115
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002116 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002117 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2118 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2119 {
2120 if (!HASHITEM_EMPTY(hi))
2121 {
2122 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002123 di = HI2DI(hi);
2124 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002125 }
2126 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002127 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002128
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002129 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2130 fc->l_varlist.lv_first = NULL;
2131 else
2132 {
2133 listitem_T *li;
2134
2135 free_fc = FALSE;
2136
2137 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002138 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002139 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002140 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002141
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 if (free_fc)
2143 free_funccal(fc);
2144 else
2145 {
2146 static int made_copy = 0;
2147
2148 // "fc" is still in use. This can happen when returning "a:000",
2149 // assigning "l:" to a global variable or defining a closure.
2150 // Link "fc" in the list for garbage collection later.
2151 fc->caller = previous_funccal;
2152 previous_funccal = fc;
2153
2154 if (want_garbage_collect)
2155 // If garbage collector is ready, clear count.
2156 made_copy = 0;
2157 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002158 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002159 // We have made a lot of copies, worth 4 Mbyte. This can happen
2160 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002161 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002162 // too much memory.
2163 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002164 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002165 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002166 }
2167}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002168
2169/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002170 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2171 */
2172 static int
2173numbered_function(char_u *name)
2174{
2175 return isdigit(*name)
2176 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2177}
2178
2179/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002180 * There are two kinds of function names:
2181 * 1. ordinary names, function defined with :function or :def
2182 * 2. numbered functions and lambdas
2183 * For the first we only count the name stored in func_hashtab as a reference,
2184 * using function() does not count as a reference, because the function is
2185 * looked up by name.
2186 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002187 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002188func_name_refcount(char_u *name)
2189{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002190 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002191}
2192
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002193/*
2194 * Unreference "fc": decrement the reference count and free it when it
2195 * becomes zero. "fp" is detached from "fc".
2196 * When "force" is TRUE we are exiting.
2197 */
2198 static void
2199funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2200{
2201 funccall_T **pfc;
2202 int i;
2203
2204 if (fc == NULL)
2205 return;
2206
2207 if (--fc->fc_refcount <= 0 && (force || (
2208 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2209 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2210 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2211 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2212 {
2213 if (fc == *pfc)
2214 {
2215 *pfc = fc->caller;
2216 free_funccal_contents(fc);
2217 return;
2218 }
2219 }
2220 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2221 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2222 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2223}
2224
2225/*
2226 * Remove the function from the function hashtable. If the function was
2227 * deleted while it still has references this was already done.
2228 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2229 */
2230 static int
2231func_remove(ufunc_T *fp)
2232{
2233 hashitem_T *hi;
2234
2235 // Return if it was already virtually deleted.
2236 if (fp->uf_flags & FC_DEAD)
2237 return FALSE;
2238
2239 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2240 if (!HASHITEM_EMPTY(hi))
2241 {
2242 // When there is a def-function index do not actually remove the
2243 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002244 // Do remove it when it's a copy.
2245 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002246 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002247 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002248 return FALSE;
2249 }
2250 hash_remove(&func_hashtab, hi);
2251 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002252 return TRUE;
2253 }
2254 return FALSE;
2255}
2256
2257 static void
2258func_clear_items(ufunc_T *fp)
2259{
2260 ga_clear_strings(&(fp->uf_args));
2261 ga_clear_strings(&(fp->uf_def_args));
2262 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002263 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002264 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002265 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002266 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002267
2268 // Increment the refcount of this function to avoid it being freed
2269 // recursively when the partial is freed.
2270 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002271 partial_unref(fp->uf_partial);
2272 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002273 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002274
2275#ifdef FEAT_LUA
2276 if (fp->uf_cb_free != NULL)
2277 {
2278 fp->uf_cb_free(fp->uf_cb_state);
2279 fp->uf_cb_free = NULL;
2280 }
2281
2282 fp->uf_cb_state = NULL;
2283 fp->uf_cb = NULL;
2284#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002285#ifdef FEAT_PROFILE
2286 VIM_CLEAR(fp->uf_tml_count);
2287 VIM_CLEAR(fp->uf_tml_total);
2288 VIM_CLEAR(fp->uf_tml_self);
2289#endif
2290}
2291
2292/*
2293 * Free all things that a function contains. Does not free the function
2294 * itself, use func_free() for that.
2295 * When "force" is TRUE we are exiting.
2296 */
2297 static void
2298func_clear(ufunc_T *fp, int force)
2299{
2300 if (fp->uf_cleared)
2301 return;
2302 fp->uf_cleared = TRUE;
2303
2304 // clear this function
2305 func_clear_items(fp);
2306 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002307 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002308}
2309
2310/*
2311 * Free a function and remove it from the list of functions. Does not free
2312 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002313 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002314 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002315 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002316 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002317func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002318{
2319 // Only remove it when not done already, otherwise we would remove a newer
2320 // version of the function with the same name.
2321 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2322 func_remove(fp);
2323
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002324 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002325 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002326 if (fp->uf_dfunc_idx > 0)
2327 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002328 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002329 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002330 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002331 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002332 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002333}
2334
2335/*
2336 * Free all things that a function contains and free the function itself.
2337 * When "force" is TRUE we are exiting.
2338 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002339 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002340func_clear_free(ufunc_T *fp, int force)
2341{
2342 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002343 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2344 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002345 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002346 else
2347 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002348}
2349
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002350/*
2351 * Copy already defined function "lambda" to a new function with name "global".
2352 * This is for when a compiled function defines a global function.
2353 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002354 int
2355copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002356{
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002357 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002358 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002359
2360 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002361 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002362 semsg(_(e_lambda_function_not_found_str), lambda);
2363 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002364 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002365
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002366 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002367 if (fp != NULL)
2368 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002369 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002370 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002371 return FAIL;
2372 }
2373
2374 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2375 if (fp == NULL)
2376 return FAIL;
2377
2378 fp->uf_varargs = ufunc->uf_varargs;
2379 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2380 fp->uf_def_status = ufunc->uf_def_status;
2381 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2382 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2383 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2384 == FAIL
2385 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2386 goto failed;
2387
2388 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2389 : vim_strsave(ufunc->uf_name_exp);
2390 if (ufunc->uf_arg_types != NULL)
2391 {
2392 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2393 if (fp->uf_arg_types == NULL)
2394 goto failed;
2395 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2396 sizeof(type_T *) * fp->uf_args.ga_len);
2397 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002398 if (ufunc->uf_va_name != NULL)
2399 {
2400 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2401 if (fp->uf_va_name == NULL)
2402 goto failed;
2403 }
2404 fp->uf_ret_type = ufunc->uf_ret_type;
2405
2406 fp->uf_refcount = 1;
2407 STRCPY(fp->uf_name, global);
2408 hash_add(&func_hashtab, UF2HIKEY(fp));
2409
2410 // the referenced dfunc_T is now used one more time
2411 link_def_function(fp);
2412
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002413 // Create a partial to store the context of the function where it was
2414 // instantiated. Only needs to be done once. Do this on the original
2415 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002416 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2417 {
2418 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2419
2420 if (pt == NULL)
2421 goto failed;
2422 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002423 {
2424 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002425 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002426 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002427 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002428 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002429 }
2430
2431 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002432
2433failed:
2434 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002435 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002436}
2437
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002438static int funcdepth = 0;
2439
2440/*
2441 * Increment the function call depth count.
2442 * Return FAIL when going over 'maxfuncdepth'.
2443 * Otherwise return OK, must call funcdepth_decrement() later!
2444 */
2445 int
2446funcdepth_increment(void)
2447{
2448 if (funcdepth >= p_mfd)
2449 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002450 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002451 return FAIL;
2452 }
2453 ++funcdepth;
2454 return OK;
2455}
2456
2457 void
2458funcdepth_decrement(void)
2459{
2460 --funcdepth;
2461}
2462
2463/*
2464 * Get the current function call depth.
2465 */
2466 int
2467funcdepth_get(void)
2468{
2469 return funcdepth;
2470}
2471
2472/*
2473 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002474 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002475 * times as funcdepth_increment().
2476 */
2477 void
2478funcdepth_restore(int depth)
2479{
2480 funcdepth = depth;
2481}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002482
2483/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 * Call a user function.
2485 */
2486 static void
2487call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002488 ufunc_T *fp, // pointer to function
2489 int argcount, // nr of args
2490 typval_T *argvars, // arguments
2491 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002492 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002493 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002494{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002495 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002496 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002497 funccall_T *fc;
2498 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002499 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002501 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502 int i;
2503 int ai;
2504 int islambda = FALSE;
2505 char_u numbuf[NUMBUFLEN];
2506 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002507 typval_T *tv_to_free[MAX_FUNC_ARGS];
2508 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002510 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002512 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513
Bram Moolenaarb2049902021-01-24 12:53:53 +01002514#ifdef FEAT_PROFILE
2515 CLEAR_FIELD(profile_info);
2516#endif
2517
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002518 // If depth of calling is getting too high, don't execute the function.
2519 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521 rettv->v_type = VAR_NUMBER;
2522 rettv->vval.v_number = -1;
2523 return;
2524 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525
Bram Moolenaare38eab22019-12-05 21:50:01 +01002526 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002527
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002528 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002529 if (fc == NULL)
2530 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 fc->caller = current_funccal;
2532 current_funccal = fc;
2533 fc->func = fp;
2534 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002536 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2538 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002539 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002540 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002541 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002543 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002544 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002545#ifdef FEAT_PROFILE
2546 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2547#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002548 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002549#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002550 if (do_profiling == PROF_YES)
2551 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002552#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002553 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002554 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002555#ifdef FEAT_PROFILE
2556 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002557 || (caller != NULL && caller->uf_profiling)))
2558 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002559#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002560 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002561 free_funccal(fc);
2562 return;
2563 }
2564
Bram Moolenaar38453522021-11-28 22:00:12 +00002565 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566
2567 /*
2568 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2569 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2570 * each argument variable and saves a lot of time.
2571 */
2572 /*
2573 * Init l: variables.
2574 */
2575 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2576 if (selfdict != NULL)
2577 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002578 // Set l:self to "selfdict". Use "name" to avoid a warning from
2579 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002580 v = &fc->fixvar[fixvar_idx++].var;
2581 name = v->di_key;
2582 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002583 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002584 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2585 v->di_tv.v_type = VAR_DICT;
2586 v->di_tv.v_lock = 0;
2587 v->di_tv.vval.v_dict = selfdict;
2588 ++selfdict->dv_refcount;
2589 }
2590
2591 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002592 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002593 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002594 * Set a:000 to a list with room for the "..." arguments.
2595 */
2596 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002597 if ((fp->uf_flags & FC_NOARGS) == 0)
2598 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002599 (varnumber_T)(argcount >= fp->uf_args.ga_len
2600 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002601 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002602 if ((fp->uf_flags & FC_NOARGS) == 0)
2603 {
2604 // Use "name" to avoid a warning from some compiler that checks the
2605 // destination size.
2606 v = &fc->fixvar[fixvar_idx++].var;
2607 name = v->di_key;
2608 STRCPY(name, "000");
2609 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2610 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2611 v->di_tv.v_type = VAR_LIST;
2612 v->di_tv.v_lock = VAR_FIXED;
2613 v->di_tv.vval.v_list = &fc->l_varlist;
2614 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002615 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2617 fc->l_varlist.lv_lock = VAR_FIXED;
2618
2619 /*
2620 * Set a:firstline to "firstline" and a:lastline to "lastline".
2621 * Set a:name to named arguments.
2622 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002623 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002625 if ((fp->uf_flags & FC_NOARGS) == 0)
2626 {
2627 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002628 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002629 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002630 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002631 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002632 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 {
2634 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002635 typval_T def_rettv;
2636 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637
2638 ai = i - fp->uf_args.ga_len;
2639 if (ai < 0)
2640 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002641 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 name = FUNCARG(fp, i);
2643 if (islambda)
2644 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002645
2646 // evaluate named argument default expression
2647 isdefault = ai + fp->uf_def_args.ga_len >= 0
2648 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2649 && argvars[i].vval.v_number == VVAL_NONE));
2650 if (isdefault)
2651 {
2652 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002653
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002654 def_rettv.v_type = VAR_NUMBER;
2655 def_rettv.vval.v_number = -1;
2656
2657 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2658 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002659 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002660 {
2661 default_arg_err = 1;
2662 break;
2663 }
2664 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 }
2666 else
2667 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002668 if ((fp->uf_flags & FC_NOARGS) != 0)
2669 // Bail out if no a: arguments used (in lambda).
2670 break;
2671
Bram Moolenaare38eab22019-12-05 21:50:01 +01002672 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 sprintf((char *)numbuf, "%d", ai + 1);
2674 name = numbuf;
2675 }
2676 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2677 {
2678 v = &fc->fixvar[fixvar_idx++].var;
2679 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002680 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 }
2682 else
2683 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002684 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685 if (v == NULL)
2686 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002687 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002689
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002690 // Note: the values are copied directly to avoid alloc/free.
2691 // "argvars" must have VAR_FIXED for v_lock.
2692 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693 v->di_tv.v_lock = VAR_FIXED;
2694
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002695 if (isdefault)
2696 // Need to free this later, no matter where it's stored.
2697 tv_to_free[tv_to_free_len++] = &v->di_tv;
2698
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 if (addlocal)
2700 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002701 // Named arguments should be accessed without the "a:" prefix in
2702 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002703 copy_tv(&v->di_tv, &v->di_tv);
2704 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002706 else
2707 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708
2709 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2710 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002711 listitem_T *li = &fc->l_listitems[ai];
2712
2713 li->li_tv = argvars[i];
2714 li->li_tv.v_lock = VAR_FIXED;
2715 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 }
2717 }
2718
Bram Moolenaare38eab22019-12-05 21:50:01 +01002719 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002721
2722 if (fp->uf_flags & FC_SANDBOX)
2723 {
2724 using_sandbox = TRUE;
2725 ++sandbox;
2726 }
2727
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002728 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002729 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002730 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002732 ++no_wait_return;
2733 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002735 smsg(_("calling %s"), SOURCING_NAME);
2736 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002737 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002738 char_u buf[MSG_BUF_LEN];
2739 char_u numbuf2[NUMBUFLEN];
2740 char_u *tofree;
2741 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002743 msg_puts("(");
2744 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002745 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002746 if (i > 0)
2747 msg_puts(", ");
2748 if (argvars[i].v_type == VAR_NUMBER)
2749 msg_outnum((long)argvars[i].vval.v_number);
2750 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002752 // Do not want errors such as E724 here.
2753 ++emsg_off;
2754 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2755 --emsg_off;
2756 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002758 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002759 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002760 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2761 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002763 msg_puts((char *)s);
2764 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 }
2766 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002768 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002770 msg_puts("\n"); // don't overwrite this either
2771
2772 verbose_leave_scroll();
2773 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 }
2775#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002776 if (do_profiling == PROF_YES)
2777 profile_may_start_func(&profile_info, fp,
2778 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002779#endif
2780
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002781 save_current_sctx = current_sctx;
2782 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 save_did_emsg = did_emsg;
2784 did_emsg = FALSE;
2785
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002786 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2787 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002788 else if (islambda)
2789 {
2790 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2791
2792 // A Lambda always has the command "return {expr}". It is much faster
2793 // to evaluate {expr} directly.
2794 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002795 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002796 --ex_nesting_level;
2797 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002798 else
2799 // call do_cmdline() to execute the lines
2800 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002801 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2802
2803 --RedrawingDisabled;
2804
Bram Moolenaare38eab22019-12-05 21:50:01 +01002805 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2807 {
2808 clear_tv(rettv);
2809 rettv->v_type = VAR_NUMBER;
2810 rettv->vval.v_number = -1;
2811 }
2812
2813#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002814 if (do_profiling == PROF_YES)
2815 {
2816 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2817
2818 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2819 profile_may_end_func(&profile_info, fp, caller);
2820 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821#endif
2822
Bram Moolenaare38eab22019-12-05 21:50:01 +01002823 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 if (p_verbose >= 12)
2825 {
2826 ++no_wait_return;
2827 verbose_enter_scroll();
2828
2829 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002830 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002832 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002833 (long)fc->rettv->vval.v_number);
2834 else
2835 {
2836 char_u buf[MSG_BUF_LEN];
2837 char_u numbuf2[NUMBUFLEN];
2838 char_u *tofree;
2839 char_u *s;
2840
Bram Moolenaare38eab22019-12-05 21:50:01 +01002841 // The value may be very long. Skip the middle part, so that we
2842 // have some idea how it starts and ends. smsg() would always
2843 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 ++emsg_off;
2845 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2846 --emsg_off;
2847 if (s != NULL)
2848 {
2849 if (vim_strsize(s) > MSG_BUF_CLEN)
2850 {
2851 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2852 s = buf;
2853 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002854 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 vim_free(tofree);
2856 }
2857 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002858 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859
2860 verbose_leave_scroll();
2861 --no_wait_return;
2862 }
2863
Bram Moolenaare31ee862020-01-07 20:59:34 +01002864 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002865 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002866 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867#ifdef FEAT_PROFILE
2868 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002869 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002871 if (using_sandbox)
2872 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002874 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 {
2876 ++no_wait_return;
2877 verbose_enter_scroll();
2878
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002879 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002880 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881
2882 verbose_leave_scroll();
2883 --no_wait_return;
2884 }
2885
2886 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002887 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002888 for (i = 0; i < tv_to_free_len; ++i)
2889 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002890 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002891}
2892
2893/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002894 * Check the argument count for user function "fp".
2895 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2896 */
2897 int
2898check_user_func_argcount(ufunc_T *fp, int argcount)
2899{
2900 int regular_args = fp->uf_args.ga_len;
2901
2902 if (argcount < regular_args - fp->uf_def_args.ga_len)
2903 return FCERR_TOOFEW;
2904 else if (!has_varargs(fp) && argcount > regular_args)
2905 return FCERR_TOOMANY;
2906 return FCERR_UNKNOWN;
2907}
2908
2909/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002910 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002911 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002912 int
2913call_user_func_check(
2914 ufunc_T *fp,
2915 int argcount,
2916 typval_T *argvars,
2917 typval_T *rettv,
2918 funcexe_T *funcexe,
2919 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002920{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002921 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002922
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002923 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2924 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002925 error = check_user_func_argcount(fp, argcount);
2926 if (error != FCERR_UNKNOWN)
2927 return error;
2928 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002929 error = FCERR_DICT;
2930 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002931 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002932 int did_save_redo = FALSE;
2933 save_redo_T save_redo;
2934
2935 /*
2936 * Call the user function.
2937 * Save and restore search patterns, script variables and
2938 * redo buffer.
2939 */
2940 save_search_patterns();
2941 if (!ins_compl_active())
2942 {
2943 saveRedobuff(&save_redo);
2944 did_save_redo = TRUE;
2945 }
2946 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002947 call_user_func(fp, argcount, argvars, rettv, funcexe,
2948 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002949 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2950 // Function was unreferenced while being used, free it now.
2951 func_clear_free(fp, FALSE);
2952 if (did_save_redo)
2953 restoreRedobuff(&save_redo);
2954 restore_search_patterns();
2955 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002956 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002957 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002958}
2959
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002960static funccal_entry_T *funccal_stack = NULL;
2961
2962/*
2963 * Save the current function call pointer, and set it to NULL.
2964 * Used when executing autocommands and for ":source".
2965 */
2966 void
2967save_funccal(funccal_entry_T *entry)
2968{
2969 entry->top_funccal = current_funccal;
2970 entry->next = funccal_stack;
2971 funccal_stack = entry;
2972 current_funccal = NULL;
2973}
2974
2975 void
2976restore_funccal(void)
2977{
2978 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002979 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002980 else
2981 {
2982 current_funccal = funccal_stack->top_funccal;
2983 funccal_stack = funccal_stack->next;
2984 }
2985}
2986
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002987 funccall_T *
2988get_current_funccal(void)
2989{
2990 return current_funccal;
2991}
2992
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002993/*
2994 * Mark all functions of script "sid" as deleted.
2995 */
2996 void
2997delete_script_functions(int sid)
2998{
2999 hashitem_T *hi;
3000 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003001 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003002 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003003 size_t len;
3004
3005 buf[0] = K_SPECIAL;
3006 buf[1] = KS_EXTRA;
3007 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003008 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003009 len = STRLEN(buf);
3010
Bram Moolenaarce658352020-07-31 23:47:12 +02003011 while (todo > 0)
3012 {
3013 todo = func_hashtab.ht_used;
3014 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3015 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003016 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003017 fp = HI2UF(hi);
3018 if (STRNCMP(fp->uf_name, buf, len) == 0)
3019 {
3020 int changed = func_hashtab.ht_changed;
3021
3022 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003023
3024 if (fp->uf_calls > 0)
3025 {
3026 // Function is executing, don't free it but do remove
3027 // it from the hashtable.
3028 if (func_remove(fp))
3029 fp->uf_refcount--;
3030 }
3031 else
3032 {
3033 func_clear(fp, TRUE);
3034 // When clearing a function another function can be
3035 // cleared as a side effect. When that happens start
3036 // over.
3037 if (changed != func_hashtab.ht_changed)
3038 break;
3039 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003040 }
3041 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003042 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003043 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003044}
3045
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046#if defined(EXITFREE) || defined(PROTO)
3047 void
3048free_all_functions(void)
3049{
3050 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003051 ufunc_T *fp;
3052 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003053 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003054 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055
Bram Moolenaare38eab22019-12-05 21:50:01 +01003056 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003057 while (current_funccal != NULL)
3058 {
3059 clear_tv(current_funccal->rettv);
3060 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003061 if (current_funccal == NULL && funccal_stack != NULL)
3062 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003063 }
3064
Bram Moolenaare38eab22019-12-05 21:50:01 +01003065 // First clear what the functions contain. Since this may lower the
3066 // reference count of a function, it may also free a function and change
3067 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003068 while (todo > 0)
3069 {
3070 todo = func_hashtab.ht_used;
3071 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3072 if (!HASHITEM_EMPTY(hi))
3073 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003074 // clear the def function index now
3075 fp = HI2UF(hi);
3076 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003077 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003078
Bram Moolenaare38eab22019-12-05 21:50:01 +01003079 // Only free functions that are not refcounted, those are
3080 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003081 if (func_name_refcount(fp->uf_name))
3082 ++skipped;
3083 else
3084 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003085 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003086 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003087 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003088 {
3089 skipped = 0;
3090 break;
3091 }
3092 }
3093 --todo;
3094 }
3095 }
3096
Bram Moolenaare38eab22019-12-05 21:50:01 +01003097 // Now actually free the functions. Need to start all over every time,
3098 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003099 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003100 while (func_hashtab.ht_used > skipped)
3101 {
3102 todo = func_hashtab.ht_used;
3103 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003104 if (!HASHITEM_EMPTY(hi))
3105 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003106 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003107 // Only free functions that are not refcounted, those are
3108 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003109 fp = HI2UF(hi);
3110 if (func_name_refcount(fp->uf_name))
3111 ++skipped;
3112 else
3113 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003114 if (func_free(fp, FALSE) == OK)
3115 {
3116 skipped = 0;
3117 break;
3118 }
3119 // did not actually free it
3120 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003121 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003123 }
3124 if (skipped == 0)
3125 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003126
3127 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128}
3129#endif
3130
3131/*
3132 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003133 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3134 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135 * "len" is the length of "name", or -1 for NUL terminated.
3136 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003137 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138builtin_function(char_u *name, int len)
3139{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003140 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141
Bram Moolenaara26b9702020-04-18 19:53:28 +02003142 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003144 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3145 {
3146 if (name[i] == AUTOLOAD_CHAR)
3147 return FALSE;
3148 if (!eval_isnamec(name[i]))
3149 {
3150 // "name.something" is not a builtin function
3151 if (name[i] == '.')
3152 return FALSE;
3153 break;
3154 }
3155 }
3156 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157}
3158
3159 int
3160func_call(
3161 char_u *name,
3162 typval_T *args,
3163 partial_T *partial,
3164 dict_T *selfdict,
3165 typval_T *rettv)
3166{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003167 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003168 listitem_T *item;
3169 typval_T argv[MAX_FUNC_ARGS + 1];
3170 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003171 int r = 0;
3172
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003173 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003174 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 {
3176 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3177 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003178 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179 break;
3180 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003181 // Make a copy of each argument. This is needed to be able to set
3182 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003183 copy_tv(&item->li_tv, &argv[argc++]);
3184 }
3185
3186 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003187 {
3188 funcexe_T funcexe;
3189
Bram Moolenaara80faa82020-04-12 19:37:17 +02003190 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003191 funcexe.fe_firstline = curwin->w_cursor.lnum;
3192 funcexe.fe_lastline = curwin->w_cursor.lnum;
3193 funcexe.fe_evaluate = TRUE;
3194 funcexe.fe_partial = partial;
3195 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003196 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3197 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003198
Bram Moolenaare38eab22019-12-05 21:50:01 +01003199 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003200 while (argc > 0)
3201 clear_tv(&argv[--argc]);
3202
3203 return r;
3204}
3205
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003206static int callback_depth = 0;
3207
3208 int
3209get_callback_depth(void)
3210{
3211 return callback_depth;
3212}
3213
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003215 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003216 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003217 */
3218 int
3219call_callback(
3220 callback_T *callback,
3221 int len, // length of "name" or -1 to use strlen()
3222 typval_T *rettv, // return value goes here
3223 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003224 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003225 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003226{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003227 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003228 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003229
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003230 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3231 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003232 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003233 funcexe.fe_evaluate = TRUE;
3234 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003235 ++callback_depth;
3236 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3237 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003238
3239 // When a :def function was called that uses :try an error would be turned
3240 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003241 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003242 {
3243 need_rethrow = FALSE;
3244 handle_did_throw();
3245 }
3246
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003247 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003248}
3249
3250/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003251 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003252 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003253 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3254 */
3255 varnumber_T
3256call_callback_retnr(
3257 callback_T *callback,
3258 int argcount, // number of "argvars"
3259 typval_T *argvars) // vars for arguments, must have "argcount"
3260 // PLUS ONE elements!
3261{
3262 typval_T rettv;
3263 varnumber_T retval;
3264
3265 if (call_callback(callback, 0, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003266 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003267
3268 retval = tv_get_number_chk(&rettv, NULL);
3269 clear_tv(&rettv);
3270 return retval;
3271}
3272
3273/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003274 * Give an error message for the result of a function.
3275 * Nothing if "error" is FCERR_NONE.
3276 */
3277 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003278user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279{
3280 switch (error)
3281 {
3282 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003283 if (funcexe->fe_found_var)
3284 semsg(_(e_not_callable_type_str), name);
3285 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003286 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003287 break;
3288 case FCERR_NOTMETHOD:
3289 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003290 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003291 break;
3292 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003293 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003294 break;
3295 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003296 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003297 break;
3298 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003299 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003300 break;
3301 case FCERR_SCRIPT:
3302 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003303 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003304 break;
3305 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003306 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3307 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003308 break;
3309 }
3310}
3311
3312/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003314 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315 * Return FAIL when the function can't be called, OK otherwise.
3316 * Also returns OK when an error was encountered while executing the function.
3317 */
3318 int
3319call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003320 char_u *funcname, // name of the function
3321 int len, // length of "name" or -1 to use strlen()
3322 typval_T *rettv, // return value goes here
3323 int argcount_in, // number of "argvars"
3324 typval_T *argvars_in, // vars for arguments, must have "argcount"
3325 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003326 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327{
3328 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003329 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003331 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 char_u fname_buf[FLEN_FIXED + 1];
3333 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003334 char_u *fname = NULL;
3335 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 int argcount = argcount_in;
3337 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003338 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003339 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003340 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003342 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003343 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003344 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003345 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003347 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3348 // even when call_func() returns FAIL.
3349 rettv->v_type = VAR_UNKNOWN;
3350
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003351 if (partial != NULL)
3352 fp = partial->pt_func;
3353 if (fp == NULL)
3354 {
3355 // Make a copy of the name, if it comes from a funcref variable it
3356 // could be changed or deleted in the called function.
3357 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3358 if (name == NULL)
3359 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003361 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3362 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003363
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003364 if (funcexe->fe_doesrange != NULL)
3365 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366
3367 if (partial != NULL)
3368 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003369 // When the function has a partial with a dict and there is a dict
3370 // argument, use the dict argument. That is backwards compatible.
3371 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003372 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003374 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 {
3376 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003377 {
3378 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3379 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003380 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003381 goto theend;
3382 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003383 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003384 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385 for (i = 0; i < argcount_in; ++i)
3386 argv[i + argv_clear] = argvars_in[i];
3387 argvars = argv;
3388 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003389
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003390 if (funcexe->fe_check_type != NULL
3391 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003392 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003393 // Now funcexe->fe_check_type is missing the added arguments,
3394 // make a copy of the type with the correction.
3395 check_type = *funcexe->fe_check_type;
3396 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003397 check_type.tt_args = check_type_args;
3398 CLEAR_FIELD(check_type_args);
3399 for (i = 0; i < check_type.tt_argcount; ++i)
3400 check_type_args[i + partial->pt_argc] =
3401 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003402 check_type.tt_argcount += partial->pt_argc;
3403 check_type.tt_min_argcount += partial->pt_argc;
3404 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405 }
3406 }
3407
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003408 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3409 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003410 {
3411 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003412 if (check_argument_types(funcexe->fe_check_type,
3413 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003414 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003415 error = FCERR_OTHER;
3416 }
3417
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003418 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419 {
3420 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003421 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422
Bram Moolenaar333894b2020-08-01 18:53:07 +02003423 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003424 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003425 {
3426 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003428 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429
Bram Moolenaare38eab22019-12-05 21:50:01 +01003430 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003432 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003434 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 {
3436 /*
3437 * User defined function.
3438 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003439 if (fp == NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003440 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003441
Bram Moolenaare38eab22019-12-05 21:50:01 +01003442 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 if (fp == NULL
3444 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003445 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003446 && !aborting())
3447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003448 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003449 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003451 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3453 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003454 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003455 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003457 if (fp == NULL)
3458 {
3459 char_u *p = untrans_function_name(rfname);
3460
3461 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003462 // Don't do this if the name starts with "s:".
3463 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003464 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003465 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003467 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003468 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003469#ifdef FEAT_LUA
3470 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3471 {
3472 cfunc_T cb = fp->uf_cb;
3473
3474 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3475 }
3476#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003477 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003479 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003480 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003481 argcount = funcexe->fe_argv_func(argcount, argvars,
3482 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003483
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003484 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003485 {
3486 // Method call: base->Method()
3487 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003488 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003489 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003490 argvars = argv;
3491 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003492 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003493
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003494 error = call_user_func_check(fp, argcount, argvars, rettv,
3495 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 }
3497 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003498 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003499 {
3500 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003501 * expr->method(): Find the method name in the table, call its
3502 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003503 */
3504 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003505 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003506 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 else
3508 {
3509 /*
3510 * Find the function name in the table, call its implementation.
3511 */
3512 error = call_internal_func(fname, argcount, argvars, rettv);
3513 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003514
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 /*
3516 * The function call (or "FuncUndefined" autocommand sequence) might
3517 * have been aborted by an error, an interrupt, or an explicitly thrown
3518 * exception that has not been caught so far. This situation can be
3519 * tested for by calling aborting(). For an error in an internal
3520 * function or for the "E132" error in call_user_func(), however, the
3521 * throw point at which the "force_abort" flag (temporarily reset by
3522 * emsg()) is normally updated has not been reached yet. We need to
3523 * update that flag first to make aborting() reliable.
3524 */
3525 update_force_abort();
3526 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003527 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003528 ret = OK;
3529
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003530theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531 /*
3532 * Report an error unless the argument evaluation or function call has been
3533 * cancelled due to an aborting error, an interrupt, or an exception.
3534 */
3535 if (!aborting())
3536 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003537 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538 }
3539
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003540 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003542 clear_tv(&argv[--argv_clear + argv_base]);
3543
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544 vim_free(tofree);
3545 vim_free(name);
3546
3547 return ret;
3548}
3549
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003550 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003551printable_func_name(ufunc_T *fp)
3552{
3553 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3554}
3555
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003557 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 */
3559 static void
3560list_func_head(ufunc_T *fp, int indent)
3561{
3562 int j;
3563
3564 msg_start();
3565 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003566 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003567 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003568 msg_puts("def ");
3569 else
3570 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003571 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 msg_putchar('(');
3573 for (j = 0; j < fp->uf_args.ga_len; ++j)
3574 {
3575 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003576 msg_puts(", ");
3577 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003578 if (fp->uf_arg_types != NULL)
3579 {
3580 char *tofree;
3581
3582 msg_puts(": ");
3583 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3584 vim_free(tofree);
3585 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003586 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3587 {
3588 msg_puts(" = ");
3589 msg_puts(((char **)(fp->uf_def_args.ga_data))
3590 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3591 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 }
3593 if (fp->uf_varargs)
3594 {
3595 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003596 msg_puts(", ");
3597 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003599 if (fp->uf_va_name != NULL)
3600 {
3601 if (j)
3602 msg_puts(", ");
3603 msg_puts("...");
3604 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003605 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003606 {
3607 char *tofree;
3608
3609 msg_puts(": ");
3610 msg_puts(type_name(fp->uf_va_type, &tofree));
3611 vim_free(tofree);
3612 }
3613 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003615
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003616 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003617 {
3618 if (fp->uf_ret_type != &t_void)
3619 {
3620 char *tofree;
3621
3622 msg_puts(": ");
3623 msg_puts(type_name(fp->uf_ret_type, &tofree));
3624 vim_free(tofree);
3625 }
3626 }
3627 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003628 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003630 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003632 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003633 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003634 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 msg_clr_eos();
3636 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003637 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638}
3639
3640/*
3641 * Get a function name, translating "<SID>" and "<SNR>".
3642 * Also handles a Funcref in a List or Dictionary.
3643 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003644 * Set "*is_global" to TRUE when the function must be global, unless
3645 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 * flags:
3647 * TFN_INT: internal function name OK
3648 * TFN_QUIET: be quiet
3649 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003650 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 * Advances "pp" to just after the function name (if no error).
3652 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003653 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003654trans_function_name(
3655 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003656 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003657 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003659 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003660 partial_T **partial, // return: partial of a FuncRef
3661 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662{
3663 char_u *name = NULL;
3664 char_u *start;
3665 char_u *end;
3666 int lead;
3667 char_u sid_buf[20];
3668 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003669 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003671 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672
3673 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003674 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675 start = *pp;
3676
Bram Moolenaare38eab22019-12-05 21:50:01 +01003677 // Check for hard coded <SNR>: already translated function ID (from a user
3678 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3680 && (*pp)[2] == (int)KE_SNR)
3681 {
3682 *pp += 3;
3683 len = get_id_len(pp) + 3;
3684 return vim_strnsave(start, len);
3685 }
3686
Bram Moolenaare38eab22019-12-05 21:50:01 +01003687 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3688 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 lead = eval_fname_script(start);
3690 if (lead > 2)
3691 start += lead;
3692
Bram Moolenaare38eab22019-12-05 21:50:01 +01003693 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003694 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 lead > 2 ? 0 : FNE_CHECK_START);
3696 if (end == start)
3697 {
3698 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003699 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 goto theend;
3701 }
3702 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3703 {
3704 /*
3705 * Report an invalid expression in braces, unless the expression
3706 * evaluation has been cancelled due to an aborting error, an
3707 * interrupt, or an exception.
3708 */
3709 if (!aborting())
3710 {
3711 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003712 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 }
3714 else
3715 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3716 goto theend;
3717 }
3718
3719 if (lv.ll_tv != NULL)
3720 {
3721 if (fdp != NULL)
3722 {
3723 fdp->fd_dict = lv.ll_dict;
3724 fdp->fd_newkey = lv.ll_newkey;
3725 lv.ll_newkey = NULL;
3726 fdp->fd_di = lv.ll_di;
3727 }
3728 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3729 {
3730 name = vim_strsave(lv.ll_tv->vval.v_string);
3731 *pp = end;
3732 }
3733 else if (lv.ll_tv->v_type == VAR_PARTIAL
3734 && lv.ll_tv->vval.v_partial != NULL)
3735 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003736 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 *pp = end;
3738 if (partial != NULL)
3739 *partial = lv.ll_tv->vval.v_partial;
3740 }
3741 else
3742 {
3743 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3744 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003745 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003746 else
3747 *pp = end;
3748 name = NULL;
3749 }
3750 goto theend;
3751 }
3752
3753 if (lv.ll_name == NULL)
3754 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003755 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 *pp = end;
3757 goto theend;
3758 }
3759
Bram Moolenaare38eab22019-12-05 21:50:01 +01003760 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 if (lv.ll_exp_name != NULL)
3762 {
3763 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003764 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003765 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 if (name == lv.ll_exp_name)
3767 name = NULL;
3768 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003769 else if (lv.ll_sid > 0)
3770 {
3771 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3772 int cc = *lv.ll_name_end;
3773
3774 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3775 *lv.ll_name_end = NUL;
3776 if (si->sn_autoload_prefix != NULL)
3777 {
3778 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3779 }
3780 else
3781 {
3782 sid_buf[0] = K_SPECIAL;
3783 sid_buf[1] = KS_EXTRA;
3784 sid_buf[2] = (int)KE_SNR;
3785 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
3786 "%ld_", (long)current_sctx.sc_sid);
3787 name = concat_str(sid_buf, lv.ll_name);
3788 }
3789 *lv.ll_name_end = cc;
3790 *pp = end;
3791 goto theend;
3792 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003793 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 {
3795 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003796 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003797 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 if (name == *pp)
3799 name = NULL;
3800 }
3801 if (name != NULL)
3802 {
3803 name = vim_strsave(name);
3804 *pp = end;
3805 if (STRNCMP(name, "<SNR>", 5) == 0)
3806 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003807 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 name[0] = K_SPECIAL;
3809 name[1] = KS_EXTRA;
3810 name[2] = (int)KE_SNR;
3811 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3812 }
3813 goto theend;
3814 }
3815
3816 if (lv.ll_exp_name != NULL)
3817 {
3818 len = (int)STRLEN(lv.ll_exp_name);
3819 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3820 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3821 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003822 // When there was "s:" already or the name expanded to get a
3823 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 lv.ll_name += 2;
3825 len -= 2;
3826 lead = 2;
3827 }
3828 }
3829 else
3830 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003831 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003833 {
3834 if (is_global != NULL && lv.ll_name[0] == 'g')
3835 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003837 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 len = (int)(end - lv.ll_name);
3839 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003840 if (len <= 0)
3841 {
3842 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003843 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003844 goto theend;
3845 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003847 // In Vim9 script a user function is script-local by default, unless it
3848 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003849 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003850 if (vim9script)
3851 {
3852 char_u *p;
3853
3854 // SomeScript#func() is a global function.
3855 for (p = start; *p != NUL && *p != '('; ++p)
3856 if (*p == AUTOLOAD_CHAR)
3857 vim9script = FALSE;
3858 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003859
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003860 /*
3861 * Copy the function name to allocated memory.
3862 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3863 * Accept <SNR>123_name() outside a script.
3864 */
3865 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003866 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003867 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003869 if (!vim9script)
3870 lead = 3;
3871 if (vim9script || (lv.ll_exp_name != NULL
3872 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 || eval_fname_sid(*pp))
3874 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003875 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003876 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003878 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879 goto theend;
3880 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003881 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003882 if (vim9script)
3883 extra = 3 + (int)STRLEN(sid_buf);
3884 else
3885 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003886 }
3887 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003888 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3889 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003890 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00003891 semsg(_(e_function_name_must_start_with_capital_or_s_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 goto theend;
3893 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003894 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895 {
3896 char_u *cp = vim_strchr(lv.ll_name, ':');
3897
3898 if (cp != NULL && cp < end)
3899 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003900 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901 goto theend;
3902 }
3903 }
3904
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003905 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906 if (name != NULL)
3907 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003908 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909 {
3910 name[0] = K_SPECIAL;
3911 name[1] = KS_EXTRA;
3912 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003913 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914 STRCPY(name + 3, sid_buf);
3915 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003916 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3917 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918 }
3919 *pp = end;
3920
3921theend:
3922 clear_lval(&lv);
3923 return name;
3924}
3925
3926/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003927 * Assuming "name" is the result of trans_function_name() and it was prefixed
3928 * to use the script-local name, return the unmodified name (points into
3929 * "name"). Otherwise return NULL.
3930 * This can be used to first search for a script-local function and fall back
3931 * to the global function if not found.
3932 */
3933 char_u *
3934untrans_function_name(char_u *name)
3935{
3936 char_u *p;
3937
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003938 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003939 {
3940 p = vim_strchr(name, '_');
3941 if (p != NULL)
3942 return p + 1;
3943 }
3944 return NULL;
3945}
3946
3947/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003948 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3949 * current script ID and returns the expanded function name. The caller should
3950 * free the returned name. If not called from a script context or the function
3951 * name doesn't start with these prefixes, then returns NULL.
3952 * This doesn't check whether the script-local function exists or not.
3953 */
3954 char_u *
3955get_scriptlocal_funcname(char_u *funcname)
3956{
3957 char sid_buf[25];
3958 int off;
3959 char_u *newname;
3960
3961 if (funcname == NULL)
3962 return NULL;
3963
3964 if (STRNCMP(funcname, "s:", 2) != 0
3965 && STRNCMP(funcname, "<SID>", 5) != 0)
3966 // The function name is not a script-local function name
3967 return NULL;
3968
3969 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
3970 {
3971 emsg(_(e_using_sid_not_in_script_context));
3972 return NULL;
3973 }
3974 // Expand s: prefix into <SNR>nr_<name>
3975 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
3976 (long)current_sctx.sc_sid);
3977 off = *funcname == 's' ? 2 : 5;
3978 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
3979 if (newname == NULL)
3980 return NULL;
3981 STRCPY(newname, sid_buf);
3982 STRCAT(newname, funcname + off);
3983
3984 return newname;
3985}
3986
3987/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00003988 * Call trans_function_name(), except that a lambda is returned as-is.
3989 * Returns the name in allocated memory.
3990 */
3991 char_u *
3992save_function_name(
3993 char_u **name,
3994 int *is_global,
3995 int skip,
3996 int flags,
3997 funcdict_T *fudi)
3998{
3999 char_u *p = *name;
4000 char_u *saved;
4001
4002 if (STRNCMP(p, "<lambda>", 8) == 0)
4003 {
4004 p += 8;
4005 (void)getdigits(&p);
4006 saved = vim_strnsave(*name, p - *name);
4007 if (fudi != NULL)
4008 CLEAR_POINTER(fudi);
4009 }
4010 else
4011 saved = trans_function_name(&p, is_global, skip,
4012 flags, fudi, NULL, NULL);
4013 *name = p;
4014 return saved;
4015}
4016
4017/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004018 * List functions. When "regmatch" is NULL all of then.
4019 * Otherwise functions matching "regmatch".
4020 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004021 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004022list_functions(regmatch_T *regmatch)
4023{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004024 int changed = func_hashtab.ht_changed;
4025 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004026 hashitem_T *hi;
4027
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004028 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004029 {
4030 if (!HASHITEM_EMPTY(hi))
4031 {
4032 ufunc_T *fp = HI2UF(hi);
4033
4034 --todo;
4035 if ((fp->uf_flags & FC_DEAD) == 0
4036 && (regmatch == NULL
4037 ? !message_filtered(fp->uf_name)
4038 && !func_name_refcount(fp->uf_name)
4039 : !isdigit(*fp->uf_name)
4040 && vim_regexec(regmatch, fp->uf_name, 0)))
4041 {
4042 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004043 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004044 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004045 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004046 return;
4047 }
4048 }
4049 }
4050 }
4051}
4052
4053/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004054 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004055 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4056 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004057 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004058 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004060 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004061define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 int j;
4064 int c;
4065 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004066 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004067 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068 char_u *p;
4069 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004070 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 char_u *line_arg = NULL;
4072 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004073 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004074 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 garray_T newlines;
4076 int varargs = FALSE;
4077 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004078 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004079 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004080 int fp_allocated = FALSE;
4081 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004082 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004083 dictitem_T *v;
4084 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004085 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004088 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004089 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004090 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091
4092 /*
4093 * ":function" without argument: list functions.
4094 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004095 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004096 {
4097 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004098 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004099 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004100 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 }
4102
4103 /*
4104 * ":function /pat": list functions matching pattern.
4105 */
4106 if (*eap->arg == '/')
4107 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004108 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004109 if (!eap->skip)
4110 {
4111 regmatch_T regmatch;
4112
4113 c = *p;
4114 *p = NUL;
4115 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4116 *p = c;
4117 if (regmatch.regprog != NULL)
4118 {
4119 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004120 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121 vim_regfree(regmatch.regprog);
4122 }
4123 }
4124 if (*p == '/')
4125 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004126 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004127 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128 }
4129
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004130 ga_init(&newargs);
4131 ga_init(&argtypes);
4132 ga_init(&default_args);
4133
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134 /*
4135 * Get the function name. There are these situations:
4136 * func normal function name
4137 * "name" == func, "fudi.fd_dict" == NULL
4138 * dict.func new dictionary entry
4139 * "name" == NULL, "fudi.fd_dict" set,
4140 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4141 * dict.func existing dict entry with a Funcref
4142 * "name" == func, "fudi.fd_dict" set,
4143 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4144 * dict.func existing dict entry that's not a Funcref
4145 * "name" == NULL, "fudi.fd_dict" set,
4146 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4147 * s:func script-local function name
4148 * g:func global function name, same as "func"
4149 */
4150 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004151 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004152 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004153 // nested function, argument is (args).
4154 paren = TRUE;
4155 CLEAR_FIELD(fudi);
4156 }
4157 else
4158 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004159 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004160 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004161 paren = (vim_strchr(p, '(') != NULL);
4162 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004164 /*
4165 * Return on an invalid expression in braces, unless the expression
4166 * evaluation has been cancelled due to an aborting error, an
4167 * interrupt, or an exception.
4168 */
4169 if (!aborting())
4170 {
4171 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004172 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004173 vim_free(fudi.fd_newkey);
4174 return NULL;
4175 }
4176 else
4177 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004179
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004180 // For "export def FuncName()" in an autoload script the function name
4181 // is stored with the legacy autoload name "dir#script#FuncName" so
4182 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004183 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004184 {
4185 char_u *prefixed = may_prefix_autoload(name);
4186
4187 if (prefixed != NULL && prefixed != name)
4188 {
4189 vim_free(name);
4190 name = prefixed;
4191 }
4192 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 }
4194
Bram Moolenaare38eab22019-12-05 21:50:01 +01004195 // An error in a function call during evaluation of an expression in magic
4196 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 saved_did_emsg = did_emsg;
4198 did_emsg = FALSE;
4199
4200 /*
4201 * ":function func" with only function name: list function.
4202 */
4203 if (!paren)
4204 {
4205 if (!ends_excmd(*skipwhite(p)))
4206 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004207 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 goto ret_free;
4209 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004210 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 if (eap->nextcmd != NULL)
4212 *p = NUL;
4213 if (!eap->skip && !got_int)
4214 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004215 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004216 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4217 {
4218 char_u *up = untrans_function_name(name);
4219
4220 // With Vim9 script the name was made script-local, if not
4221 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004222 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004223 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004224 }
4225
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004226 if (fp != NULL)
4227 {
4228 list_func_head(fp, TRUE);
4229 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4230 {
4231 if (FUNCLINE(fp, j) == NULL)
4232 continue;
4233 msg_putchar('\n');
4234 msg_outnum((long)(j + 1));
4235 if (j < 9)
4236 msg_putchar(' ');
4237 if (j < 99)
4238 msg_putchar(' ');
4239 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004240 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 ui_breakcheck();
4242 }
4243 if (!got_int)
4244 {
4245 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004246 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004247 msg_puts(" enddef");
4248 else
4249 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 }
4251 }
4252 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004253 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254 }
4255 goto ret_free;
4256 }
4257
4258 /*
4259 * ":function name(arg1, arg2)" Define function.
4260 */
4261 p = skipwhite(p);
4262 if (*p != '(')
4263 {
4264 if (!eap->skip)
4265 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004266 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 goto ret_free;
4268 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004269 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 if (vim_strchr(p, '(') != NULL)
4271 p = vim_strchr(p, '(');
4272 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004274 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4275 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004276 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004277 goto ret_free;
4278 }
4279
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004280 // In Vim9 script only global functions can be redefined.
4281 if (vim9script && eap->forceit && !is_global)
4282 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004283 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004284 goto ret_free;
4285 }
4286
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004287 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288
Bram Moolenaar04b12692020-05-04 23:24:44 +02004289 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004291 // Check the name of the function. Unless it's a dictionary function
4292 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293 if (name != NULL)
4294 arg = name;
4295 else
4296 arg = fudi.fd_newkey;
4297 if (arg != NULL && (fudi.fd_di == NULL
4298 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4299 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4300 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004301 char_u *name_base = arg;
4302 int i;
4303
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004305 {
4306 name_base = vim_strchr(arg, '_');
4307 if (name_base == NULL)
4308 name_base = arg + 3;
4309 else
4310 ++name_base;
4311 }
4312 for (i = 0; name_base[i] != NUL && (i == 0
4313 ? eval_isnamec1(name_base[i])
4314 : eval_isnamec(name_base[i])); ++i)
4315 ;
4316 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004317 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004318
4319 // In Vim9 script a function cannot have the same name as a
4320 // variable.
4321 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004322 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4323 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004324 + EVAL_VAR_NO_FUNC) == OK)
4325 {
4326 semsg(_(e_redefining_script_item_str), name_base);
4327 goto ret_free;
4328 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004330 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004332 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004333 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004334 goto ret_free;
4335 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004336 }
4337
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004338 // This may get more lines and make the pointers into the first line
4339 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004340 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004341 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004342 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004343 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004344 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004346 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004348 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004350 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004351 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004353 if (*p != ':')
4354 {
4355 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4356 p = skipwhite(p);
4357 }
4358 else if (!IS_WHITE_OR_NUL(p[1]))
4359 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004360 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004361 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004362 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004363 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004364 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004365 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004366 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004367 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004368 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004369 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004370 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004371 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004372 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004373 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004374 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004376 else
4377 // find extra arguments "range", "dict", "abort" and "closure"
4378 for (;;)
4379 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004380 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004381 p = skipwhite(p);
4382 if (STRNCMP(p, "range", 5) == 0)
4383 {
4384 flags |= FC_RANGE;
4385 p += 5;
4386 }
4387 else if (STRNCMP(p, "dict", 4) == 0)
4388 {
4389 flags |= FC_DICT;
4390 p += 4;
4391 }
4392 else if (STRNCMP(p, "abort", 5) == 0)
4393 {
4394 flags |= FC_ABORT;
4395 p += 5;
4396 }
4397 else if (STRNCMP(p, "closure", 7) == 0)
4398 {
4399 flags |= FC_CLOSURE;
4400 p += 7;
4401 if (current_funccal == NULL)
4402 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004403 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004404 name == NULL ? (char_u *)"" : name);
4405 goto erret;
4406 }
4407 }
4408 else
4409 break;
4410 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411
Bram Moolenaare38eab22019-12-05 21:50:01 +01004412 // When there is a line break use what follows for the function body.
4413 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414 if (*p == '\n')
4415 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004416 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004417 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4418 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004419 && !(VIM_ISWHITE(*whitep) && *p == '#'
4420 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004421 && !eap->skip
4422 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004423 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424
4425 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004426 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4427 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428 */
4429 if (KeyTyped)
4430 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004431 // Check if the function already exists, don't let the user type the
4432 // whole function before telling him it doesn't work! For a script we
4433 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 if (!eap->skip && !eap->forceit)
4435 {
4436 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004437 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004438 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004439 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 }
4441
4442 if (!eap->skip && did_emsg)
4443 goto erret;
4444
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 cmdline_row = msg_row;
4447 }
4448
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004449 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004450 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004451
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004452 // Do not define the function when getting the body fails and when
4453 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004454 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004455 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004456 goto erret;
4457
4458 /*
4459 * If there are no errors, add the function
4460 */
4461 if (fudi.fd_dict == NULL)
4462 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004463 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004464 char_u *find_name = name;
4465 int var_conflict = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004466
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004467 v = find_var(name, &ht, TRUE);
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004468 if (v != NULL)
4469 var_conflict = TRUE;
4470
4471 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4472 {
4473 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4474
4475 if (si->sn_autoload_prefix != NULL)
4476 {
4477 if (is_export)
4478 {
4479 find_name = name + STRLEN(si->sn_autoload_prefix);
4480 v = find_var(find_name, &ht, TRUE);
4481 if (v != NULL)
4482 var_conflict = TRUE;
4483 }
4484 else
4485 {
4486 char_u *prefixed = may_prefix_autoload(name);
4487
4488 if (prefixed != NULL)
4489 {
4490 v = find_var(prefixed, &ht, TRUE);
4491 if (v != NULL)
4492 var_conflict = TRUE;
4493 vim_free(prefixed);
4494 }
4495 }
4496 }
4497 }
4498 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004500 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501 goto erret;
4502 }
4503
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004504 fp = find_func_even_dead(find_name, is_global);
Bram Moolenaareef21022020-08-01 22:16:43 +02004505 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004507 char_u *uname = untrans_function_name(name);
4508
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004509 import = find_imported(uname == NULL ? name : uname, 0,
4510 FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004511 }
4512
4513 if (fp != NULL || import != NULL)
4514 {
4515 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004516
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004517 // Function can be replaced with "function!" and when sourcing the
4518 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004519 // A name that is used by an import can not be overruled.
4520 if (import != NULL
4521 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004522 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004523 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004525 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004526 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004527 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004528 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004529 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530 goto erret;
4531 }
4532 if (fp->uf_calls > 0)
4533 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004534 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004535 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 goto erret;
4537 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004538 if (fp->uf_refcount > 1)
4539 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004540 // This function is referenced somewhere, don't redefine it but
4541 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004542 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004543 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004544 fp = NULL;
4545 overwrite = TRUE;
4546 }
4547 else
4548 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004549 char_u *exp_name = fp->uf_name_exp;
4550
4551 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004552 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004553 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004554 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004555 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004556 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004557#ifdef FEAT_PROFILE
4558 fp->uf_profiling = FALSE;
4559 fp->uf_prof_initialized = FALSE;
4560#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004561 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004562 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563 }
4564 }
4565 else
4566 {
4567 char numbuf[20];
4568
4569 fp = NULL;
4570 if (fudi.fd_newkey == NULL && !eap->forceit)
4571 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004572 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 goto erret;
4574 }
4575 if (fudi.fd_di == NULL)
4576 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004577 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004578 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579 goto erret;
4580 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004581 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004582 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 goto erret;
4584
Bram Moolenaare38eab22019-12-05 21:50:01 +01004585 // Give the function a sequential number. Can only be used with a
4586 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 vim_free(name);
4588 sprintf(numbuf, "%d", ++func_nr);
4589 name = vim_strsave((char_u *)numbuf);
4590 if (name == NULL)
4591 goto erret;
4592 }
4593
4594 if (fp == NULL)
4595 {
4596 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4597 {
4598 int slen, plen;
4599 char_u *scriptname;
4600
Bram Moolenaare38eab22019-12-05 21:50:01 +01004601 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004602 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004603 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604 {
4605 scriptname = autoload_name(name);
4606 if (scriptname != NULL)
4607 {
4608 p = vim_strchr(scriptname, '/');
4609 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004610 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004611 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004612 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004613 j = OK;
4614 vim_free(scriptname);
4615 }
4616 }
4617 if (j == FAIL)
4618 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004619 linenr_T save_lnum = SOURCING_LNUM;
4620
4621 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004622 semsg(_(e_function_name_does_not_match_script_file_name_str),
4623 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004624 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625 goto erret;
4626 }
4627 }
4628
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004629 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630 if (fp == NULL)
4631 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004632 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633
4634 if (fudi.fd_dict != NULL)
4635 {
4636 if (fudi.fd_di == NULL)
4637 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004638 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4640 if (fudi.fd_di == NULL)
4641 {
4642 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004643 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004644 goto erret;
4645 }
4646 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4647 {
4648 vim_free(fudi.fd_di);
4649 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004650 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651 goto erret;
4652 }
4653 }
4654 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004655 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656 clear_tv(&fudi.fd_di->di_tv);
4657 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659
Bram Moolenaare38eab22019-12-05 21:50:01 +01004660 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661 flags |= FC_DICT;
4662 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004663 }
4664 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004665 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004666 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004667 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004668
4669 if (eap->cmdidx == CMD_def)
4670 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004671 int lnum_save = SOURCING_LNUM;
4672 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004673
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004674 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004675
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004676 // error messages are for the first function line
4677 SOURCING_LNUM = sourcing_lnum_top;
4678
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004679 // The function may use script variables from the context.
4680 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004681
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004682 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004683 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004684 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004685 free_fp = fp_allocated;
4686 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004687 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004688 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004689
4690 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004691 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004692 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004693 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004694 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004695 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004696 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004697 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004698 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004699 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004700 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004701
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004702 if (fp_allocated)
4703 {
4704 // insert the new function in the function list
4705 set_ufunc_name(fp, name);
4706 if (overwrite)
4707 {
4708 hi = hash_find(&func_hashtab, name);
4709 hi->hi_key = UF2HIKEY(fp);
4710 }
4711 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4712 {
4713 free_fp = TRUE;
4714 goto erret;
4715 }
4716 fp->uf_refcount = 1;
4717 }
4718
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004720 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004721 if ((flags & FC_CLOSURE) != 0)
4722 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004723 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004724 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004725 }
4726 else
4727 fp->uf_scoped = NULL;
4728
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730 if (prof_def_func())
4731 func_do_profile(fp);
4732#endif
4733 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004734 if (sandbox)
4735 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004736 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004737 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 fp->uf_flags = flags;
4739 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004740 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004741 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004742 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004743 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004744 if (is_export)
4745 {
4746 fp->uf_flags |= FC_EXPORT;
4747 // let ex_export() know the export worked.
4748 is_export = FALSE;
4749 }
4750
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004751 if (eap->cmdidx == CMD_def)
4752 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004753 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4754 // :func does not use Vim9 script syntax, even in a Vim9 script file
4755 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004756
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 goto ret_free;
4758
4759erret:
4760 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004761 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004762 if (fp != NULL)
4763 {
4764 ga_init(&fp->uf_args);
4765 ga_init(&fp->uf_def_args);
4766 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004767errret_2:
4768 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004769 if (fp != NULL)
4770 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004771 if (free_fp)
4772 {
4773 vim_free(fp);
4774 fp = NULL;
4775 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004776ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004777 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004779 if (name != name_arg)
4780 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004781 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004783
4784 return fp;
4785}
4786
4787/*
4788 * ":function"
4789 */
4790 void
4791ex_function(exarg_T *eap)
4792{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004793 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004794
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004795 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4796 (void)define_function(eap, NULL, &lines_to_free);
4797 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004798}
4799
4800/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004801 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004802 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004803 */
4804 void
4805ex_defcompile(exarg_T *eap UNUSED)
4806{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004807 long todo = (long)func_hashtab.ht_used;
4808 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004809 hashitem_T *hi;
4810 ufunc_T *ufunc;
4811
4812 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4813 {
4814 if (!HASHITEM_EMPTY(hi))
4815 {
4816 --todo;
4817 ufunc = HI2UF(hi);
4818 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004819 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4820 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004821 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004822 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004823
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004824 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004825 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004826 // a function has been added or removed, need to start over
4827 todo = (long)func_hashtab.ht_used;
4828 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004829 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004830 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004831 }
4832 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004833 }
4834 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004835}
4836
4837/*
4838 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4839 * Return 2 if "p" starts with "s:".
4840 * Return 0 otherwise.
4841 */
4842 int
4843eval_fname_script(char_u *p)
4844{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004845 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4846 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4848 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4849 return 5;
4850 if (p[0] == 's' && p[1] == ':')
4851 return 2;
4852 return 0;
4853}
4854
4855 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004856translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857{
4858 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004859 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004860 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004861}
4862
4863/*
4864 * Return TRUE when "ufunc" has old-style "..." varargs
4865 * or named varargs "...name: type".
4866 */
4867 int
4868has_varargs(ufunc_T *ufunc)
4869{
4870 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004871}
4872
4873/*
4874 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004875 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004876 */
4877 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004878function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004879{
4880 char_u *nm = name;
4881 char_u *p;
4882 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004883 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004884 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004886 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4887 if (no_deref)
4888 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004889 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004890 nm = skipwhite(nm);
4891
Bram Moolenaare38eab22019-12-05 21:50:01 +01004892 // Only accept "funcname", "funcname ", "funcname (..." and
4893 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004895 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004896 vim_free(p);
4897 return n;
4898}
4899
Bram Moolenaar113e1072019-01-20 15:30:40 +01004900#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 char_u *
4902get_expanded_name(char_u *name, int check)
4903{
4904 char_u *nm = name;
4905 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004906 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004908 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004909 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004911 if (p != NULL && *nm == NUL
4912 && (!check || translated_function_exists(p, is_global)))
4913 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914
4915 vim_free(p);
4916 return NULL;
4917}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004918#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004920/*
4921 * Function given to ExpandGeneric() to obtain the list of user defined
4922 * function names.
4923 */
4924 char_u *
4925get_user_func_name(expand_T *xp, int idx)
4926{
4927 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004928 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004929 static hashitem_T *hi;
4930 ufunc_T *fp;
4931
4932 if (idx == 0)
4933 {
4934 done = 0;
4935 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004936 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004938 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939 {
4940 if (done++ > 0)
4941 ++hi;
4942 while (HASHITEM_EMPTY(hi))
4943 ++hi;
4944 fp = HI2UF(hi);
4945
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004946 // don't show dead, dict and lambda functions
4947 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004948 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004949 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004950
4951 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004952 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953
4954 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02004955 if (xp->xp_context != EXPAND_USER_FUNC
4956 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004957 {
4958 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004959 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004960 STRCAT(IObuff, ")");
4961 }
4962 return IObuff;
4963 }
4964 return NULL;
4965}
4966
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004967/*
4968 * ":delfunction {name}"
4969 */
4970 void
4971ex_delfunction(exarg_T *eap)
4972{
4973 ufunc_T *fp = NULL;
4974 char_u *p;
4975 char_u *name;
4976 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004977 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978
4979 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004980 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4981 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982 vim_free(fudi.fd_newkey);
4983 if (name == NULL)
4984 {
4985 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004986 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004987 return;
4988 }
4989 if (!ends_excmd(*skipwhite(p)))
4990 {
4991 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00004992 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004993 return;
4994 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004995 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004996 if (eap->nextcmd != NULL)
4997 *p = NUL;
4998
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004999 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005000 {
5001 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005002 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005003 vim_free(name);
5004 return;
5005 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005006 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005007 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005008 vim_free(name);
5009
5010 if (!eap->skip)
5011 {
5012 if (fp == NULL)
5013 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005014 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005015 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016 return;
5017 }
5018 if (fp->uf_calls > 0)
5019 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005020 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005021 return;
5022 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005023 if (fp->uf_flags & FC_VIM9)
5024 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005025 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005026 return;
5027 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028
5029 if (fudi.fd_dict != NULL)
5030 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005031 // Delete the dict item that refers to the function, it will
5032 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005033 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5034 }
5035 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005036 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005037 // A normal function (not a numbered function or lambda) has a
5038 // refcount of 1 for the entry in the hashtable. When deleting
5039 // it and the refcount is more than one, it should be kept.
5040 // A numbered function and lambda should be kept if the refcount is
5041 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005042 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005043 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005044 // Function is still referenced somewhere. Don't free it but
5045 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005046 if (func_remove(fp))
5047 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005048 }
5049 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005050 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052 }
5053}
5054
5055/*
5056 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005057 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005058 */
5059 void
5060func_unref(char_u *name)
5061{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005062 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005064 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005066 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005067 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005069#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005070 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005071#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005072 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005073 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005074 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005075}
5076
5077/*
5078 * Unreference a Function: decrement the reference count and free it when it
5079 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005080 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005081 */
5082 void
5083func_ptr_unref(ufunc_T *fp)
5084{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005085 if (fp != NULL && (--fp->uf_refcount <= 0
5086 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5087 && fp->uf_partial->pt_refcount <= 1
5088 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005089 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005090 // Only delete it when it's not being used. Otherwise it's done
5091 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005092 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005093 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005094 }
5095}
5096
5097/*
5098 * Count a reference to a Function.
5099 */
5100 void
5101func_ref(char_u *name)
5102{
5103 ufunc_T *fp;
5104
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005105 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005107 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005108 if (fp != NULL)
5109 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005110 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005111 // Only give an error for a numbered function.
5112 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005113 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005114}
5115
5116/*
5117 * Count a reference to a Function.
5118 */
5119 void
5120func_ptr_ref(ufunc_T *fp)
5121{
5122 if (fp != NULL)
5123 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124}
5125
5126/*
5127 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5128 * referenced from anywhere that is in use.
5129 */
5130 static int
5131can_free_funccal(funccall_T *fc, int copyID)
5132{
5133 return (fc->l_varlist.lv_copyID != copyID
5134 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005135 && fc->l_avars.dv_copyID != copyID
5136 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005137}
5138
5139/*
5140 * ":return [expr]"
5141 */
5142 void
5143ex_return(exarg_T *eap)
5144{
5145 char_u *arg = eap->arg;
5146 typval_T rettv;
5147 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005148 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005149
5150 if (current_funccal == NULL)
5151 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005152 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153 return;
5154 }
5155
Bram Moolenaar844fb642021-10-23 13:32:30 +01005156 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005157 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5158
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159 if (eap->skip)
5160 ++emsg_skip;
5161
5162 eap->nextcmd = NULL;
5163 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005164 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165 {
5166 if (!eap->skip)
5167 returning = do_return(eap, FALSE, TRUE, &rettv);
5168 else
5169 clear_tv(&rettv);
5170 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005171 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172 else if (!eap->skip)
5173 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005174 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005175 update_force_abort();
5176
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 /*
5178 * Return unless the expression evaluation has been cancelled due to an
5179 * aborting error, an interrupt, or an exception.
5180 */
5181 if (!aborting())
5182 returning = do_return(eap, FALSE, TRUE, NULL);
5183 }
5184
Bram Moolenaare38eab22019-12-05 21:50:01 +01005185 // When skipping or the return gets pending, advance to the next command
5186 // in this line (!returning). Otherwise, ignore the rest of the line.
5187 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005188 if (returning)
5189 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005190 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005191 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192
5193 if (eap->skip)
5194 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005195 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005196}
5197
5198/*
5199 * ":1,25call func(arg1, arg2)" function call.
5200 */
5201 void
5202ex_call(exarg_T *eap)
5203{
5204 char_u *arg = eap->arg;
5205 char_u *startarg;
5206 char_u *name;
5207 char_u *tofree;
5208 int len;
5209 typval_T rettv;
5210 linenr_T lnum;
5211 int doesrange;
5212 int failed = FALSE;
5213 funcdict_T fudi;
5214 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005215 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005216 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005217 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218
Bram Moolenaare6b53242020-07-01 17:28:33 +02005219 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005220 if (eap->skip)
5221 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005222 // trans_function_name() doesn't work well when skipping, use eval0()
5223 // instead to skip to any following command, e.g. for:
5224 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005225 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005226 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005227 clear_tv(&rettv);
5228 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005229 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005230 return;
5231 }
5232
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005233 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5234 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005235 if (fudi.fd_newkey != NULL)
5236 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005237 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005238 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005239 vim_free(fudi.fd_newkey);
5240 }
5241 if (tofree == NULL)
5242 return;
5243
Bram Moolenaare38eab22019-12-05 21:50:01 +01005244 // Increase refcount on dictionary, it could get deleted when evaluating
5245 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005246 if (fudi.fd_dict != NULL)
5247 ++fudi.fd_dict->dv_refcount;
5248
Bram Moolenaare38eab22019-12-05 21:50:01 +01005249 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5250 // contents. For VAR_PARTIAL get its partial, unless we already have one
5251 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005252 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005253 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005254 in_vim9script() && type == NULL ? &type : NULL,
5255 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005256
Bram Moolenaare38eab22019-12-05 21:50:01 +01005257 // Skip white space to allow ":call func ()". Not good, but required for
5258 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005259 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005260 if (*startarg != '(')
5261 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005262 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005263 goto end;
5264 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005265 if (in_vim9script() && startarg > arg)
5266 {
5267 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5268 goto end;
5269 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005270
5271 /*
5272 * When skipping, evaluate the function once, to find the end of the
5273 * arguments.
5274 * When the function takes a range, this is discovered after the first
5275 * call, and the loop is broken.
5276 */
5277 if (eap->skip)
5278 {
5279 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005280 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005281 }
5282 else
5283 lnum = eap->line1;
5284 for ( ; lnum <= eap->line2; ++lnum)
5285 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005286 funcexe_T funcexe;
5287
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005288 if (!eap->skip && eap->addr_count > 0)
5289 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005290 if (lnum > curbuf->b_ml.ml_line_count)
5291 {
5292 // If the function deleted lines or switched to another buffer
5293 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005294 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005295 break;
5296 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 curwin->w_cursor.lnum = lnum;
5298 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005299 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005300 }
5301 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005302
Bram Moolenaara80faa82020-04-12 19:37:17 +02005303 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005304 funcexe.fe_firstline = eap->line1;
5305 funcexe.fe_lastline = eap->line2;
5306 funcexe.fe_doesrange = &doesrange;
5307 funcexe.fe_evaluate = !eap->skip;
5308 funcexe.fe_partial = partial;
5309 funcexe.fe_selfdict = fudi.fd_dict;
5310 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005311 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005312 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005313 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 {
5315 failed = TRUE;
5316 break;
5317 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005318 if (has_watchexpr())
5319 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005320
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005321 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005322 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005323 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005324 {
5325 failed = TRUE;
5326 break;
5327 }
5328
5329 clear_tv(&rettv);
5330 if (doesrange || eap->skip)
5331 break;
5332
Bram Moolenaare38eab22019-12-05 21:50:01 +01005333 // Stop when immediately aborting on error, or when an interrupt
5334 // occurred or an exception was thrown but not caught.
5335 // get_func_tv() returned OK, so that the check for trailing
5336 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337 if (aborting())
5338 break;
5339 }
5340 if (eap->skip)
5341 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005342 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005343
Bram Moolenaar1d341892021-09-18 15:25:52 +02005344 // When inside :try we need to check for following "| catch" or "| endtry".
5345 // Not when there was an error, but do check if an exception was thrown.
5346 if ((!aborting() || did_throw)
5347 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005349 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005350 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005351 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005352 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005353 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005354 {
5355 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005356 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005357 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005358 }
5359 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005360 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005361 }
5362
5363end:
5364 dict_unref(fudi.fd_dict);
5365 vim_free(tofree);
5366}
5367
5368/*
5369 * Return from a function. Possibly makes the return pending. Also called
5370 * for a pending return at the ":endtry" or after returning from an extra
5371 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5372 * when called due to a ":return" command. "rettv" may point to a typval_T
5373 * with the return rettv. Returns TRUE when the return can be carried out,
5374 * FALSE when the return gets pending.
5375 */
5376 int
5377do_return(
5378 exarg_T *eap,
5379 int reanimate,
5380 int is_cmd,
5381 void *rettv)
5382{
5383 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005384 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385
5386 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005387 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005388 current_funccal->returned = FALSE;
5389
5390 /*
5391 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5392 * not in its finally clause (which then is to be executed next) is found.
5393 * In this case, make the ":return" pending for execution at the ":endtry".
5394 * Otherwise, return normally.
5395 */
5396 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5397 if (idx >= 0)
5398 {
5399 cstack->cs_pending[idx] = CSTP_RETURN;
5400
5401 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005402 // A pending return again gets pending. "rettv" points to an
5403 // allocated variable with the rettv of the original ":return"'s
5404 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005405 cstack->cs_rettv[idx] = rettv;
5406 else
5407 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005408 // When undoing a return in order to make it pending, get the stored
5409 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005410 if (reanimate)
5411 rettv = current_funccal->rettv;
5412
5413 if (rettv != NULL)
5414 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005415 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005416 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5417 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5418 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005419 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005420 }
5421 else
5422 cstack->cs_rettv[idx] = NULL;
5423
5424 if (reanimate)
5425 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005426 // The pending return value could be overwritten by a ":return"
5427 // without argument in a finally clause; reset the default
5428 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005429 current_funccal->rettv->v_type = VAR_NUMBER;
5430 current_funccal->rettv->vval.v_number = 0;
5431 }
5432 }
5433 report_make_pending(CSTP_RETURN, rettv);
5434 }
5435 else
5436 {
5437 current_funccal->returned = TRUE;
5438
Bram Moolenaare38eab22019-12-05 21:50:01 +01005439 // If the return is carried out now, store the return value. For
5440 // a return immediately after reanimation, the value is already
5441 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442 if (!reanimate && rettv != NULL)
5443 {
5444 clear_tv(current_funccal->rettv);
5445 *current_funccal->rettv = *(typval_T *)rettv;
5446 if (!is_cmd)
5447 vim_free(rettv);
5448 }
5449 }
5450
5451 return idx < 0;
5452}
5453
5454/*
5455 * Free the variable with a pending return value.
5456 */
5457 void
5458discard_pending_return(void *rettv)
5459{
5460 free_tv((typval_T *)rettv);
5461}
5462
5463/*
5464 * Generate a return command for producing the value of "rettv". The result
5465 * is an allocated string. Used by report_pending() for verbose messages.
5466 */
5467 char_u *
5468get_return_cmd(void *rettv)
5469{
5470 char_u *s = NULL;
5471 char_u *tofree = NULL;
5472 char_u numbuf[NUMBUFLEN];
5473
5474 if (rettv != NULL)
5475 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5476 if (s == NULL)
5477 s = (char_u *)"";
5478
5479 STRCPY(IObuff, ":return ");
5480 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5481 if (STRLEN(s) + 8 >= IOSIZE)
5482 STRCPY(IObuff + IOSIZE - 4, "...");
5483 vim_free(tofree);
5484 return vim_strsave(IObuff);
5485}
5486
5487/*
5488 * Get next function line.
5489 * Called by do_cmdline() to get the next line.
5490 * Returns allocated string, or NULL for end of function.
5491 */
5492 char_u *
5493get_func_line(
5494 int c UNUSED,
5495 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005496 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005497 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005498{
5499 funccall_T *fcp = (funccall_T *)cookie;
5500 ufunc_T *fp = fcp->func;
5501 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005502 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005503
Bram Moolenaare38eab22019-12-05 21:50:01 +01005504 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005505 if (fcp->dbg_tick != debug_tick)
5506 {
5507 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005508 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005509 fcp->dbg_tick = debug_tick;
5510 }
5511#ifdef FEAT_PROFILE
5512 if (do_profiling == PROF_YES)
5513 func_line_end(cookie);
5514#endif
5515
5516 gap = &fp->uf_lines;
5517 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5518 || fcp->returned)
5519 retval = NULL;
5520 else
5521 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005522 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005523 while (fcp->linenr < gap->ga_len
5524 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5525 ++fcp->linenr;
5526 if (fcp->linenr >= gap->ga_len)
5527 retval = NULL;
5528 else
5529 {
5530 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005531 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005532#ifdef FEAT_PROFILE
5533 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005534 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005535#endif
5536 }
5537 }
5538
Bram Moolenaare38eab22019-12-05 21:50:01 +01005539 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005540 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005541 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005542 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005543 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005544 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005545 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005546 fcp->dbg_tick = debug_tick;
5547 }
5548
5549 return retval;
5550}
5551
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005552/*
5553 * Return TRUE if the currently active function should be ended, because a
5554 * return was encountered or an error occurred. Used inside a ":while".
5555 */
5556 int
5557func_has_ended(void *cookie)
5558{
5559 funccall_T *fcp = (funccall_T *)cookie;
5560
Bram Moolenaare38eab22019-12-05 21:50:01 +01005561 // Ignore the "abort" flag if the abortion behavior has been changed due to
5562 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005563 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5564 || fcp->returned);
5565}
5566
5567/*
5568 * return TRUE if cookie indicates a function which "abort"s on errors.
5569 */
5570 int
5571func_has_abort(
5572 void *cookie)
5573{
5574 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5575}
5576
5577
5578/*
5579 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5580 * Don't do this when "Func" is already a partial that was bound
5581 * explicitly (pt_auto is FALSE).
5582 * Changes "rettv" in-place.
5583 * Returns the updated "selfdict_in".
5584 */
5585 dict_T *
5586make_partial(dict_T *selfdict_in, typval_T *rettv)
5587{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005588 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005589 char_u *tofree = NULL;
5590 ufunc_T *fp;
5591 char_u fname_buf[FLEN_FIXED + 1];
5592 int error;
5593 dict_T *selfdict = selfdict_in;
5594
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005595 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5596 fp = rettv->vval.v_partial->pt_func;
5597 else
5598 {
5599 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5600 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005601 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005602 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005603 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005604 vim_free(tofree);
5605 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005606
5607 if (fp != NULL && (fp->uf_flags & FC_DICT))
5608 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005609 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005610
5611 if (pt != NULL)
5612 {
5613 pt->pt_refcount = 1;
5614 pt->pt_dict = selfdict;
5615 pt->pt_auto = TRUE;
5616 selfdict = NULL;
5617 if (rettv->v_type == VAR_FUNC)
5618 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005619 // Just a function: Take over the function name and use
5620 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005621 pt->pt_name = rettv->vval.v_string;
5622 }
5623 else
5624 {
5625 partial_T *ret_pt = rettv->vval.v_partial;
5626 int i;
5627
Bram Moolenaare38eab22019-12-05 21:50:01 +01005628 // Partial: copy the function name, use selfdict and copy
5629 // args. Can't take over name or args, the partial might
5630 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005631 if (ret_pt->pt_name != NULL)
5632 {
5633 pt->pt_name = vim_strsave(ret_pt->pt_name);
5634 func_ref(pt->pt_name);
5635 }
5636 else
5637 {
5638 pt->pt_func = ret_pt->pt_func;
5639 func_ptr_ref(pt->pt_func);
5640 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005641 if (ret_pt->pt_argc > 0)
5642 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005643 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005644 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005645 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005646 pt->pt_argc = 0;
5647 else
5648 {
5649 pt->pt_argc = ret_pt->pt_argc;
5650 for (i = 0; i < pt->pt_argc; i++)
5651 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5652 }
5653 }
5654 partial_unref(ret_pt);
5655 }
5656 rettv->v_type = VAR_PARTIAL;
5657 rettv->vval.v_partial = pt;
5658 }
5659 }
5660 return selfdict;
5661}
5662
5663/*
5664 * Return the name of the executed function.
5665 */
5666 char_u *
5667func_name(void *cookie)
5668{
5669 return ((funccall_T *)cookie)->func->uf_name;
5670}
5671
5672/*
5673 * Return the address holding the next breakpoint line for a funccall cookie.
5674 */
5675 linenr_T *
5676func_breakpoint(void *cookie)
5677{
5678 return &((funccall_T *)cookie)->breakpoint;
5679}
5680
5681/*
5682 * Return the address holding the debug tick for a funccall cookie.
5683 */
5684 int *
5685func_dbg_tick(void *cookie)
5686{
5687 return &((funccall_T *)cookie)->dbg_tick;
5688}
5689
5690/*
5691 * Return the nesting level for a funccall cookie.
5692 */
5693 int
5694func_level(void *cookie)
5695{
5696 return ((funccall_T *)cookie)->level;
5697}
5698
5699/*
5700 * Return TRUE when a function was ended by a ":return" command.
5701 */
5702 int
5703current_func_returned(void)
5704{
5705 return current_funccal->returned;
5706}
5707
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005708 int
5709free_unref_funccal(int copyID, int testing)
5710{
5711 int did_free = FALSE;
5712 int did_free_funccal = FALSE;
5713 funccall_T *fc, **pfc;
5714
5715 for (pfc = &previous_funccal; *pfc != NULL; )
5716 {
5717 if (can_free_funccal(*pfc, copyID))
5718 {
5719 fc = *pfc;
5720 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005721 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005722 did_free = TRUE;
5723 did_free_funccal = TRUE;
5724 }
5725 else
5726 pfc = &(*pfc)->caller;
5727 }
5728 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005729 // When a funccal was freed some more items might be garbage
5730 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005731 (void)garbage_collect(testing);
5732
5733 return did_free;
5734}
5735
5736/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005737 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005738 */
5739 static funccall_T *
5740get_funccal(void)
5741{
5742 int i;
5743 funccall_T *funccal;
5744 funccall_T *temp_funccal;
5745
5746 funccal = current_funccal;
5747 if (debug_backtrace_level > 0)
5748 {
5749 for (i = 0; i < debug_backtrace_level; i++)
5750 {
5751 temp_funccal = funccal->caller;
5752 if (temp_funccal)
5753 funccal = temp_funccal;
5754 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005755 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005756 debug_backtrace_level = i;
5757 }
5758 }
5759 return funccal;
5760}
5761
5762/*
5763 * Return the hashtable used for local variables in the current funccal.
5764 * Return NULL if there is no current funccal.
5765 */
5766 hashtab_T *
5767get_funccal_local_ht()
5768{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005769 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005770 return NULL;
5771 return &get_funccal()->l_vars.dv_hashtab;
5772}
5773
5774/*
5775 * Return the l: scope variable.
5776 * Return NULL if there is no current funccal.
5777 */
5778 dictitem_T *
5779get_funccal_local_var()
5780{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005781 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005782 return NULL;
5783 return &get_funccal()->l_vars_var;
5784}
5785
5786/*
5787 * Return the hashtable used for argument in the current funccal.
5788 * Return NULL if there is no current funccal.
5789 */
5790 hashtab_T *
5791get_funccal_args_ht()
5792{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005793 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005794 return NULL;
5795 return &get_funccal()->l_avars.dv_hashtab;
5796}
5797
5798/*
5799 * Return the a: scope variable.
5800 * Return NULL if there is no current funccal.
5801 */
5802 dictitem_T *
5803get_funccal_args_var()
5804{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005805 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005806 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005807 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005808}
5809
5810/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005811 * List function variables, if there is a function.
5812 */
5813 void
5814list_func_vars(int *first)
5815{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005816 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005817 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005818 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005819}
5820
5821/*
5822 * If "ht" is the hashtable for local variables in the current funccal, return
5823 * the dict that contains it.
5824 * Otherwise return NULL.
5825 */
5826 dict_T *
5827get_current_funccal_dict(hashtab_T *ht)
5828{
5829 if (current_funccal != NULL
5830 && ht == &current_funccal->l_vars.dv_hashtab)
5831 return &current_funccal->l_vars;
5832 return NULL;
5833}
5834
5835/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005836 * Search hashitem in parent scope.
5837 */
5838 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005839find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005840{
5841 funccall_T *old_current_funccal = current_funccal;
5842 hashtab_T *ht;
5843 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005844 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005845
5846 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5847 return NULL;
5848
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005849 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005850 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005851 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005852 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005853 ht = find_var_ht(name, &varname);
5854 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005855 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005856 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005857 if (!HASHITEM_EMPTY(hi))
5858 {
5859 *pht = ht;
5860 break;
5861 }
5862 }
5863 if (current_funccal == current_funccal->func->uf_scoped)
5864 break;
5865 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005866 }
5867 current_funccal = old_current_funccal;
5868
5869 return hi;
5870}
5871
5872/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005873 * Search variable in parent scope.
5874 */
5875 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005876find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005877{
5878 dictitem_T *v = NULL;
5879 funccall_T *old_current_funccal = current_funccal;
5880 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005881 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005882
5883 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5884 return NULL;
5885
Bram Moolenaare38eab22019-12-05 21:50:01 +01005886 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005887 current_funccal = current_funccal->func->uf_scoped;
5888 while (current_funccal)
5889 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005890 ht = find_var_ht(name, &varname);
5891 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005892 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005893 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005894 if (v != NULL)
5895 break;
5896 }
5897 if (current_funccal == current_funccal->func->uf_scoped)
5898 break;
5899 current_funccal = current_funccal->func->uf_scoped;
5900 }
5901 current_funccal = old_current_funccal;
5902
5903 return v;
5904}
5905
5906/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005907 * Set "copyID + 1" in previous_funccal and callers.
5908 */
5909 int
5910set_ref_in_previous_funccal(int copyID)
5911{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005912 funccall_T *fc;
5913
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005914 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005915 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005916 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005917 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5918 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5919 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5920 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005921 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005922 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005923}
5924
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005925 static int
5926set_ref_in_funccal(funccall_T *fc, int copyID)
5927{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005928 if (fc->fc_copyID != copyID)
5929 {
5930 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005931 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5932 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5933 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5934 || set_ref_in_func(NULL, fc->func, copyID))
5935 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005936 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005937 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005938}
5939
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005940/*
5941 * Set "copyID" in all local vars and arguments in the call stack.
5942 */
5943 int
5944set_ref_in_call_stack(int copyID)
5945{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005946 funccall_T *fc;
5947 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005948
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005949 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5950 if (set_ref_in_funccal(fc, copyID))
5951 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005952
5953 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005954 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5955 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5956 if (set_ref_in_funccal(fc, copyID))
5957 return TRUE;
5958 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005959}
5960
5961/*
5962 * Set "copyID" in all functions available by name.
5963 */
5964 int
5965set_ref_in_functions(int copyID)
5966{
5967 int todo;
5968 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005969 ufunc_T *fp;
5970
5971 todo = (int)func_hashtab.ht_used;
5972 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005973 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005974 if (!HASHITEM_EMPTY(hi))
5975 {
5976 --todo;
5977 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005978 if (!func_name_refcount(fp->uf_name)
5979 && set_ref_in_func(NULL, fp, copyID))
5980 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005981 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005982 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005983 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005984}
5985
5986/*
5987 * Set "copyID" in all function arguments.
5988 */
5989 int
5990set_ref_in_func_args(int copyID)
5991{
5992 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005993
5994 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005995 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5996 copyID, NULL, NULL))
5997 return TRUE;
5998 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005999}
6000
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006001/*
6002 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006003 * Returns TRUE if setting references failed somehow.
6004 */
6005 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006006set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006007{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006008 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006009 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006010 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006011 char_u fname_buf[FLEN_FIXED + 1];
6012 char_u *tofree = NULL;
6013 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006014 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006015
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006016 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006017 return FALSE;
6018
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006019 if (fp_in == NULL)
6020 {
6021 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006022 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006023 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006024 if (fp != NULL)
6025 {
6026 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006027 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006028 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006029
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006030 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006031 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006032}
6033
Bram Moolenaare38eab22019-12-05 21:50:01 +01006034#endif // FEAT_EVAL