blob: 729ee89b2ea9d6d2eaad518f3abc85975c78ade2 [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 Moolenaardce24412022-02-08 20:35:30 +000058 * If "eap" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaardce24412022-02-08 20:35:30 +000069 exarg_T *eap,
Bram Moolenaar2a389082021-04-09 20:24:31 +020070 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010071 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072{
Bram Moolenaar6e949782020-04-13 17:21:00 +020073 char_u *p = arg;
74 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020075 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010076
77 while (ASCII_ISALNUM(*p) || *p == '_')
78 ++p;
79 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020080 || (argtypes == NULL
81 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
82 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010083 {
84 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000085 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 return arg;
87 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010088
Bram Moolenaar057e84a2021-02-28 16:55:11 +010089 // Vim9 script: cannot use script var name for argument. In function: also
90 // check local vars and arguments.
91 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
Bram Moolenaardce24412022-02-08 20:35:30 +000092 evalarg == NULL ? NULL : evalarg->eval_cctx,
93 eap == NULL ? NULL : eap->cstack, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000117 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000172 * Get a next line, store it in "eap" if appropriate and put the line in
173 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000174 */
175 static char_u *
176get_function_line(
177 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000178 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000179 int indent,
180 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000181{
182 char_u *theline;
183
184 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000185 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000186 else
187 theline = eap->getline(':', eap->cookie, indent, getline_options);
188 if (theline != NULL)
189 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000190 if (lines_to_free->ga_len > 0
191 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
192 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000193 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000194 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000195 }
196
197 return theline;
198}
199
200/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100203 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200204 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100205 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206get_function_args(
207 char_u **argp,
208 char_u endchar,
209 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100210 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100211 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100212 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200213 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200214 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200215 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000216 exarg_T *eap, // can be NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000217 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200218{
219 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100220 char_u *arg;
221 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200223 int any_default = FALSE;
224 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100225 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200226
227 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000228 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100229 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000230 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200231 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000232 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200233
234 if (varargs != NULL)
235 *varargs = FALSE;
236
237 /*
238 * Isolate the arguments: "arg1, arg2, ...)"
239 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100240 arg = skipwhite(*argp);
241 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200242 while (*p != endchar)
243 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200244 while (eap != NULL && eap->getline != NULL
245 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200246 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200247 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000248 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000249 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000250
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 if (theline == NULL)
252 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200253 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200254 p = skipwhite(theline);
255 }
256
257 if (mustend && *p != endchar)
258 {
259 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000260 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100261 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200262 }
263 if (*p == endchar)
264 break;
265
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
267 {
268 if (varargs != NULL)
269 *varargs = TRUE;
270 p += 3;
271 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272
273 if (argtypes != NULL)
274 {
275 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200276 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100278 if (!skip)
279 emsg(_(e_missing_name_after_dots));
280 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100281 }
282
283 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100284 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000285 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100286 if (p == arg)
287 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100288 if (*skipwhite(p) == '=')
289 {
290 emsg(_(e_cannot_use_default_for_variable_arguments));
291 break;
292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 }
295 else
296 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200297 char_u *np;
298
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200299 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100300 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000301 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200303 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304
Bram Moolenaar015cf102021-06-26 21:52:02 +0200305 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200306 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200307 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200308 if (*np == '=' && np[1] != '=' && np[1] != '~'
309 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 {
311 typval_T rettv;
312
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100313 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 any_default = TRUE;
315 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200316 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 p = skipwhite(p);
318 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200319 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200320 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200321 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200323 if (ga_grow(default_args, 1) == FAIL)
324 goto err_ret;
325
326 // trim trailing whitespace
327 while (p > expr && VIM_ISWHITE(p[-1]))
328 p--;
329 c = *p;
330 *p = NUL;
331 expr = vim_strsave(expr);
332 if (expr == NULL)
333 {
334 *p = c;
335 goto err_ret;
336 }
337 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200338 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200339 default_args->ga_len++;
340 *p = c;
341 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200342 }
343 else
344 mustend = TRUE;
345 }
346 else if (any_default)
347 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000348 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200349 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200350 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200351
352 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
353 {
354 // Be tolerant when skipping
355 if (!skip)
356 {
357 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
358 goto err_ret;
359 }
360 p = skipwhite(p);
361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200363 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200364 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200365 // Don't give this error when skipping, it makes the "->" not
366 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100367 // Allow missing space after comma in legacy functions.
368 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
370 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100371 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200372 goto err_ret;
373 }
374 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200375 else
376 mustend = TRUE;
377 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200378 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200379 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200380 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200381
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200382 if (*p != endchar)
383 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100384 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200385
386 *argp = p;
387 return OK;
388
389err_ret:
390 if (newargs != NULL)
391 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200392 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200393 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200394 return FAIL;
395}
396
397/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100398 * Parse the argument types, filling "fp->uf_arg_types".
399 * Return OK or FAIL.
400 */
401 static int
402parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
403{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200404 int len = 0;
405
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
407 if (argtypes->ga_len > 0)
408 {
409 // When "varargs" is set the last name/type goes into uf_va_name
410 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200411 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100412
413 if (len > 0)
414 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
415 if (fp->uf_arg_types != NULL)
416 {
417 int i;
418 type_T *type;
419
420 for (i = 0; i < len; ++ i)
421 {
422 char_u *p = ((char_u **)argtypes->ga_data)[i];
423
424 if (p == NULL)
425 // will get the type from the default value
426 type = &t_unknown;
427 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100428 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100429 if (type == NULL)
430 return FAIL;
431 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000432 if (i < fp->uf_args.ga_len
433 && (type->tt_type == VAR_FUNC
434 || type->tt_type == VAR_PARTIAL)
435 && var_wrong_func_name(
436 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
437 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100438 }
439 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100440 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200441
442 if (varargs)
443 {
444 char_u *p;
445
446 // Move the last argument "...name: type" to uf_va_name and
447 // uf_va_type.
448 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
449 [fp->uf_args.ga_len - 1];
450 --fp->uf_args.ga_len;
451 p = ((char_u **)argtypes->ga_data)[len];
452 if (p == NULL)
453 // TODO: get type from default value
454 fp->uf_va_type = &t_list_any;
455 else
456 {
457 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
458 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
459 {
460 semsg(_(e_variable_arguments_type_must_be_list_str),
461 ((char_u **)argtypes->ga_data)[len]);
462 return FAIL;
463 }
464 }
465 if (fp->uf_va_type == NULL)
466 return FAIL;
467 }
468
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100469 return OK;
470}
471
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100472 static int
473parse_return_type(ufunc_T *fp, char_u *ret_type)
474{
475 if (ret_type == NULL)
476 fp->uf_ret_type = &t_void;
477 else
478 {
479 char_u *p = ret_type;
480
481 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
482 if (fp->uf_ret_type == NULL)
483 {
484 fp->uf_ret_type = &t_void;
485 return FAIL;
486 }
487 }
488 return OK;
489}
490
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100491/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200492 * Register function "fp" as using "current_funccal" as its scope.
493 */
494 static int
495register_closure(ufunc_T *fp)
496{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100498 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200499 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200500 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200501 fp->uf_scoped = current_funccal;
502 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200503
Bram Moolenaar58016442016-07-31 18:30:22 +0200504 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
505 return FAIL;
506 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
507 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200508 return OK;
509}
510
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100511 static void
512set_ufunc_name(ufunc_T *fp, char_u *name)
513{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100514 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
515 // actually extends beyond the struct.
516 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100517
518 if (name[0] == K_SPECIAL)
519 {
520 fp->uf_name_exp = alloc(STRLEN(name) + 3);
521 if (fp->uf_name_exp != NULL)
522 {
523 STRCPY(fp->uf_name_exp, "<SNR>");
524 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
525 }
526 }
527}
528
Bram Moolenaar58016442016-07-31 18:30:22 +0200529/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200530 * Get a name for a lambda. Returned in static memory.
531 */
532 char_u *
533get_lambda_name(void)
534{
535 static char_u name[30];
536 static int lambda_no = 0;
537
538 sprintf((char*)name, "<lambda>%d", ++lambda_no);
539 return name;
540}
541
Bram Moolenaar801ab062020-06-25 19:27:56 +0200542#if defined(FEAT_LUA) || defined(PROTO)
543/*
544 * Registers a native C callback which can be called from Vim script.
545 * Returns the name of the Vim script function.
546 */
547 char_u *
548register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
549{
550 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200551 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200552
553 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
554 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200555 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200556
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200557 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200558 fp->uf_refcount = 1;
559 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000560 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200561 fp->uf_calls = 0;
562 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200563 fp->uf_cb = cb;
564 fp->uf_cb_free = cb_free;
565 fp->uf_cb_state = state;
566
567 set_ufunc_name(fp, name);
568 hash_add(&func_hashtab, UF2HIKEY(fp));
569
570 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200571}
572#endif
573
Bram Moolenaar04b12692020-05-04 23:24:44 +0200574/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100575 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100576 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100577 * If "white_error" is not NULL check for correct use of white space and set
578 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100579 * Return NULL if no valid arrow found.
580 */
581 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100582skip_arrow(
583 char_u *start,
584 int equal_arrow,
585 char_u **ret_type,
586 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100587{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100588 char_u *s = start;
589 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100590
591 if (equal_arrow)
592 {
593 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100594 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100595 if (white_error != NULL && !VIM_ISWHITE(s[1]))
596 {
597 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100598 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100599 return NULL;
600 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100601 s = skipwhite(s + 1);
602 *ret_type = s;
603 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100604 if (s == *ret_type)
605 {
606 emsg(_(e_missing_return_type));
607 return NULL;
608 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100609 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100610 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100611 s = skipwhite(s);
612 if (*s != '=')
613 return NULL;
614 ++s;
615 }
616 if (*s != '>')
617 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100618 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
619 || !IS_WHITE_OR_NUL(s[1])))
620 {
621 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100622 semsg(_(e_white_space_required_before_and_after_str_at_str),
623 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100624 return NULL;
625 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100626 return skipwhite(s + 1);
627}
628
629/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100630 * Check if "*cmd" points to a function command and if so advance "*cmd" and
631 * return TRUE.
632 * Otherwise return FALSE;
633 * Do not consider "function(" to be a command.
634 */
635 static int
636is_function_cmd(char_u **cmd)
637{
638 char_u *p = *cmd;
639
640 if (checkforcmd(&p, "function", 2))
641 {
642 if (*p == '(')
643 return FALSE;
644 *cmd = p;
645 return TRUE;
646 }
647 return FALSE;
648}
649
650/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200651 * Called when defining a function: The context may be needed for script
652 * variables declared in a block that is visible now but not when the function
653 * is compiled or called later.
654 */
655 static void
656function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
657{
658 if (cstack != NULL && cstack->cs_idx >= 0)
659 {
660 int count = cstack->cs_idx + 1;
661 int i;
662
663 fp->uf_block_ids = ALLOC_MULT(int, count);
664 if (fp->uf_block_ids != NULL)
665 {
666 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
667 sizeof(int) * count);
668 fp->uf_block_depth = count;
669 }
670
671 // Set flag in each block to indicate a function was defined. This
672 // is used to keep the variable when leaving the block, see
673 // hide_script_var().
674 for (i = 0; i <= cstack->cs_idx; ++i)
675 cstack->cs_flags[i] |= CSF_FUNC_DEF;
676 }
677}
678
679/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100680 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200681 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100682 * "newlines" must already have been initialized.
683 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
684 */
685 static int
686get_function_body(
687 exarg_T *eap,
688 garray_T *newlines,
689 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000690 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100691{
692 linenr_T sourcing_lnum_top = SOURCING_LNUM;
693 linenr_T sourcing_lnum_off;
694 int saved_wait_return = need_wait_return;
695 char_u *line_arg = line_arg_in;
696 int vim9_function = eap->cmdidx == CMD_def
697 || eap->cmdidx == CMD_block;
698#define MAX_FUNC_NESTING 50
699 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200700 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100701 int nesting = 0;
702 getline_opt_T getline_options;
703 int indent = 2;
704 char_u *skip_until = NULL;
705 int ret = FAIL;
706 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200707 int heredoc_concat_len = 0;
708 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100709 char_u *heredoc_trimmed = NULL;
710
Bram Moolenaar20677332021-06-06 17:02:53 +0200711 ga_init2(&heredoc_ga, 1, 500);
712
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100713 // Detect having skipped over comment lines to find the return
714 // type. Add NULL lines to keep the line count correct.
715 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
716 if (SOURCING_LNUM < sourcing_lnum_off)
717 {
718 sourcing_lnum_off -= SOURCING_LNUM;
719 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
720 goto theend;
721 while (sourcing_lnum_off-- > 0)
722 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
723 }
724
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200725 nesting_def[0] = vim9_function;
726 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100727 getline_options = vim9_function
728 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
729 for (;;)
730 {
731 char_u *theline;
732 char_u *p;
733 char_u *arg;
734
735 if (KeyTyped)
736 {
737 msg_scroll = TRUE;
738 saved_wait_return = FALSE;
739 }
740 need_wait_return = FALSE;
741
742 if (line_arg != NULL)
743 {
744 // Use eap->arg, split up in parts by line breaks.
745 theline = line_arg;
746 p = vim_strchr(theline, '\n');
747 if (p == NULL)
748 line_arg += STRLEN(line_arg);
749 else
750 {
751 *p = NUL;
752 line_arg = p + 1;
753 }
754 }
755 else
756 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000757 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100758 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100759 }
760 if (KeyTyped)
761 lines_left = Rows - 1;
762 if (theline == NULL)
763 {
764 // Use the start of the function for the line number.
765 SOURCING_LNUM = sourcing_lnum_top;
766 if (skip_until != NULL)
767 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200768 else if (nesting_inline[nesting])
769 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100770 else if (eap->cmdidx == CMD_def)
771 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100772 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000773 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100774 goto theend;
775 }
776
777 // Detect line continuation: SOURCING_LNUM increased more than one.
778 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
779 if (SOURCING_LNUM < sourcing_lnum_off)
780 sourcing_lnum_off -= SOURCING_LNUM;
781 else
782 sourcing_lnum_off = 0;
783
784 if (skip_until != NULL)
785 {
786 // Don't check for ":endfunc"/":enddef" between
787 // * ":append" and "."
788 // * ":python <<EOF" and "EOF"
789 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
790 if (heredoc_trimmed == NULL
791 || (is_heredoc && skipwhite(theline) == theline)
792 || STRNCMP(theline, heredoc_trimmed,
793 STRLEN(heredoc_trimmed)) == 0)
794 {
795 if (heredoc_trimmed == NULL)
796 p = theline;
797 else if (is_heredoc)
798 p = skipwhite(theline) == theline
799 ? theline : theline + STRLEN(heredoc_trimmed);
800 else
801 p = theline + STRLEN(heredoc_trimmed);
802 if (STRCMP(p, skip_until) == 0)
803 {
804 VIM_CLEAR(skip_until);
805 VIM_CLEAR(heredoc_trimmed);
806 getline_options = vim9_function
807 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
808 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200809
810 if (heredoc_concat_len > 0)
811 {
812 // Replace the starting line with all the concatenated
813 // lines.
814 ga_concat(&heredoc_ga, theline);
815 vim_free(((char_u **)(newlines->ga_data))[
816 heredoc_concat_len - 1]);
817 ((char_u **)(newlines->ga_data))[
818 heredoc_concat_len - 1] = heredoc_ga.ga_data;
819 ga_init(&heredoc_ga);
820 heredoc_concat_len = 0;
821 theline += STRLEN(theline); // skip the "EOF"
822 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100823 }
824 }
825 }
826 else
827 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200828 int c;
829 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000830 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100831
832 // skip ':' and blanks
833 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
834 ;
835
836 // Check for "endfunction", "enddef" or "}".
837 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000838 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200839 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100840 ? *p == '}'
841 : (checkforcmd(&p, nesting_def[nesting]
842 ? "enddef" : "endfunction", 4)
843 && *p != ':'))
844 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000845 if (!nesting_inline[nesting] && nesting_def[nesting]
846 && p < cmd + 6)
847 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100848 if (nesting-- == 0)
849 {
850 char_u *nextcmd = NULL;
851
852 if (*p == '|' || *p == '}')
853 nextcmd = p + 1;
854 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
855 nextcmd = line_arg;
856 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100857 && (vim9_function || p_verbose > 0))
858 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200859 SOURCING_LNUM = sourcing_lnum_top
860 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100861 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000862 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100863 else
864 give_warning2((char_u *)
865 _("W22: Text found after :endfunction: %s"),
866 p, TRUE);
867 }
868 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100869 {
870 // Another command follows. If the line came from "eap"
871 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000872 // change "eap->cmdlinep" to point to the last fetched
873 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100874 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000875 if (lines_to_free->ga_len > 0
876 && *eap->cmdlinep !=
877 ((char_u **)lines_to_free->ga_data)
878 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100879 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000880 // *cmdlinep will be freed later, thus remove the
881 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100882 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000883 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
884 [lines_to_free->ga_len - 1];
885 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100886 }
887 }
888 break;
889 }
890 }
891
892 // Check for mismatched "endfunc" or "enddef".
893 // We don't check for "def" inside "func" thus we also can't check
894 // for "enddef".
895 // We continue to find the end of the function, although we might
896 // not find it.
897 else if (nesting_def[nesting])
898 {
899 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
900 emsg(_(e_mismatched_endfunction));
901 }
902 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
903 emsg(_(e_mismatched_enddef));
904
905 // Increase indent inside "if", "while", "for" and "try", decrease
906 // at "end".
907 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
908 indent -= 2;
909 else if (STRNCMP(p, "if", 2) == 0
910 || STRNCMP(p, "wh", 2) == 0
911 || STRNCMP(p, "for", 3) == 0
912 || STRNCMP(p, "try", 3) == 0)
913 indent += 2;
914
915 // Check for defining a function inside this function.
916 // Only recognize "def" inside "def", not inside "function",
917 // For backwards compatibility, see Test_function_python().
918 c = *p;
919 if (is_function_cmd(&p)
920 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
921 {
922 if (*p == '!')
923 p = skipwhite(p + 1);
924 p += eval_fname_script(p);
925 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
926 NULL, NULL));
927 if (*skipwhite(p) == '(')
928 {
929 if (nesting == MAX_FUNC_NESTING - 1)
930 emsg(_(e_function_nesting_too_deep));
931 else
932 {
933 ++nesting;
934 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200935 nesting_inline[nesting] = FALSE;
936 indent += 2;
937 }
938 }
939 }
940
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200941 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200942 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200943 // Not a comment line: check for nested inline function.
944 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200945 while (end > p && VIM_ISWHITE(*end))
946 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200947 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200948 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200949 int is_block;
950
951 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200952 --end;
953 while (end > p && VIM_ISWHITE(*end))
954 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200955 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
956 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200957 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200958 char_u *s = p;
959
960 // check for line starting with "au" for :autocmd or
961 // "com" for :command, these can use a {} block
962 is_block = checkforcmd_noparen(&s, "autocmd", 2)
963 || checkforcmd_noparen(&s, "command", 3);
964 }
965
966 if (is_block)
967 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200968 if (nesting == MAX_FUNC_NESTING - 1)
969 emsg(_(e_function_nesting_too_deep));
970 else
971 {
972 ++nesting;
973 nesting_def[nesting] = TRUE;
974 nesting_inline[nesting] = TRUE;
975 indent += 2;
976 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100977 }
978 }
979 }
980
981 // Check for ":append", ":change", ":insert". Not for :def.
982 p = skip_range(p, FALSE, NULL);
983 if (!vim9_function
984 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
985 || (p[0] == 'c'
986 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
987 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
988 && (STRNCMP(&p[3], "nge", 3) != 0
989 || !ASCII_ISALPHA(p[6])))))))
990 || (p[0] == 'i'
991 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
992 && (!ASCII_ISALPHA(p[2])
993 || (p[2] == 's'
994 && (!ASCII_ISALPHA(p[3])
995 || p[3] == 'e'))))))))
996 skip_until = vim_strsave((char_u *)".");
997
998 // Check for ":python <<EOF", ":tcl <<EOF", etc.
999 arg = skipwhite(skiptowhite(p));
1000 if (arg[0] == '<' && arg[1] =='<'
1001 && ((p[0] == 'p' && p[1] == 'y'
1002 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1003 || ((p[2] == '3' || p[2] == 'x')
1004 && !ASCII_ISALPHA(p[3]))))
1005 || (p[0] == 'p' && p[1] == 'e'
1006 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1007 || (p[0] == 't' && p[1] == 'c'
1008 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1009 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1010 && !ASCII_ISALPHA(p[3]))
1011 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1012 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1013 || (p[0] == 'm' && p[1] == 'z'
1014 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1015 ))
1016 {
1017 // ":python <<" continues until a dot, like ":append"
1018 p = skipwhite(arg + 2);
1019 if (STRNCMP(p, "trim", 4) == 0)
1020 {
1021 // Ignore leading white space.
1022 p = skipwhite(p + 4);
1023 heredoc_trimmed = vim_strnsave(theline,
1024 skipwhite(theline) - theline);
1025 }
1026 if (*p == NUL)
1027 skip_until = vim_strsave((char_u *)".");
1028 else
1029 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1030 getline_options = GETLINE_NONE;
1031 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001032 if (eap->cmdidx == CMD_def)
1033 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001034 }
1035
1036 // Check for ":cmd v =<< [trim] EOF"
1037 // and ":cmd [a, b] =<< [trim] EOF"
1038 // and "lines =<< [trim] EOF" for Vim9
1039 // Where "cmd" can be "let", "var", "final" or "const".
1040 arg = skipwhite(skiptowhite(p));
1041 if (*arg == '[')
1042 arg = vim_strchr(arg, ']');
1043 if (arg != NULL)
1044 {
1045 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1046 && arg[1] == '<' && arg[2] =='<');
1047
1048 if (!found)
1049 // skip over the argument after "cmd"
1050 arg = skipwhite(skiptowhite(arg));
1051 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1052 && (checkforcmd(&p, "let", 2)
1053 || checkforcmd(&p, "var", 3)
1054 || checkforcmd(&p, "final", 5)
1055 || checkforcmd(&p, "const", 5))))
1056 {
1057 p = skipwhite(arg + 3);
1058 if (STRNCMP(p, "trim", 4) == 0)
1059 {
1060 // Ignore leading white space.
1061 p = skipwhite(p + 4);
1062 heredoc_trimmed = vim_strnsave(theline,
1063 skipwhite(theline) - theline);
1064 }
1065 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1066 getline_options = GETLINE_NONE;
1067 is_heredoc = TRUE;
1068 }
1069 }
1070 }
1071
1072 // Add the line to the function.
1073 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1074 goto theend;
1075
Bram Moolenaar20677332021-06-06 17:02:53 +02001076 if (heredoc_concat_len > 0)
1077 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001078 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001079 // to be used for the instruction later.
1080 ga_concat(&heredoc_ga, theline);
1081 ga_concat(&heredoc_ga, (char_u *)"\n");
1082 p = vim_strsave((char_u *)"");
1083 }
1084 else
1085 {
1086 // Copy the line to newly allocated memory. get_one_sourceline()
1087 // allocates 250 bytes per line, this saves 80% on average. The
1088 // cost is an extra alloc/free.
1089 p = vim_strsave(theline);
1090 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001091 if (p == NULL)
1092 goto theend;
1093 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1094
1095 // Add NULL lines for continuation lines, so that the line count is
1096 // equal to the index in the growarray.
1097 while (sourcing_lnum_off-- > 0)
1098 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1099
1100 // Check for end of eap->arg.
1101 if (line_arg != NULL && *line_arg == NUL)
1102 line_arg = NULL;
1103 }
1104
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001105 // Return OK when no error was detected.
1106 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 ret = OK;
1108
1109theend:
1110 vim_free(skip_until);
1111 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001112 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001113 need_wait_return |= saved_wait_return;
1114 return ret;
1115}
1116
1117/*
1118 * Handle the body of a lambda. *arg points to the "{", process statements
1119 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001120 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001121 * When successful "rettv" is set to a funcref.
1122 */
1123 static int
1124lambda_function_body(
1125 char_u **arg,
1126 typval_T *rettv,
1127 evalarg_T *evalarg,
1128 garray_T *newargs,
1129 garray_T *argtypes,
1130 int varargs,
1131 garray_T *default_args,
1132 char_u *ret_type)
1133{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001134 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001135 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001136 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001137 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001138 exarg_T eap;
1139 garray_T newlines;
1140 char_u *cmdline = NULL;
1141 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 partial_T *pt;
1143 char_u *name;
1144 int lnum_save = -1;
1145 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1146
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001147 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1148 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001149 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001150 return FAIL;
1151 }
1152
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001153 CLEAR_FIELD(eap);
1154 eap.cmdidx = CMD_block;
1155 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001156 eap.cmdlinep = &cmdline;
1157 eap.skip = !evaluate;
1158 if (evalarg->eval_cctx != NULL)
1159 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1160 else
1161 {
1162 eap.getline = evalarg->eval_getline;
1163 eap.cookie = evalarg->eval_cookie;
1164 }
1165
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001166 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001167 if (get_function_body(&eap, &newlines, NULL,
1168 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001169 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001170
1171 // When inside a lambda must add the function lines to evalarg.eval_ga.
1172 evalarg->eval_break_count += newlines.ga_len;
1173 if (gap->ga_itemsize > 0)
1174 {
1175 int idx;
1176 char_u *last;
1177 size_t plen;
1178 char_u *pnl;
1179
1180 for (idx = 0; idx < newlines.ga_len; ++idx)
1181 {
1182 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1183
Bram Moolenaarecb66452021-05-18 15:09:18 +02001184 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001185 goto erret;
1186
1187 // Going to concatenate the lines after parsing. For an empty or
1188 // comment line use an empty string.
1189 // Insert NL characters at the start of each line, the string will
1190 // be split again later in .get_lambda_tv().
1191 if (*p == NUL || vim9_comment_start(p))
1192 p = (char_u *)"";
1193 plen = STRLEN(p);
1194 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1195 if (pnl != NULL)
1196 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001197 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1198 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001199 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001200 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001201 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001202 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001203 // more is following after the "}", which was skipped
1204 last = cmdline;
1205 else
1206 // nothing is following the "}"
1207 last = (char_u *)"}";
1208 plen = STRLEN(last);
1209 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1210 if (pnl != NULL)
1211 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001212 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1213 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001214 }
1215
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001216 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001217 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001218 garray_T *tfgap = &evalarg->eval_tofree_ga;
1219
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001220 // Something comes after the "}".
1221 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001222
1223 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001224 if (ga_grow(tfgap, 1) == OK)
1225 {
1226 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1227 evalarg->eval_using_cmdline = TRUE;
1228 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001229 }
1230 else
1231 *arg = (char_u *)"";
1232
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001233 if (!evaluate)
1234 {
1235 ret = OK;
1236 goto erret;
1237 }
1238
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001239 name = get_lambda_name();
1240 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1241 if (ufunc == NULL)
1242 goto erret;
1243 set_ufunc_name(ufunc, name);
1244 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001245 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001246 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001247 ufunc->uf_refcount = 1;
1248 ufunc->uf_args = *newargs;
1249 newargs->ga_data = NULL;
1250 ufunc->uf_def_args = *default_args;
1251 default_args->ga_data = NULL;
1252 ufunc->uf_func_type = &t_func_any;
1253
1254 // error messages are for the first function line
1255 lnum_save = SOURCING_LNUM;
1256 SOURCING_LNUM = sourcing_lnum_top;
1257
1258 // parse argument types
1259 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1260 {
1261 SOURCING_LNUM = lnum_save;
1262 goto erret;
1263 }
1264
1265 // parse the return type, if any
1266 if (parse_return_type(ufunc, ret_type) == FAIL)
1267 goto erret;
1268
1269 pt = ALLOC_CLEAR_ONE(partial_T);
1270 if (pt == NULL)
1271 goto erret;
1272 pt->pt_func = ufunc;
1273 pt->pt_refcount = 1;
1274
1275 ufunc->uf_lines = newlines;
1276 newlines.ga_data = NULL;
1277 if (sandbox)
1278 ufunc->uf_flags |= FC_SANDBOX;
1279 if (!ASCII_ISUPPER(*ufunc->uf_name))
1280 ufunc->uf_flags |= FC_VIM9;
1281 ufunc->uf_script_ctx = current_sctx;
1282 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1283 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1284 set_function_type(ufunc);
1285
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001286 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1287
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001288 rettv->vval.v_partial = pt;
1289 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001290 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001291 ret = OK;
1292
1293erret:
1294 if (lnum_save >= 0)
1295 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001296 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001297 if (newargs != NULL)
1298 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001299 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001300 if (ufunc != NULL)
1301 {
1302 func_clear(ufunc, TRUE);
1303 func_free(ufunc, TRUE);
1304 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001305 return ret;
1306}
1307
1308/*
1309 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001310 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001311 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001312 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1313 */
1314 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001315get_lambda_tv(
1316 char_u **arg,
1317 typval_T *rettv,
1318 int types_optional,
1319 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001320{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001321 int evaluate = evalarg != NULL
1322 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001323 garray_T newargs;
1324 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001325 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001326 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001327 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001328 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001329 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001330 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001331 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001333 char_u *s;
1334 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001335 int *old_eval_lavars = eval_lavars_used;
1336 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001337 char_u *tofree1 = NULL;
1338 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001339 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001340 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001341 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001342 int vim9script = in_vim9script();
Bram Moolenaar65c44152020-12-24 15:14:01 +01001343
Bram Moolenaar4525a572022-02-13 11:57:33 +00001344 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001345 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001346
1347 ga_init(&newargs);
1348 ga_init(&newlines);
1349
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001350 // First, check if this is really a lambda expression. "->" or "=>" must
1351 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001352 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001353 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001354 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001355 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001356 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001357 {
1358 if (types_optional)
1359 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001360 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001362
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001363 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001364 if (evaluate)
1365 pnewargs = &newargs;
1366 else
1367 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001368 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001369 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001370 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001371 &varargs, &default_args,
1372 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001373 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001374 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001375 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001376 {
1377 if (types_optional)
1378 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001379 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001380 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001381 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001382 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001384 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1385 if (ret_type != NULL)
1386 {
1387 ret_type = vim_strsave(ret_type);
1388 tofree2 = ret_type;
1389 }
1390
Bram Moolenaare38eab22019-12-05 21:50:01 +01001391 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001392 if (evaluate)
1393 eval_lavars_used = &eval_lavars;
1394
Bram Moolenaar65c44152020-12-24 15:14:01 +01001395 *arg = skipwhite_and_linebreak(*arg, evalarg);
1396
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001397 // Recognize "{" as the start of a function body.
1398 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001399 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001400 if (evalarg == NULL)
1401 // cannot happen?
1402 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001403 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1404 types_optional ? &argtypes : NULL, varargs,
1405 &default_args, ret_type) == FAIL)
1406 goto errret;
1407 goto theend;
1408 }
1409 if (default_args.ga_len > 0)
1410 {
1411 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001412 goto errret;
1413 }
1414
Bram Moolenaare38eab22019-12-05 21:50:01 +01001415 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001416 start = *arg;
1417 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418 if (ret == FAIL)
1419 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001420 if (evalarg != NULL)
1421 {
1422 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001423 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001424 evalarg->eval_tofree = NULL;
1425 }
1426
Bram Moolenaar65c44152020-12-24 15:14:01 +01001427 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001428 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001429 *arg = skipwhite_and_linebreak(*arg, evalarg);
1430 if (**arg != '}')
1431 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001432 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001433 goto errret;
1434 }
1435 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001436 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001437
1438 if (evaluate)
1439 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001440 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001441 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001442 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001443 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001444 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001445
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001446 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447 if (fp == NULL)
1448 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001449 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001450 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001451 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001452 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001453
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001454 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 if (ga_grow(&newlines, 1) == FAIL)
1456 goto errret;
1457
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001458 // If there are line breaks, we need to split up the string.
1459 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001460 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001461 line_end = end;
1462
1463 // Add "return " before the expression (or the first line).
1464 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001465 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001466 if (p == NULL)
1467 goto errret;
1468 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1469 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001470 vim_strncpy(p + 7, start, line_end - start);
1471
1472 if (line_end != end)
1473 {
1474 // Add more lines, split by line breaks. Thus is used when a
1475 // lambda with { cmds } is encountered.
1476 while (*line_end == '\n')
1477 {
1478 if (ga_grow(&newlines, 1) == FAIL)
1479 goto errret;
1480 start = line_end + 1;
1481 line_end = vim_strchr(start, '\n');
1482 if (line_end == NULL)
1483 line_end = end;
1484 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1485 vim_strnsave(start, line_end - start);
1486 }
1487 }
1488
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001489 if (strstr((char *)p + 7, "a:") == NULL)
1490 // No a: variables are used for sure.
1491 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492
1493 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001494 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001495 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001496 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001497 if (types_optional)
1498 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001499 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001500 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001501 goto errret;
1502 if (ret_type != NULL)
1503 {
1504 fp->uf_ret_type = parse_type(&ret_type,
1505 &fp->uf_type_list, TRUE);
1506 if (fp->uf_ret_type == NULL)
1507 goto errret;
1508 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001509 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001510 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001511 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001512
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001513 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001514 if (current_funccal != NULL && eval_lavars)
1515 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001516 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001517 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001518 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001519 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520
1521#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 if (prof_def_func())
1523 func_do_profile(fp);
1524#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001525 if (sandbox)
1526 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001527 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001528 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001529 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001530 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001532 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001533 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001534
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001535 function_using_block_scopes(fp, evalarg->eval_cstack);
1536
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001537 pt->pt_func = fp;
1538 pt->pt_refcount = 1;
1539 rettv->vval.v_partial = pt;
1540 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001541
1542 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001545theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001546 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001547 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001548 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001549 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001550 vim_free(tofree1);
1551 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001552 if (types_optional)
1553 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001554
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555 return OK;
1556
1557errret:
1558 ga_clear_strings(&newargs);
1559 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001560 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001561 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001562 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001563 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001564 if (fp != NULL)
1565 vim_free(fp->uf_arg_types);
1566 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001567 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001568 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001569 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001570 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001571 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001572 vim_free(tofree1);
1573 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001574 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575 return FAIL;
1576}
1577
1578/*
1579 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1580 * name it contains, otherwise return "name".
1581 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1582 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001583 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1584 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001585 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001586 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587 */
1588 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001589deref_func_name(
1590 char_u *name,
1591 int *lenp,
1592 partial_T **partialp,
1593 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001594 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001595 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001596 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597{
1598 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001599 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001601 char_u *s = NULL;
1602 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001603 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001604
1605 if (partialp != NULL)
1606 *partialp = NULL;
1607
1608 cc = name[*lenp];
1609 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001610
Bram Moolenaar71f21932022-01-07 18:20:55 +00001611 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001613 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001614 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001615 tv = &v->di_tv;
1616 }
1617 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1618 {
1619 imported_T *import;
1620 char_u *p = name;
1621 int len = *lenp;
1622
1623 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001624 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001625 p = name + 2;
1626 len -= 2;
1627 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001628 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001629
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001630 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001631 if (import != NULL)
1632 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001633 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001634 if (new_function)
1635 semsg(_(e_redefining_imported_item_str), name);
1636 else
1637 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001638 name[len] = cc;
1639 *lenp = 0;
1640 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001641 }
1642 }
1643
1644 if (tv != NULL)
1645 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001646 if (found_var != NULL)
1647 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001648 if (tv->v_type == VAR_FUNC)
1649 {
1650 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001651 {
1652 *lenp = 0;
1653 return (char_u *)""; // just in case
1654 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001655 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001656 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001659 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001661 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001662
1663 if (pt == NULL)
1664 {
1665 *lenp = 0;
1666 return (char_u *)""; // just in case
1667 }
1668 if (partialp != NULL)
1669 *partialp = pt;
1670 s = partial_name(pt);
1671 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001673
1674 if (s != NULL)
1675 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001676 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001677 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001678 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001679
1680 if (sv != NULL)
1681 *type = sv->sv_type;
1682 }
1683 return s;
1684 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 }
1686
1687 return name;
1688}
1689
1690/*
1691 * Give an error message with a function name. Handle <SNR> things.
1692 * "ermsg" is to be passed without translation, use N_() instead of _().
1693 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001694 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001695emsg_funcname(char *ermsg, char_u *name)
1696{
Bram Moolenaar54598062022-01-13 12:05:09 +00001697 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001698
Bram Moolenaar54598062022-01-13 12:05:09 +00001699 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001701 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001702 if (p != name)
1703 vim_free(p);
1704}
1705
1706/*
1707 * Allocate a variable for the result of a function.
1708 * Return OK or FAIL.
1709 */
1710 int
1711get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001712 char_u *name, // name of the function
1713 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001715 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001716 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001717 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718{
1719 char_u *argp;
1720 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001721 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1722 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001723 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001724 int evaluate = evalarg == NULL
1725 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726
1727 /*
1728 * Get the arguments.
1729 */
1730 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001731 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1732 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001734 // skip the '(' or ',' and possibly line breaks
1735 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1736
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001737 if (*argp == ')' || *argp == ',' || *argp == NUL)
1738 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001739 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 {
1741 ret = FAIL;
1742 break;
1743 }
1744 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001745 // The comma should come right after the argument, but this wasn't
1746 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001747 if (vim9script)
1748 {
1749 if (*argp != ',' && *skipwhite(argp) == ',')
1750 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001751 if (evaluate)
1752 semsg(_(e_no_white_space_allowed_before_str_str),
1753 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001754 ret = FAIL;
1755 break;
1756 }
1757 }
1758 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001759 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001760 if (*argp != ',')
1761 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001762 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1763 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001764 if (evaluate)
1765 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001766 ret = FAIL;
1767 break;
1768 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001770 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771 if (*argp == ')')
1772 ++argp;
1773 else
1774 ret = FAIL;
1775
1776 if (ret == OK)
1777 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001778 int i = 0;
1779 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780
1781 if (get_vim_var_nr(VV_TESTING))
1782 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001783 // Prepare for calling test_garbagecollect_now(), need to know
1784 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001786 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 for (i = 0; i < argcount; ++i)
1788 if (ga_grow(&funcargs, 1) == OK)
1789 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1790 &argvars[i];
1791 }
1792
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001793 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001794 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001795 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001796 // An error in a builtin function does not return FAIL, but we do
1797 // want to abort further processing if an error was given.
1798 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001799 clear_tv(rettv);
1800 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001801
1802 funcargs.ga_len -= i;
1803 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001804 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805 {
1806 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001807 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001809 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001810 }
1811
1812 while (--argcount >= 0)
1813 clear_tv(&argvars[argcount]);
1814
Bram Moolenaar4525a572022-02-13 11:57:33 +00001815 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001816 *arg = argp;
1817 else
1818 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001819 return ret;
1820}
1821
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822/*
1823 * Return TRUE if "p" starts with "<SID>" or "s:".
1824 * Only works if eval_fname_script() returned non-zero for "p"!
1825 */
1826 static int
1827eval_fname_sid(char_u *p)
1828{
1829 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1830}
1831
1832/*
1833 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1834 * Change <SNR>123_name() to K_SNR 123_name().
1835 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1836 * (slow).
1837 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001838 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001839fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1840{
1841 int llen;
1842 char_u *fname;
1843 int i;
1844
1845 llen = eval_fname_script(name);
1846 if (llen > 0)
1847 {
1848 fname_buf[0] = K_SPECIAL;
1849 fname_buf[1] = KS_EXTRA;
1850 fname_buf[2] = (int)KE_SNR;
1851 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001852 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001854 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001855 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 else
1857 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001858 sprintf((char *)fname_buf + 3, "%ld_",
1859 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001860 i = (int)STRLEN(fname_buf);
1861 }
1862 }
1863 if (i + STRLEN(name + llen) < FLEN_FIXED)
1864 {
1865 STRCPY(fname_buf + i, name + llen);
1866 fname = fname_buf;
1867 }
1868 else
1869 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001870 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001871 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001872 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 else
1874 {
1875 *tofree = fname;
1876 mch_memmove(fname, fname_buf, (size_t)i);
1877 STRCPY(fname + i, name + llen);
1878 }
1879 }
1880 }
1881 else
1882 fname = name;
1883 return fname;
1884}
1885
1886/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001887 * Concatenate the script ID and function name into "<SNR>99_name".
1888 * "buffer" must have size MAX_FUNC_NAME_LEN.
1889 */
1890 void
1891func_name_with_sid(char_u *name, int sid, char_u *buffer)
1892{
1893 // A script-local function is stored as "<SNR>99_name".
1894 buffer[0] = K_SPECIAL;
1895 buffer[1] = KS_EXTRA;
1896 buffer[2] = (int)KE_SNR;
1897 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1898 (long)sid, name);
1899}
1900
1901/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001902 * Find a function "name" in script "sid".
1903 */
1904 static ufunc_T *
1905find_func_with_sid(char_u *name, int sid)
1906{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001907 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001908 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001909
Bram Moolenaarb8822442022-01-11 15:24:05 +00001910 if (!SCRIPT_ID_VALID(sid))
1911 return NULL; // not in a script
1912
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001913 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001914 hi = hash_find(&func_hashtab, buffer);
1915 if (!HASHITEM_EMPTY(hi))
1916 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001917 return NULL;
1918}
1919
1920/*
1921 * Find a function "name" in script "sid" prefixing the autoload prefix.
1922 */
1923 static ufunc_T *
1924find_func_with_prefix(char_u *name, int sid)
1925{
1926 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001927 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001928 scriptitem_T *si;
1929
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001930 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001931 return NULL; // already has the prefix
1932 if (!SCRIPT_ID_VALID(sid))
1933 return NULL; // not in a script
1934 si = SCRIPT_ITEM(sid);
1935 if (si->sn_autoload_prefix != NULL)
1936 {
1937 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1938 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001939 char_u *namep;
1940
1941 // skip a "<SNR>99_" prefix
1942 namep = untrans_function_name(name);
1943 if (namep == NULL)
1944 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001945
1946 // An exported function in an autoload script is stored as
1947 // "dir#path#name".
1948 if (len < sizeof(buffer))
1949 auto_name = buffer;
1950 else
1951 auto_name = alloc(len);
1952 if (auto_name != NULL)
1953 {
1954 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001955 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001956 hi = hash_find(&func_hashtab, auto_name);
1957 if (auto_name != buffer)
1958 vim_free(auto_name);
1959 if (!HASHITEM_EMPTY(hi))
1960 return HI2UF(hi);
1961 }
1962 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001963
1964 return NULL;
1965}
1966
1967/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001968 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001969 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1970 * functions.
1971 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001972 * Return NULL for unknown function.
1973 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001974 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001975find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001976{
1977 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001978 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001979
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001980 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001981 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00001982 // Find script-local function before global one.
1983 if (in_vim9script() && eval_isnamec1(*name)
1984 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001985 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001986 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1987 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001988 if (func != NULL)
1989 return func;
1990 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00001991 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
1992 {
1993 char_u *p = name + 5;
1994 long sid;
1995
1996 // printable "<SNR>123_Name" form
1997 sid = getdigits(&p);
1998 if (*p == '_')
1999 {
2000 func = find_func_with_sid(p + 1, (int)sid);
2001 if (func != NULL)
2002 return func;
2003 }
2004 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002005 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002006
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002007 if ((flags & FFED_NO_GLOBAL) == 0)
2008 {
2009 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002010 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002011 if (!HASHITEM_EMPTY(hi))
2012 return HI2UF(hi);
2013 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002014
Bram Moolenaarb8822442022-01-11 15:24:05 +00002015 // Find autoload function if this is an autoload script.
2016 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2017 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002018}
2019
2020/*
2021 * Find a function by name, return pointer to it in ufuncs.
2022 * "cctx" is passed in a :def function to find imported functions.
2023 * Return NULL for unknown or dead function.
2024 */
2025 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002026find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002028 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002029
2030 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2031 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002032 return NULL;
2033}
2034
2035/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002036 * Return TRUE if "ufunc" is a global function.
2037 */
2038 int
2039func_is_global(ufunc_T *ufunc)
2040{
2041 return ufunc->uf_name[0] != K_SPECIAL;
2042}
2043
2044/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002045 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2046 */
2047 int
2048func_requires_g_prefix(ufunc_T *ufunc)
2049{
2050 return ufunc->uf_name[0] != K_SPECIAL
2051 && (ufunc->uf_flags & FC_LAMBDA) == 0
2052 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2053}
2054
2055/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002056 * Copy the function name of "fp" to buffer "buf".
2057 * "buf" must be able to hold the function name plus three bytes.
2058 * Takes care of script-local function names.
2059 */
2060 static void
2061cat_func_name(char_u *buf, ufunc_T *fp)
2062{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002063 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002064 {
2065 STRCPY(buf, "<SNR>");
2066 STRCAT(buf, fp->uf_name + 3);
2067 }
2068 else
2069 STRCPY(buf, fp->uf_name);
2070}
2071
2072/*
2073 * Add a number variable "name" to dict "dp" with value "nr".
2074 */
2075 static void
2076add_nr_var(
2077 dict_T *dp,
2078 dictitem_T *v,
2079 char *name,
2080 varnumber_T nr)
2081{
2082 STRCPY(v->di_key, name);
2083 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2084 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2085 v->di_tv.v_type = VAR_NUMBER;
2086 v->di_tv.v_lock = VAR_FIXED;
2087 v->di_tv.vval.v_number = nr;
2088}
2089
2090/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002091 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002092 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002093 static void
2094free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002095{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002096 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002097
2098 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2099 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002100 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002101
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002102 // When garbage collecting a funccall_T may be freed before the
2103 // function that references it, clear its uf_scoped field.
2104 // The function may have been redefined and point to another
2105 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002106 if (fp != NULL && fp->uf_scoped == fc)
2107 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002108 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002109 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002111 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002112 vim_free(fc);
2113}
2114
2115/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002116 * Free "fc" and what it contains.
2117 * Can be called only when "fc" is kept beyond the period of it called,
2118 * i.e. after cleanup_function_call(fc).
2119 */
2120 static void
2121free_funccal_contents(funccall_T *fc)
2122{
2123 listitem_T *li;
2124
2125 // Free all l: variables.
2126 vars_clear(&fc->l_vars.dv_hashtab);
2127
2128 // Free all a: variables.
2129 vars_clear(&fc->l_avars.dv_hashtab);
2130
2131 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002132 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002133 clear_tv(&li->li_tv);
2134
2135 free_funccal(fc);
2136}
2137
2138/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002139 * Handle the last part of returning from a function: free the local hashtable.
2140 * Unless it is still in use by a closure.
2141 */
2142 static void
2143cleanup_function_call(funccall_T *fc)
2144{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002145 int may_free_fc = fc->fc_refcount <= 0;
2146 int free_fc = TRUE;
2147
Bram Moolenaar6914c642017-04-01 21:21:30 +02002148 current_funccal = fc->caller;
2149
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002150 // Free all l: variables if not referred.
2151 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2152 vars_clear(&fc->l_vars.dv_hashtab);
2153 else
2154 free_fc = FALSE;
2155
2156 // If the a:000 list and the l: and a: dicts are not referenced and
2157 // there is no closure using it, we can free the funccall_T and what's
2158 // in it.
2159 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2160 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002161 else
2162 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002163 int todo;
2164 hashitem_T *hi;
2165 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002166
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002167 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002168
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002169 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002170 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2171 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2172 {
2173 if (!HASHITEM_EMPTY(hi))
2174 {
2175 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002176 di = HI2DI(hi);
2177 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002178 }
2179 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002180 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002181
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002182 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2183 fc->l_varlist.lv_first = NULL;
2184 else
2185 {
2186 listitem_T *li;
2187
2188 free_fc = FALSE;
2189
2190 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002191 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002192 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002193 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002194
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002195 if (free_fc)
2196 free_funccal(fc);
2197 else
2198 {
2199 static int made_copy = 0;
2200
2201 // "fc" is still in use. This can happen when returning "a:000",
2202 // assigning "l:" to a global variable or defining a closure.
2203 // Link "fc" in the list for garbage collection later.
2204 fc->caller = previous_funccal;
2205 previous_funccal = fc;
2206
2207 if (want_garbage_collect)
2208 // If garbage collector is ready, clear count.
2209 made_copy = 0;
2210 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002211 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002212 // We have made a lot of copies, worth 4 Mbyte. This can happen
2213 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002214 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002215 // too much memory.
2216 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002217 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002218 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002219 }
2220}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002221
2222/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002223 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2224 */
2225 static int
2226numbered_function(char_u *name)
2227{
2228 return isdigit(*name)
2229 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2230}
2231
2232/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002233 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002234 * 1. ordinary names, function defined with :function or :def;
2235 * can start with "<SNR>123_" literally or with K_SPECIAL.
2236 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002237 * For the first we only count the name stored in func_hashtab as a reference,
2238 * using function() does not count as a reference, because the function is
2239 * looked up by name.
2240 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002241 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002242func_name_refcount(char_u *name)
2243{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002244 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002245}
2246
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002247/*
2248 * Unreference "fc": decrement the reference count and free it when it
2249 * becomes zero. "fp" is detached from "fc".
2250 * When "force" is TRUE we are exiting.
2251 */
2252 static void
2253funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2254{
2255 funccall_T **pfc;
2256 int i;
2257
2258 if (fc == NULL)
2259 return;
2260
2261 if (--fc->fc_refcount <= 0 && (force || (
2262 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2263 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2264 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2265 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2266 {
2267 if (fc == *pfc)
2268 {
2269 *pfc = fc->caller;
2270 free_funccal_contents(fc);
2271 return;
2272 }
2273 }
2274 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2275 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2276 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2277}
2278
2279/*
2280 * Remove the function from the function hashtable. If the function was
2281 * deleted while it still has references this was already done.
2282 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2283 */
2284 static int
2285func_remove(ufunc_T *fp)
2286{
2287 hashitem_T *hi;
2288
2289 // Return if it was already virtually deleted.
2290 if (fp->uf_flags & FC_DEAD)
2291 return FALSE;
2292
2293 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2294 if (!HASHITEM_EMPTY(hi))
2295 {
2296 // When there is a def-function index do not actually remove the
2297 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002298 // Do remove it when it's a copy.
2299 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002300 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002301 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002302 return FALSE;
2303 }
2304 hash_remove(&func_hashtab, hi);
2305 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002306 return TRUE;
2307 }
2308 return FALSE;
2309}
2310
2311 static void
2312func_clear_items(ufunc_T *fp)
2313{
2314 ga_clear_strings(&(fp->uf_args));
2315 ga_clear_strings(&(fp->uf_def_args));
2316 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002317 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002318 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002319 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002320 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002321
2322 // Increment the refcount of this function to avoid it being freed
2323 // recursively when the partial is freed.
2324 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002325 partial_unref(fp->uf_partial);
2326 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002327 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002328
2329#ifdef FEAT_LUA
2330 if (fp->uf_cb_free != NULL)
2331 {
2332 fp->uf_cb_free(fp->uf_cb_state);
2333 fp->uf_cb_free = NULL;
2334 }
2335
2336 fp->uf_cb_state = NULL;
2337 fp->uf_cb = NULL;
2338#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002339#ifdef FEAT_PROFILE
2340 VIM_CLEAR(fp->uf_tml_count);
2341 VIM_CLEAR(fp->uf_tml_total);
2342 VIM_CLEAR(fp->uf_tml_self);
2343#endif
2344}
2345
2346/*
2347 * Free all things that a function contains. Does not free the function
2348 * itself, use func_free() for that.
2349 * When "force" is TRUE we are exiting.
2350 */
2351 static void
2352func_clear(ufunc_T *fp, int force)
2353{
2354 if (fp->uf_cleared)
2355 return;
2356 fp->uf_cleared = TRUE;
2357
2358 // clear this function
2359 func_clear_items(fp);
2360 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002361 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002362}
2363
2364/*
2365 * Free a function and remove it from the list of functions. Does not free
2366 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002367 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002368 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002369 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002370 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002371func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002372{
2373 // Only remove it when not done already, otherwise we would remove a newer
2374 // version of the function with the same name.
2375 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2376 func_remove(fp);
2377
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002378 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002379 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002380 if (fp->uf_dfunc_idx > 0)
2381 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002382 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002383 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002384 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002385 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002386 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002387}
2388
2389/*
2390 * Free all things that a function contains and free the function itself.
2391 * When "force" is TRUE we are exiting.
2392 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002393 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002394func_clear_free(ufunc_T *fp, int force)
2395{
2396 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002397 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2398 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002399 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002400 else
2401 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002402}
2403
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002404/*
2405 * Copy already defined function "lambda" to a new function with name "global".
2406 * This is for when a compiled function defines a global function.
2407 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002408 int
2409copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002410{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002411 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002412 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002413
2414 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002415 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002416 semsg(_(e_lambda_function_not_found_str), lambda);
2417 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002418 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002419
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002420 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002421 if (fp != NULL)
2422 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002423 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002424 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002425 return FAIL;
2426 }
2427
2428 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2429 if (fp == NULL)
2430 return FAIL;
2431
2432 fp->uf_varargs = ufunc->uf_varargs;
2433 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2434 fp->uf_def_status = ufunc->uf_def_status;
2435 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2436 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2437 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2438 == FAIL
2439 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2440 goto failed;
2441
2442 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2443 : vim_strsave(ufunc->uf_name_exp);
2444 if (ufunc->uf_arg_types != NULL)
2445 {
2446 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2447 if (fp->uf_arg_types == NULL)
2448 goto failed;
2449 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2450 sizeof(type_T *) * fp->uf_args.ga_len);
2451 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002452 if (ufunc->uf_va_name != NULL)
2453 {
2454 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2455 if (fp->uf_va_name == NULL)
2456 goto failed;
2457 }
2458 fp->uf_ret_type = ufunc->uf_ret_type;
2459
2460 fp->uf_refcount = 1;
2461 STRCPY(fp->uf_name, global);
2462 hash_add(&func_hashtab, UF2HIKEY(fp));
2463
2464 // the referenced dfunc_T is now used one more time
2465 link_def_function(fp);
2466
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002467 // Create a partial to store the context of the function where it was
2468 // instantiated. Only needs to be done once. Do this on the original
2469 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002470 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2471 {
2472 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2473
2474 if (pt == NULL)
2475 goto failed;
2476 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002477 {
2478 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002479 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002480 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002481 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002482 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002483 }
2484
2485 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002486
2487failed:
2488 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002489 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002490}
2491
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002492static int funcdepth = 0;
2493
2494/*
2495 * Increment the function call depth count.
2496 * Return FAIL when going over 'maxfuncdepth'.
2497 * Otherwise return OK, must call funcdepth_decrement() later!
2498 */
2499 int
2500funcdepth_increment(void)
2501{
2502 if (funcdepth >= p_mfd)
2503 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002504 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002505 return FAIL;
2506 }
2507 ++funcdepth;
2508 return OK;
2509}
2510
2511 void
2512funcdepth_decrement(void)
2513{
2514 --funcdepth;
2515}
2516
2517/*
2518 * Get the current function call depth.
2519 */
2520 int
2521funcdepth_get(void)
2522{
2523 return funcdepth;
2524}
2525
2526/*
2527 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002528 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002529 * times as funcdepth_increment().
2530 */
2531 void
2532funcdepth_restore(int depth)
2533{
2534 funcdepth = depth;
2535}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002536
2537/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 * Call a user function.
2539 */
2540 static void
2541call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002542 ufunc_T *fp, // pointer to function
2543 int argcount, // nr of args
2544 typval_T *argvars, // arguments
2545 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002546 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002547 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002549 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002550 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002551 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552 funccall_T *fc;
2553 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002554 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002556 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557 int i;
2558 int ai;
2559 int islambda = FALSE;
2560 char_u numbuf[NUMBUFLEN];
2561 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002562 typval_T *tv_to_free[MAX_FUNC_ARGS];
2563 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002565 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002567 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002568
Bram Moolenaarb2049902021-01-24 12:53:53 +01002569#ifdef FEAT_PROFILE
2570 CLEAR_FIELD(profile_info);
2571#endif
2572
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002573 // If depth of calling is getting too high, don't execute the function.
2574 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576 rettv->v_type = VAR_NUMBER;
2577 rettv->vval.v_number = -1;
2578 return;
2579 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002580
Bram Moolenaare38eab22019-12-05 21:50:01 +01002581 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002582
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002583 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002584 if (fc == NULL)
2585 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586 fc->caller = current_funccal;
2587 current_funccal = fc;
2588 fc->func = fp;
2589 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002591 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002592 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2593 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002594 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002595 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002596 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002597
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002598 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002599 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002600#ifdef FEAT_PROFILE
2601 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2602#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002603 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002604#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002605 if (do_profiling == PROF_YES)
2606 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002607#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002608 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002609 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002610 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002611#ifdef FEAT_PROFILE
2612 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002613 || (caller != NULL && caller->uf_profiling)))
2614 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002615#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002616 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002617 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002618 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002619 return;
2620 }
2621
Bram Moolenaar38453522021-11-28 22:00:12 +00002622 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623
2624 /*
2625 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2626 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2627 * each argument variable and saves a lot of time.
2628 */
2629 /*
2630 * Init l: variables.
2631 */
2632 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2633 if (selfdict != NULL)
2634 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002635 // Set l:self to "selfdict". Use "name" to avoid a warning from
2636 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 v = &fc->fixvar[fixvar_idx++].var;
2638 name = v->di_key;
2639 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002640 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002641 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2642 v->di_tv.v_type = VAR_DICT;
2643 v->di_tv.v_lock = 0;
2644 v->di_tv.vval.v_dict = selfdict;
2645 ++selfdict->dv_refcount;
2646 }
2647
2648 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002649 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002650 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 * Set a:000 to a list with room for the "..." arguments.
2652 */
2653 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002654 if ((fp->uf_flags & FC_NOARGS) == 0)
2655 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002656 (varnumber_T)(argcount >= fp->uf_args.ga_len
2657 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002658 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002659 if ((fp->uf_flags & FC_NOARGS) == 0)
2660 {
2661 // Use "name" to avoid a warning from some compiler that checks the
2662 // destination size.
2663 v = &fc->fixvar[fixvar_idx++].var;
2664 name = v->di_key;
2665 STRCPY(name, "000");
2666 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2667 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2668 v->di_tv.v_type = VAR_LIST;
2669 v->di_tv.v_lock = VAR_FIXED;
2670 v->di_tv.vval.v_list = &fc->l_varlist;
2671 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002672 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2674 fc->l_varlist.lv_lock = VAR_FIXED;
2675
2676 /*
2677 * Set a:firstline to "firstline" and a:lastline to "lastline".
2678 * Set a:name to named arguments.
2679 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002680 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002682 if ((fp->uf_flags & FC_NOARGS) == 0)
2683 {
2684 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002685 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002686 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002687 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002688 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002689 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 {
2691 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002692 typval_T def_rettv;
2693 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694
2695 ai = i - fp->uf_args.ga_len;
2696 if (ai < 0)
2697 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002698 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 name = FUNCARG(fp, i);
2700 if (islambda)
2701 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002702
2703 // evaluate named argument default expression
2704 isdefault = ai + fp->uf_def_args.ga_len >= 0
2705 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2706 && argvars[i].vval.v_number == VVAL_NONE));
2707 if (isdefault)
2708 {
2709 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002710
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002711 def_rettv.v_type = VAR_NUMBER;
2712 def_rettv.vval.v_number = -1;
2713
2714 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2715 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002716 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002717 {
2718 default_arg_err = 1;
2719 break;
2720 }
2721 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722 }
2723 else
2724 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002725 if ((fp->uf_flags & FC_NOARGS) != 0)
2726 // Bail out if no a: arguments used (in lambda).
2727 break;
2728
Bram Moolenaare38eab22019-12-05 21:50:01 +01002729 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 sprintf((char *)numbuf, "%d", ai + 1);
2731 name = numbuf;
2732 }
2733 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2734 {
2735 v = &fc->fixvar[fixvar_idx++].var;
2736 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002737 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002738 }
2739 else
2740 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002741 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 if (v == NULL)
2743 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002744 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002745 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002747 // Note: the values are copied directly to avoid alloc/free.
2748 // "argvars" must have VAR_FIXED for v_lock.
2749 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 v->di_tv.v_lock = VAR_FIXED;
2751
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002752 if (isdefault)
2753 // Need to free this later, no matter where it's stored.
2754 tv_to_free[tv_to_free_len++] = &v->di_tv;
2755
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 if (addlocal)
2757 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002758 // Named arguments should be accessed without the "a:" prefix in
2759 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002760 copy_tv(&v->di_tv, &v->di_tv);
2761 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002763 else
2764 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765
2766 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2767 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002768 listitem_T *li = &fc->l_listitems[ai];
2769
2770 li->li_tv = argvars[i];
2771 li->li_tv.v_lock = VAR_FIXED;
2772 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773 }
2774 }
2775
Bram Moolenaare38eab22019-12-05 21:50:01 +01002776 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002778
2779 if (fp->uf_flags & FC_SANDBOX)
2780 {
2781 using_sandbox = TRUE;
2782 ++sandbox;
2783 }
2784
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002785 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002786 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002787 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002789 ++no_wait_return;
2790 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002792 smsg(_("calling %s"), SOURCING_NAME);
2793 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002795 char_u buf[MSG_BUF_LEN];
2796 char_u numbuf2[NUMBUFLEN];
2797 char_u *tofree;
2798 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002800 msg_puts("(");
2801 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002803 if (i > 0)
2804 msg_puts(", ");
2805 if (argvars[i].v_type == VAR_NUMBER)
2806 msg_outnum((long)argvars[i].vval.v_number);
2807 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002808 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002809 // Do not want errors such as E724 here.
2810 ++emsg_off;
2811 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2812 --emsg_off;
2813 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002815 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002817 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2818 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002820 msg_puts((char *)s);
2821 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822 }
2823 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002825 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002827 msg_puts("\n"); // don't overwrite this either
2828
2829 verbose_leave_scroll();
2830 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831 }
2832#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002833 if (do_profiling == PROF_YES)
2834 profile_may_start_func(&profile_info, fp,
2835 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836#endif
2837
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002838 // "legacy" does not apply to commands in the function
2839 sticky_cmdmod_flags = 0;
2840
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002841 save_current_sctx = current_sctx;
2842 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 save_did_emsg = did_emsg;
2844 did_emsg = FALSE;
2845
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002846 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2847 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002848 else if (islambda)
2849 {
2850 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2851
2852 // A Lambda always has the command "return {expr}". It is much faster
2853 // to evaluate {expr} directly.
2854 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002855 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002856 --ex_nesting_level;
2857 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002858 else
2859 // call do_cmdline() to execute the lines
2860 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2862
2863 --RedrawingDisabled;
2864
Bram Moolenaare38eab22019-12-05 21:50:01 +01002865 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2867 {
2868 clear_tv(rettv);
2869 rettv->v_type = VAR_NUMBER;
2870 rettv->vval.v_number = -1;
2871 }
2872
2873#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002874 if (do_profiling == PROF_YES)
2875 {
2876 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2877
2878 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2879 profile_may_end_func(&profile_info, fp, caller);
2880 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881#endif
2882
Bram Moolenaare38eab22019-12-05 21:50:01 +01002883 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884 if (p_verbose >= 12)
2885 {
2886 ++no_wait_return;
2887 verbose_enter_scroll();
2888
2889 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002890 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002891 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002892 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 (long)fc->rettv->vval.v_number);
2894 else
2895 {
2896 char_u buf[MSG_BUF_LEN];
2897 char_u numbuf2[NUMBUFLEN];
2898 char_u *tofree;
2899 char_u *s;
2900
Bram Moolenaare38eab22019-12-05 21:50:01 +01002901 // The value may be very long. Skip the middle part, so that we
2902 // have some idea how it starts and ends. smsg() would always
2903 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002904 ++emsg_off;
2905 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2906 --emsg_off;
2907 if (s != NULL)
2908 {
2909 if (vim_strsize(s) > MSG_BUF_CLEN)
2910 {
2911 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2912 s = buf;
2913 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002914 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 vim_free(tofree);
2916 }
2917 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002918 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002919
2920 verbose_leave_scroll();
2921 --no_wait_return;
2922 }
2923
Bram Moolenaare31ee862020-01-07 20:59:34 +01002924 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002925 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002926 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927#ifdef FEAT_PROFILE
2928 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002929 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002931 if (using_sandbox)
2932 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002933 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002934
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002935 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936 {
2937 ++no_wait_return;
2938 verbose_enter_scroll();
2939
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002940 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002941 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002942
2943 verbose_leave_scroll();
2944 --no_wait_return;
2945 }
2946
2947 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002948 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002949 for (i = 0; i < tv_to_free_len; ++i)
2950 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002951 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952}
2953
2954/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002955 * Check the argument count for user function "fp".
2956 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2957 */
2958 int
2959check_user_func_argcount(ufunc_T *fp, int argcount)
2960{
2961 int regular_args = fp->uf_args.ga_len;
2962
2963 if (argcount < regular_args - fp->uf_def_args.ga_len)
2964 return FCERR_TOOFEW;
2965 else if (!has_varargs(fp) && argcount > regular_args)
2966 return FCERR_TOOMANY;
2967 return FCERR_UNKNOWN;
2968}
2969
2970/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002971 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002972 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002973 int
2974call_user_func_check(
2975 ufunc_T *fp,
2976 int argcount,
2977 typval_T *argvars,
2978 typval_T *rettv,
2979 funcexe_T *funcexe,
2980 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002981{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002982 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002983
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002984 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2985 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002986 error = check_user_func_argcount(fp, argcount);
2987 if (error != FCERR_UNKNOWN)
2988 return error;
2989 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002990 error = FCERR_DICT;
2991 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002992 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002993 int did_save_redo = FALSE;
2994 save_redo_T save_redo;
2995
2996 /*
2997 * Call the user function.
2998 * Save and restore search patterns, script variables and
2999 * redo buffer.
3000 */
3001 save_search_patterns();
3002 if (!ins_compl_active())
3003 {
3004 saveRedobuff(&save_redo);
3005 did_save_redo = TRUE;
3006 }
3007 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003008 call_user_func(fp, argcount, argvars, rettv, funcexe,
3009 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003010 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3011 // Function was unreferenced while being used, free it now.
3012 func_clear_free(fp, FALSE);
3013 if (did_save_redo)
3014 restoreRedobuff(&save_redo);
3015 restore_search_patterns();
3016 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003017 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003018 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003019}
3020
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003021static funccal_entry_T *funccal_stack = NULL;
3022
3023/*
3024 * Save the current function call pointer, and set it to NULL.
3025 * Used when executing autocommands and for ":source".
3026 */
3027 void
3028save_funccal(funccal_entry_T *entry)
3029{
3030 entry->top_funccal = current_funccal;
3031 entry->next = funccal_stack;
3032 funccal_stack = entry;
3033 current_funccal = NULL;
3034}
3035
3036 void
3037restore_funccal(void)
3038{
3039 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003040 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003041 else
3042 {
3043 current_funccal = funccal_stack->top_funccal;
3044 funccal_stack = funccal_stack->next;
3045 }
3046}
3047
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003048 funccall_T *
3049get_current_funccal(void)
3050{
3051 return current_funccal;
3052}
3053
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003054/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003055 * Return TRUE when currently at the script level:
3056 * - not in a function
3057 * - not executing an autocommand
3058 * Note that when an autocommand sources a script the result is FALSE;
3059 */
3060 int
3061at_script_level(void)
3062{
3063 return current_funccal == NULL && autocmd_match == NULL;
3064}
3065
3066/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003067 * Mark all functions of script "sid" as deleted.
3068 */
3069 void
3070delete_script_functions(int sid)
3071{
3072 hashitem_T *hi;
3073 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003074 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003075 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003076 size_t len;
3077
3078 buf[0] = K_SPECIAL;
3079 buf[1] = KS_EXTRA;
3080 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003081 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003082 len = STRLEN(buf);
3083
Bram Moolenaarce658352020-07-31 23:47:12 +02003084 while (todo > 0)
3085 {
3086 todo = func_hashtab.ht_used;
3087 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3088 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003089 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003090 fp = HI2UF(hi);
3091 if (STRNCMP(fp->uf_name, buf, len) == 0)
3092 {
3093 int changed = func_hashtab.ht_changed;
3094
3095 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003096
3097 if (fp->uf_calls > 0)
3098 {
3099 // Function is executing, don't free it but do remove
3100 // it from the hashtable.
3101 if (func_remove(fp))
3102 fp->uf_refcount--;
3103 }
3104 else
3105 {
3106 func_clear(fp, TRUE);
3107 // When clearing a function another function can be
3108 // cleared as a side effect. When that happens start
3109 // over.
3110 if (changed != func_hashtab.ht_changed)
3111 break;
3112 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003113 }
3114 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003115 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003116 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003117}
3118
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119#if defined(EXITFREE) || defined(PROTO)
3120 void
3121free_all_functions(void)
3122{
3123 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003124 ufunc_T *fp;
3125 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003126 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003127 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128
Bram Moolenaare38eab22019-12-05 21:50:01 +01003129 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003130 while (current_funccal != NULL)
3131 {
3132 clear_tv(current_funccal->rettv);
3133 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003134 if (current_funccal == NULL && funccal_stack != NULL)
3135 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003136 }
3137
Bram Moolenaare38eab22019-12-05 21:50:01 +01003138 // First clear what the functions contain. Since this may lower the
3139 // reference count of a function, it may also free a function and change
3140 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003141 while (todo > 0)
3142 {
3143 todo = func_hashtab.ht_used;
3144 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3145 if (!HASHITEM_EMPTY(hi))
3146 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003147 // clear the def function index now
3148 fp = HI2UF(hi);
3149 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003150 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003151
Bram Moolenaare38eab22019-12-05 21:50:01 +01003152 // Only free functions that are not refcounted, those are
3153 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003154 if (func_name_refcount(fp->uf_name))
3155 ++skipped;
3156 else
3157 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003158 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003159 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003160 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003161 {
3162 skipped = 0;
3163 break;
3164 }
3165 }
3166 --todo;
3167 }
3168 }
3169
Bram Moolenaare38eab22019-12-05 21:50:01 +01003170 // Now actually free the functions. Need to start all over every time,
3171 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003172 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003173 while (func_hashtab.ht_used > skipped)
3174 {
3175 todo = func_hashtab.ht_used;
3176 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 if (!HASHITEM_EMPTY(hi))
3178 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003179 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003180 // Only free functions that are not refcounted, those are
3181 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003182 fp = HI2UF(hi);
3183 if (func_name_refcount(fp->uf_name))
3184 ++skipped;
3185 else
3186 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003187 if (func_free(fp, FALSE) == OK)
3188 {
3189 skipped = 0;
3190 break;
3191 }
3192 // did not actually free it
3193 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003194 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003196 }
3197 if (skipped == 0)
3198 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003199
3200 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201}
3202#endif
3203
3204/*
3205 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003206 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3207 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003208 * "len" is the length of "name", or -1 for NUL terminated.
3209 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003210 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211builtin_function(char_u *name, int len)
3212{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003213 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214
Bram Moolenaara26b9702020-04-18 19:53:28 +02003215 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003217 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3218 {
3219 if (name[i] == AUTOLOAD_CHAR)
3220 return FALSE;
3221 if (!eval_isnamec(name[i]))
3222 {
3223 // "name.something" is not a builtin function
3224 if (name[i] == '.')
3225 return FALSE;
3226 break;
3227 }
3228 }
3229 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230}
3231
3232 int
3233func_call(
3234 char_u *name,
3235 typval_T *args,
3236 partial_T *partial,
3237 dict_T *selfdict,
3238 typval_T *rettv)
3239{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003240 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 listitem_T *item;
3242 typval_T argv[MAX_FUNC_ARGS + 1];
3243 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244 int r = 0;
3245
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003246 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003247 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 {
3249 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3250 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003251 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 break;
3253 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003254 // Make a copy of each argument. This is needed to be able to set
3255 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003256 copy_tv(&item->li_tv, &argv[argc++]);
3257 }
3258
3259 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003260 {
3261 funcexe_T funcexe;
3262
Bram Moolenaara80faa82020-04-12 19:37:17 +02003263 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003264 funcexe.fe_firstline = curwin->w_cursor.lnum;
3265 funcexe.fe_lastline = curwin->w_cursor.lnum;
3266 funcexe.fe_evaluate = TRUE;
3267 funcexe.fe_partial = partial;
3268 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003269 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3270 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271
Bram Moolenaare38eab22019-12-05 21:50:01 +01003272 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 while (argc > 0)
3274 clear_tv(&argv[--argc]);
3275
3276 return r;
3277}
3278
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003279static int callback_depth = 0;
3280
3281 int
3282get_callback_depth(void)
3283{
3284 return callback_depth;
3285}
3286
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003288 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003289 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003290 */
3291 int
3292call_callback(
3293 callback_T *callback,
3294 int len, // length of "name" or -1 to use strlen()
3295 typval_T *rettv, // return value goes here
3296 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003297 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003298 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003299{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003300 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003301 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003302
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003303 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3304 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003305 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003306 funcexe.fe_evaluate = TRUE;
3307 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003308 ++callback_depth;
3309 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3310 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003311
3312 // When a :def function was called that uses :try an error would be turned
3313 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003314 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003315 {
3316 need_rethrow = FALSE;
3317 handle_did_throw();
3318 }
3319
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003320 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003321}
3322
3323/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003324 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003325 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003326 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3327 */
3328 varnumber_T
3329call_callback_retnr(
3330 callback_T *callback,
3331 int argcount, // number of "argvars"
3332 typval_T *argvars) // vars for arguments, must have "argcount"
3333 // PLUS ONE elements!
3334{
3335 typval_T rettv;
3336 varnumber_T retval;
3337
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003338 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003339 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003340
3341 retval = tv_get_number_chk(&rettv, NULL);
3342 clear_tv(&rettv);
3343 return retval;
3344}
3345
3346/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003347 * Give an error message for the result of a function.
3348 * Nothing if "error" is FCERR_NONE.
3349 */
3350 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003351user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003352{
3353 switch (error)
3354 {
3355 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003356 if (funcexe->fe_found_var)
3357 semsg(_(e_not_callable_type_str), name);
3358 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003359 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003360 break;
3361 case FCERR_NOTMETHOD:
3362 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003363 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003364 break;
3365 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003366 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003367 break;
3368 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003369 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003370 break;
3371 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003372 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003373 break;
3374 case FCERR_SCRIPT:
3375 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003376 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003377 break;
3378 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003379 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3380 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003381 break;
3382 }
3383}
3384
3385/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003387 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 * Return FAIL when the function can't be called, OK otherwise.
3389 * Also returns OK when an error was encountered while executing the function.
3390 */
3391 int
3392call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003393 char_u *funcname, // name of the function
3394 int len, // length of "name" or -1 to use strlen()
3395 typval_T *rettv, // return value goes here
3396 int argcount_in, // number of "argvars"
3397 typval_T *argvars_in, // vars for arguments, must have "argcount"
3398 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003399 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400{
3401 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003402 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003404 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405 char_u fname_buf[FLEN_FIXED + 1];
3406 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003407 char_u *fname = NULL;
3408 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 int argcount = argcount_in;
3410 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003411 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003412 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003413 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003415 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003416 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003417 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003418 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003420 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3421 // even when call_func() returns FAIL.
3422 rettv->v_type = VAR_UNKNOWN;
3423
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003424 if (partial != NULL)
3425 fp = partial->pt_func;
3426 if (fp == NULL)
3427 {
3428 // Make a copy of the name, if it comes from a funcref variable it
3429 // could be changed or deleted in the called function.
3430 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3431 if (name == NULL)
3432 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003434 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3435 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003437 if (funcexe->fe_doesrange != NULL)
3438 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439
3440 if (partial != NULL)
3441 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003442 // When the function has a partial with a dict and there is a dict
3443 // argument, use the dict argument. That is backwards compatible.
3444 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003445 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003446 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003447 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 {
3449 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003450 {
3451 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3452 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003453 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003454 goto theend;
3455 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003457 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 for (i = 0; i < argcount_in; ++i)
3459 argv[i + argv_clear] = argvars_in[i];
3460 argvars = argv;
3461 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003462
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003463 if (funcexe->fe_check_type != NULL
3464 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003465 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003466 // Now funcexe->fe_check_type is missing the added arguments,
3467 // make a copy of the type with the correction.
3468 check_type = *funcexe->fe_check_type;
3469 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003470 check_type.tt_args = check_type_args;
3471 CLEAR_FIELD(check_type_args);
3472 for (i = 0; i < check_type.tt_argcount; ++i)
3473 check_type_args[i + partial->pt_argc] =
3474 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003475 check_type.tt_argcount += partial->pt_argc;
3476 check_type.tt_min_argcount += partial->pt_argc;
3477 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478 }
3479 }
3480
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003481 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3482 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003483 {
3484 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003485 if (check_argument_types(funcexe->fe_check_type,
3486 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003487 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003488 error = FCERR_OTHER;
3489 }
3490
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003491 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492 {
3493 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003494 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003495
Bram Moolenaar333894b2020-08-01 18:53:07 +02003496 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003497 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003498 {
3499 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003500 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003501 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502
Bram Moolenaare38eab22019-12-05 21:50:01 +01003503 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003505 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003506
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003507 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508 {
3509 /*
3510 * User defined function.
3511 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003512 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003513 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003514 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003515 if (fp != NULL && !is_global && in_vim9script()
3516 && func_requires_g_prefix(fp))
3517 // In Vim9 script g: is required to find a global
3518 // non-autoload function.
3519 fp = NULL;
3520 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003521
Bram Moolenaare38eab22019-12-05 21:50:01 +01003522 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 if (fp == NULL
3524 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003525 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 && !aborting())
3527 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003528 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003529 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003531 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3533 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003534 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003535 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003537 if (fp == NULL)
3538 {
3539 char_u *p = untrans_function_name(rfname);
3540
3541 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003542 // Don't do this if the name starts with "s:".
3543 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003544 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003547 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003548 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003549#ifdef FEAT_LUA
3550 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3551 {
3552 cfunc_T cb = fp->uf_cb;
3553
3554 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3555 }
3556#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003557 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003559 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003560 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003561 argcount = funcexe->fe_argv_func(argcount, argvars,
3562 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003563
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003564 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003565 {
3566 // Method call: base->Method()
3567 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003568 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003569 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003570 argvars = argv;
3571 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003572 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003573
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003574 error = call_user_func_check(fp, argcount, argvars, rettv,
3575 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 }
3577 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003578 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003579 {
3580 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003581 * expr->method(): Find the method name in the table, call its
3582 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003583 */
3584 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003585 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003586 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 else
3588 {
3589 /*
3590 * Find the function name in the table, call its implementation.
3591 */
3592 error = call_internal_func(fname, argcount, argvars, rettv);
3593 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003594
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 /*
3596 * The function call (or "FuncUndefined" autocommand sequence) might
3597 * have been aborted by an error, an interrupt, or an explicitly thrown
3598 * exception that has not been caught so far. This situation can be
3599 * tested for by calling aborting(). For an error in an internal
3600 * function or for the "E132" error in call_user_func(), however, the
3601 * throw point at which the "force_abort" flag (temporarily reset by
3602 * emsg()) is normally updated has not been reached yet. We need to
3603 * update that flag first to make aborting() reliable.
3604 */
3605 update_force_abort();
3606 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003607 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 ret = OK;
3609
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003610theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 /*
3612 * Report an error unless the argument evaluation or function call has been
3613 * cancelled due to an aborting error, an interrupt, or an exception.
3614 */
3615 if (!aborting())
3616 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003617 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 }
3619
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003620 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003622 clear_tv(&argv[--argv_clear + argv_base]);
3623
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 vim_free(tofree);
3625 vim_free(name);
3626
3627 return ret;
3628}
3629
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003630 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003631printable_func_name(ufunc_T *fp)
3632{
3633 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3634}
3635
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003637 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638 */
3639 static void
3640list_func_head(ufunc_T *fp, int indent)
3641{
3642 int j;
3643
3644 msg_start();
3645 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003646 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003647 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003648 msg_puts("def ");
3649 else
3650 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003651 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652 msg_putchar('(');
3653 for (j = 0; j < fp->uf_args.ga_len; ++j)
3654 {
3655 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003656 msg_puts(", ");
3657 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003658 if (fp->uf_arg_types != NULL)
3659 {
3660 char *tofree;
3661
3662 msg_puts(": ");
3663 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3664 vim_free(tofree);
3665 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003666 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3667 {
3668 msg_puts(" = ");
3669 msg_puts(((char **)(fp->uf_def_args.ga_data))
3670 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3671 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 }
3673 if (fp->uf_varargs)
3674 {
3675 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003676 msg_puts(", ");
3677 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003679 if (fp->uf_va_name != NULL)
3680 {
3681 if (j)
3682 msg_puts(", ");
3683 msg_puts("...");
3684 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003685 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003686 {
3687 char *tofree;
3688
3689 msg_puts(": ");
3690 msg_puts(type_name(fp->uf_va_type, &tofree));
3691 vim_free(tofree);
3692 }
3693 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003695
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003696 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003697 {
3698 if (fp->uf_ret_type != &t_void)
3699 {
3700 char *tofree;
3701
3702 msg_puts(": ");
3703 msg_puts(type_name(fp->uf_ret_type, &tofree));
3704 vim_free(tofree);
3705 }
3706 }
3707 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003708 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003710 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003712 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003713 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003714 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 msg_clr_eos();
3716 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003717 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718}
3719
3720/*
3721 * Get a function name, translating "<SID>" and "<SNR>".
3722 * Also handles a Funcref in a List or Dictionary.
3723 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003724 * Set "*is_global" to TRUE when the function must be global, unless
3725 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 * flags:
3727 * TFN_INT: internal function name OK
3728 * TFN_QUIET: be quiet
3729 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003730 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003731 * Advances "pp" to just after the function name (if no error).
3732 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003733 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734trans_function_name(
3735 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003736 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003737 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003739 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003740 partial_T **partial, // return: partial of a FuncRef
3741 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742{
3743 char_u *name = NULL;
3744 char_u *start;
3745 char_u *end;
3746 int lead;
3747 char_u sid_buf[20];
3748 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003749 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003750 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003752 int vim9script = in_vim9script();
3753 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754
3755 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003756 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 start = *pp;
3758
Bram Moolenaare38eab22019-12-05 21:50:01 +01003759 // Check for hard coded <SNR>: already translated function ID (from a user
3760 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3762 && (*pp)[2] == (int)KE_SNR)
3763 {
3764 *pp += 3;
3765 len = get_id_len(pp) + 3;
3766 return vim_strnsave(start, len);
3767 }
3768
Bram Moolenaare38eab22019-12-05 21:50:01 +01003769 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3770 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 lead = eval_fname_script(start);
3772 if (lead > 2)
3773 start += lead;
3774
Bram Moolenaare38eab22019-12-05 21:50:01 +01003775 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003776 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003778 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003779 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 {
3781 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003782 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783 goto theend;
3784 }
3785 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3786 {
3787 /*
3788 * Report an invalid expression in braces, unless the expression
3789 * evaluation has been cancelled due to an aborting error, an
3790 * interrupt, or an exception.
3791 */
3792 if (!aborting())
3793 {
3794 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003795 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 }
3797 else
3798 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3799 goto theend;
3800 }
3801
3802 if (lv.ll_tv != NULL)
3803 {
3804 if (fdp != NULL)
3805 {
3806 fdp->fd_dict = lv.ll_dict;
3807 fdp->fd_newkey = lv.ll_newkey;
3808 lv.ll_newkey = NULL;
3809 fdp->fd_di = lv.ll_di;
3810 }
3811 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3812 {
3813 name = vim_strsave(lv.ll_tv->vval.v_string);
3814 *pp = end;
3815 }
3816 else if (lv.ll_tv->v_type == VAR_PARTIAL
3817 && lv.ll_tv->vval.v_partial != NULL)
3818 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003819 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 *pp = end;
3821 if (partial != NULL)
3822 *partial = lv.ll_tv->vval.v_partial;
3823 }
3824 else
3825 {
3826 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3827 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003828 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 else
3830 *pp = end;
3831 name = NULL;
3832 }
3833 goto theend;
3834 }
3835
3836 if (lv.ll_name == NULL)
3837 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003838 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003839 *pp = end;
3840 goto theend;
3841 }
3842
Bram Moolenaare38eab22019-12-05 21:50:01 +01003843 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 if (lv.ll_exp_name != NULL)
3845 {
3846 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003847 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003848 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 if (name == lv.ll_exp_name)
3850 name = NULL;
3851 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003852 else if (lv.ll_sid > 0)
3853 {
3854 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3855 int cc = *lv.ll_name_end;
3856
3857 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3858 *lv.ll_name_end = NUL;
3859 if (si->sn_autoload_prefix != NULL)
3860 {
3861 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3862 }
3863 else
3864 {
3865 sid_buf[0] = K_SPECIAL;
3866 sid_buf[1] = KS_EXTRA;
3867 sid_buf[2] = (int)KE_SNR;
3868 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003869 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003870 name = concat_str(sid_buf, lv.ll_name);
3871 }
3872 *lv.ll_name_end = cc;
3873 *pp = end;
3874 goto theend;
3875 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003876 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 {
3878 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003879 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003880 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 if (name == *pp)
3882 name = NULL;
3883 }
3884 if (name != NULL)
3885 {
3886 name = vim_strsave(name);
3887 *pp = end;
3888 if (STRNCMP(name, "<SNR>", 5) == 0)
3889 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003890 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003891 name[0] = K_SPECIAL;
3892 name[1] = KS_EXTRA;
3893 name[2] = (int)KE_SNR;
3894 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3895 }
3896 goto theend;
3897 }
3898
3899 if (lv.ll_exp_name != NULL)
3900 {
3901 len = (int)STRLEN(lv.ll_exp_name);
3902 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3903 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3904 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003905 // When there was "s:" already or the name expanded to get a
3906 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907 lv.ll_name += 2;
3908 len -= 2;
3909 lead = 2;
3910 }
3911 }
3912 else
3913 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003914 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003916 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003917 if (lv.ll_name[0] == 'g')
3918 {
3919 if (is_global != NULL)
3920 {
3921 *is_global = TRUE;
3922 }
3923 else
3924 {
3925 // dropping "g:" without setting "is_global" won't work in
3926 // Vim9script, put it back later
3927 prefix_g = TRUE;
3928 extra = 2;
3929 }
3930 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003932 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 len = (int)(end - lv.ll_name);
3934 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003935 if (len <= 0)
3936 {
3937 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003938 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003939 goto theend;
3940 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003942 // In Vim9 script a user function is script-local by default, unless it
3943 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003944 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003945
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 /*
3947 * Copy the function name to allocated memory.
3948 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3949 * Accept <SNR>123_name() outside a script.
3950 */
3951 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003952 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003953 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003954 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003955 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003956 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003957 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
Bram Moolenaar3787f262022-02-07 21:54:01 +00003958 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003959 semsg(_(vim9script
Bram Moolenaar3787f262022-02-07 21:54:01 +00003960 ? e_function_name_must_start_with_capital_str
3961 : e_function_name_must_start_with_capital_or_s_str),
3962 start);
3963 goto theend;
3964 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003965 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00003966 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00003967 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003968 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003969 || eval_fname_sid(*pp))
3970 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003971 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003972 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003974 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003975 goto theend;
3976 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003977 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003978 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003979 extra = 3 + (int)STRLEN(sid_buf);
3980 else
3981 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982 }
3983 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003984 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00003985 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003987 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00003988 : e_function_name_must_start_with_capital_or_s_str),
3989 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 goto theend;
3991 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003992 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 {
3994 char_u *cp = vim_strchr(lv.ll_name, ':');
3995
3996 if (cp != NULL && cp < end)
3997 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003998 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 goto theend;
4000 }
4001 }
4002
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004003 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 if (name != NULL)
4005 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004006 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004007 {
4008 name[0] = K_SPECIAL;
4009 name[1] = KS_EXTRA;
4010 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004011 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 STRCPY(name + 3, sid_buf);
4013 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004014 else if (prefix_g)
4015 {
4016 name[0] = 'g';
4017 name[1] = ':';
4018 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004019 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4020 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 }
4022 *pp = end;
4023
4024theend:
4025 clear_lval(&lv);
4026 return name;
4027}
4028
4029/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004030 * Assuming "name" is the result of trans_function_name() and it was prefixed
4031 * to use the script-local name, return the unmodified name (points into
4032 * "name"). Otherwise return NULL.
4033 * This can be used to first search for a script-local function and fall back
4034 * to the global function if not found.
4035 */
4036 char_u *
4037untrans_function_name(char_u *name)
4038{
4039 char_u *p;
4040
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004041 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004042 {
4043 p = vim_strchr(name, '_');
4044 if (p != NULL)
4045 return p + 1;
4046 }
4047 return NULL;
4048}
4049
4050/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004051 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4052 * current script ID and returns the expanded function name. The caller should
4053 * free the returned name. If not called from a script context or the function
4054 * name doesn't start with these prefixes, then returns NULL.
4055 * This doesn't check whether the script-local function exists or not.
4056 */
4057 char_u *
4058get_scriptlocal_funcname(char_u *funcname)
4059{
4060 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004061 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004062 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004063 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004064
4065 if (funcname == NULL)
4066 return NULL;
4067
4068 if (STRNCMP(funcname, "s:", 2) != 0
4069 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004070 {
4071 ufunc_T *ufunc;
4072
4073 // The function name does not have a script-local prefix. Try finding
4074 // it when in a Vim9 script and there is no "g:" prefix.
4075 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4076 return NULL;
4077 ufunc = find_func(funcname, FALSE);
4078 if (ufunc == NULL || func_is_global(ufunc)
4079 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4080 return NULL;
4081 ++p;
4082 off = 0;
4083 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004084 else
4085 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004086
4087 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4088 {
4089 emsg(_(e_using_sid_not_in_script_context));
4090 return NULL;
4091 }
4092 // Expand s: prefix into <SNR>nr_<name>
4093 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4094 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004095 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004096 if (newname == NULL)
4097 return NULL;
4098 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004099 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004100
4101 return newname;
4102}
4103
4104/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004105 * Return script-local "fname" with the 3-byte sequence replaced by
4106 * printable <SNR> in allocated memory.
4107 */
4108 char_u *
4109alloc_printable_func_name(char_u *fname)
4110{
4111 char_u *n = alloc(STRLEN(fname + 3) + 6);
4112
4113 if (n != NULL)
4114 {
4115 STRCPY(n, "<SNR>");
4116 STRCPY(n + 5, fname + 3);
4117 }
4118 return n;
4119}
4120
4121/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004122 * Call trans_function_name(), except that a lambda is returned as-is.
4123 * Returns the name in allocated memory.
4124 */
4125 char_u *
4126save_function_name(
4127 char_u **name,
4128 int *is_global,
4129 int skip,
4130 int flags,
4131 funcdict_T *fudi)
4132{
4133 char_u *p = *name;
4134 char_u *saved;
4135
4136 if (STRNCMP(p, "<lambda>", 8) == 0)
4137 {
4138 p += 8;
4139 (void)getdigits(&p);
4140 saved = vim_strnsave(*name, p - *name);
4141 if (fudi != NULL)
4142 CLEAR_POINTER(fudi);
4143 }
4144 else
4145 saved = trans_function_name(&p, is_global, skip,
4146 flags, fudi, NULL, NULL);
4147 *name = p;
4148 return saved;
4149}
4150
4151/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004152 * List functions. When "regmatch" is NULL all of then.
4153 * Otherwise functions matching "regmatch".
4154 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004155 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004156list_functions(regmatch_T *regmatch)
4157{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004158 int changed = func_hashtab.ht_changed;
4159 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004160 hashitem_T *hi;
4161
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004162 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004163 {
4164 if (!HASHITEM_EMPTY(hi))
4165 {
4166 ufunc_T *fp = HI2UF(hi);
4167
4168 --todo;
4169 if ((fp->uf_flags & FC_DEAD) == 0
4170 && (regmatch == NULL
4171 ? !message_filtered(fp->uf_name)
4172 && !func_name_refcount(fp->uf_name)
4173 : !isdigit(*fp->uf_name)
4174 && vim_regexec(regmatch, fp->uf_name, 0)))
4175 {
4176 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004177 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004178 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004179 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004180 return;
4181 }
4182 }
4183 }
4184 }
4185}
4186
4187/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004188 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004189 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4190 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004191 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004192 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004194 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004195define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197 int j;
4198 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004199 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004200 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004201 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 char_u *p;
4203 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004204 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004205 char_u *line_arg = NULL;
4206 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004207 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004208 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209 garray_T newlines;
4210 int varargs = FALSE;
4211 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004212 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004213 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004214 int fp_allocated = FALSE;
4215 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004216 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217 dictitem_T *v;
4218 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004219 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004220 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004222 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004223 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004224 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004225
4226 /*
4227 * ":function" without argument: list functions.
4228 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004229 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004230 {
4231 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004232 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004233 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004234 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235 }
4236
4237 /*
4238 * ":function /pat": list functions matching pattern.
4239 */
4240 if (*eap->arg == '/')
4241 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004242 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243 if (!eap->skip)
4244 {
4245 regmatch_T regmatch;
4246
4247 c = *p;
4248 *p = NUL;
4249 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4250 *p = c;
4251 if (regmatch.regprog != NULL)
4252 {
4253 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004254 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004255 vim_regfree(regmatch.regprog);
4256 }
4257 }
4258 if (*p == '/')
4259 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004260 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004261 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004262 }
4263
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004264 ga_init(&newargs);
4265 ga_init(&argtypes);
4266 ga_init(&default_args);
4267
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 /*
4269 * Get the function name. There are these situations:
4270 * func normal function name
4271 * "name" == func, "fudi.fd_dict" == NULL
4272 * dict.func new dictionary entry
4273 * "name" == NULL, "fudi.fd_dict" set,
4274 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4275 * dict.func existing dict entry with a Funcref
4276 * "name" == func, "fudi.fd_dict" set,
4277 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4278 * dict.func existing dict entry that's not a Funcref
4279 * "name" == NULL, "fudi.fd_dict" set,
4280 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4281 * s:func script-local function name
4282 * g:func global function name, same as "func"
4283 */
4284 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004285 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004287 // nested function, argument is (args).
4288 paren = TRUE;
4289 CLEAR_FIELD(fudi);
4290 }
4291 else
4292 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004293 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004294 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004295 if (p[0] == 's' && p[1] == ':')
4296 {
4297 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4298 return NULL;
4299 }
4300 p = to_name_end(p, TRUE);
4301 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4302 {
4303 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4304 eap->arg);
4305 return NULL;
4306 }
4307 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004308 }
4309
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004310 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004311 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004312 paren = (vim_strchr(p, '(') != NULL);
4313 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004315 /*
4316 * Return on an invalid expression in braces, unless the expression
4317 * evaluation has been cancelled due to an aborting error, an
4318 * interrupt, or an exception.
4319 */
4320 if (!aborting())
4321 {
4322 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004323 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004324 vim_free(fudi.fd_newkey);
4325 return NULL;
4326 }
4327 else
4328 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004330
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004331 // For "export def FuncName()" in an autoload script the function name
4332 // is stored with the legacy autoload name "dir#script#FuncName" so
4333 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004334 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004335 {
4336 char_u *prefixed = may_prefix_autoload(name);
4337
4338 if (prefixed != NULL && prefixed != name)
4339 {
4340 vim_free(name);
4341 name = prefixed;
4342 }
4343 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004344 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004345 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004346 {
4347 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4348 goto ret_free;
4349 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004350 }
4351
Bram Moolenaare38eab22019-12-05 21:50:01 +01004352 // An error in a function call during evaluation of an expression in magic
4353 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004354 saved_did_emsg = did_emsg;
4355 did_emsg = FALSE;
4356
4357 /*
4358 * ":function func" with only function name: list function.
4359 */
4360 if (!paren)
4361 {
4362 if (!ends_excmd(*skipwhite(p)))
4363 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004364 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004365 goto ret_free;
4366 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004367 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 if (eap->nextcmd != NULL)
4369 *p = NUL;
4370 if (!eap->skip && !got_int)
4371 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004372 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004373 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4374 {
4375 char_u *up = untrans_function_name(name);
4376
4377 // With Vim9 script the name was made script-local, if not
4378 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004379 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004380 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004381 }
4382
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383 if (fp != NULL)
4384 {
4385 list_func_head(fp, TRUE);
4386 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4387 {
4388 if (FUNCLINE(fp, j) == NULL)
4389 continue;
4390 msg_putchar('\n');
4391 msg_outnum((long)(j + 1));
4392 if (j < 9)
4393 msg_putchar(' ');
4394 if (j < 99)
4395 msg_putchar(' ');
4396 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004397 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 ui_breakcheck();
4399 }
4400 if (!got_int)
4401 {
4402 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004403 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004404 msg_puts(" enddef");
4405 else
4406 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 }
4408 }
4409 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004410 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 }
4412 goto ret_free;
4413 }
4414
4415 /*
4416 * ":function name(arg1, arg2)" Define function.
4417 */
4418 p = skipwhite(p);
4419 if (*p != '(')
4420 {
4421 if (!eap->skip)
4422 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004423 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424 goto ret_free;
4425 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004426 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 if (vim_strchr(p, '(') != NULL)
4428 p = vim_strchr(p, '(');
4429 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004430
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004431 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4432 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004433 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004434 goto ret_free;
4435 }
4436
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004437 // In Vim9 script only global functions can be redefined.
4438 if (vim9script && eap->forceit && !is_global)
4439 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004440 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004441 goto ret_free;
4442 }
4443
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004444 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004445
Bram Moolenaar04b12692020-05-04 23:24:44 +02004446 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004448 // Check the name of the function. Unless it's a dictionary function
4449 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 if (name != NULL)
4451 arg = name;
4452 else
4453 arg = fudi.fd_newkey;
4454 if (arg != NULL && (fudi.fd_di == NULL
4455 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4456 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4457 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004458 char_u *name_base = arg;
4459 int i;
4460
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004462 {
4463 name_base = vim_strchr(arg, '_');
4464 if (name_base == NULL)
4465 name_base = arg + 3;
4466 else
4467 ++name_base;
4468 }
4469 for (i = 0; name_base[i] != NUL && (i == 0
4470 ? eval_isnamec1(name_base[i])
4471 : eval_isnamec(name_base[i])); ++i)
4472 ;
4473 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004474 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004475
4476 // In Vim9 script a function cannot have the same name as a
4477 // variable.
4478 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004479 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4480 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004481 + EVAL_VAR_NO_FUNC) == OK)
4482 {
4483 semsg(_(e_redefining_script_item_str), name_base);
4484 goto ret_free;
4485 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004487 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004489 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004490 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004491 goto ret_free;
4492 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493 }
4494
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004495 // This may get more lines and make the pointers into the first line
4496 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004497 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004498 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004499 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004500 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004501 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004503 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004505 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004507 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004508 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004510 if (*p != ':')
4511 {
4512 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4513 p = skipwhite(p);
4514 }
4515 else if (!IS_WHITE_OR_NUL(p[1]))
4516 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004517 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004518 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004519 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004520 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004521 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004522 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004523 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004524 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004525 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004526 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004527 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004528 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004531 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004533 else
4534 // find extra arguments "range", "dict", "abort" and "closure"
4535 for (;;)
4536 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004537 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004538 p = skipwhite(p);
4539 if (STRNCMP(p, "range", 5) == 0)
4540 {
4541 flags |= FC_RANGE;
4542 p += 5;
4543 }
4544 else if (STRNCMP(p, "dict", 4) == 0)
4545 {
4546 flags |= FC_DICT;
4547 p += 4;
4548 }
4549 else if (STRNCMP(p, "abort", 5) == 0)
4550 {
4551 flags |= FC_ABORT;
4552 p += 5;
4553 }
4554 else if (STRNCMP(p, "closure", 7) == 0)
4555 {
4556 flags |= FC_CLOSURE;
4557 p += 7;
4558 if (current_funccal == NULL)
4559 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004560 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004561 name == NULL ? (char_u *)"" : name);
4562 goto erret;
4563 }
4564 }
4565 else
4566 break;
4567 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568
Bram Moolenaare38eab22019-12-05 21:50:01 +01004569 // When there is a line break use what follows for the function body.
4570 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 if (*p == '\n')
4572 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004573 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004574 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4575 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004576 && !(VIM_ISWHITE(*whitep) && *p == '#'
4577 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004578 && !eap->skip
4579 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004580 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581
4582 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004583 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4584 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 */
4586 if (KeyTyped)
4587 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004588 // Check if the function already exists, don't let the user type the
4589 // whole function before telling him it doesn't work! For a script we
4590 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591 if (!eap->skip && !eap->forceit)
4592 {
4593 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004594 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004595 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004596 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004597 }
4598
4599 if (!eap->skip && did_emsg)
4600 goto erret;
4601
Bram Moolenaare38eab22019-12-05 21:50:01 +01004602 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 cmdline_row = msg_row;
4604 }
4605
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004606 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004607 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004608
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004609 // Do not define the function when getting the body fails and when
4610 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004611 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004612 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004613 goto erret;
4614
4615 /*
4616 * If there are no errors, add the function
4617 */
4618 if (fudi.fd_dict == NULL)
4619 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004620 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004621 char_u *find_name = name;
4622 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004623 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004624
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004625 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004626 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004627 var_conflict = TRUE;
4628
4629 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4630 {
4631 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4632
4633 if (si->sn_autoload_prefix != NULL)
4634 {
4635 if (is_export)
4636 {
4637 find_name = name + STRLEN(si->sn_autoload_prefix);
4638 v = find_var(find_name, &ht, TRUE);
4639 if (v != NULL)
4640 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004641 // Only check if the function already exists in the script,
4642 // global functions can be shadowed.
4643 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004644 }
4645 else
4646 {
4647 char_u *prefixed = may_prefix_autoload(name);
4648
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004649 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004650 {
4651 v = find_var(prefixed, &ht, TRUE);
4652 if (v != NULL)
4653 var_conflict = TRUE;
4654 vim_free(prefixed);
4655 }
4656 }
4657 }
4658 }
4659 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004660 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004661 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662 goto erret;
4663 }
4664
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004665 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004666 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004668 char_u *uname = untrans_function_name(name);
4669
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004670 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004671 }
4672
4673 if (fp != NULL || import != NULL)
4674 {
4675 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004676
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004677 // Function can be replaced with "function!" and when sourcing the
4678 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004679 // A name that is used by an import can not be overruled.
4680 if (import != NULL
4681 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004682 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004683 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004685 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004686 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004687 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004688 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004689 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 goto erret;
4691 }
4692 if (fp->uf_calls > 0)
4693 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004694 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004695 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696 goto erret;
4697 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004698 if (fp->uf_refcount > 1)
4699 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004700 // This function is referenced somewhere, don't redefine it but
4701 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004702 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004703 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004704 fp = NULL;
4705 overwrite = TRUE;
4706 }
4707 else
4708 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004709 char_u *exp_name = fp->uf_name_exp;
4710
4711 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004712 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004713 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004714 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004715 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004716 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004717#ifdef FEAT_PROFILE
4718 fp->uf_profiling = FALSE;
4719 fp->uf_prof_initialized = FALSE;
4720#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004721 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004722 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 }
4724 }
4725 else
4726 {
4727 char numbuf[20];
4728
4729 fp = NULL;
4730 if (fudi.fd_newkey == NULL && !eap->forceit)
4731 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004732 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004733 goto erret;
4734 }
4735 if (fudi.fd_di == NULL)
4736 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004737 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004738 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004739 goto erret;
4740 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004741 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004742 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004743 goto erret;
4744
Bram Moolenaare38eab22019-12-05 21:50:01 +01004745 // Give the function a sequential number. Can only be used with a
4746 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747 vim_free(name);
4748 sprintf(numbuf, "%d", ++func_nr);
4749 name = vim_strsave((char_u *)numbuf);
4750 if (name == NULL)
4751 goto erret;
4752 }
4753
4754 if (fp == NULL)
4755 {
4756 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4757 {
4758 int slen, plen;
4759 char_u *scriptname;
4760
Bram Moolenaare38eab22019-12-05 21:50:01 +01004761 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004763 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004764 {
4765 scriptname = autoload_name(name);
4766 if (scriptname != NULL)
4767 {
4768 p = vim_strchr(scriptname, '/');
4769 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004770 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004771 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004772 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773 j = OK;
4774 vim_free(scriptname);
4775 }
4776 }
4777 if (j == FAIL)
4778 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004779 linenr_T save_lnum = SOURCING_LNUM;
4780
4781 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004782 semsg(_(e_function_name_does_not_match_script_file_name_str),
4783 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004784 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785 goto erret;
4786 }
4787 }
4788
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004789 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004790 if (fp == NULL)
4791 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004792 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793
4794 if (fudi.fd_dict != NULL)
4795 {
4796 if (fudi.fd_di == NULL)
4797 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004798 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004799 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4800 if (fudi.fd_di == NULL)
4801 {
4802 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004803 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804 goto erret;
4805 }
4806 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4807 {
4808 vim_free(fudi.fd_di);
4809 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004810 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 goto erret;
4812 }
4813 }
4814 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004815 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004816 clear_tv(&fudi.fd_di->di_tv);
4817 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004818 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819
Bram Moolenaare38eab22019-12-05 21:50:01 +01004820 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004821 flags |= FC_DICT;
4822 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823 }
4824 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004825 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004826 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004827 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004828
4829 if (eap->cmdidx == CMD_def)
4830 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004831 int lnum_save = SOURCING_LNUM;
4832 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004833
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004834 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004835
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004836 // error messages are for the first function line
4837 SOURCING_LNUM = sourcing_lnum_top;
4838
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004839 // The function may use script variables from the context.
4840 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004841
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004842 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004843 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004844 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004845 free_fp = fp_allocated;
4846 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004847 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004848 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004849
4850 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004851 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004852 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004853 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004854 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004855 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004856 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004857 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004858 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004859 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004860 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004861
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004862 if (fp_allocated)
4863 {
4864 // insert the new function in the function list
4865 set_ufunc_name(fp, name);
4866 if (overwrite)
4867 {
4868 hi = hash_find(&func_hashtab, name);
4869 hi->hi_key = UF2HIKEY(fp);
4870 }
4871 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4872 {
4873 free_fp = TRUE;
4874 goto erret;
4875 }
4876 fp->uf_refcount = 1;
4877 }
4878
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004879 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004880 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004881 if ((flags & FC_CLOSURE) != 0)
4882 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004883 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004884 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004885 }
4886 else
4887 fp->uf_scoped = NULL;
4888
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004889#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004890 if (prof_def_func())
4891 func_do_profile(fp);
4892#endif
4893 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004894 if (sandbox)
4895 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004896 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004897 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 fp->uf_flags = flags;
4899 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004900 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004901 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004902 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004903 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004904 if (is_export)
4905 {
4906 fp->uf_flags |= FC_EXPORT;
4907 // let ex_export() know the export worked.
4908 is_export = FALSE;
4909 }
4910
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004911 if (eap->cmdidx == CMD_def)
4912 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004913 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4914 // :func does not use Vim9 script syntax, even in a Vim9 script file
4915 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004916
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004917 goto ret_free;
4918
4919erret:
4920 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004921 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004922 if (fp != NULL)
4923 {
4924 ga_init(&fp->uf_args);
4925 ga_init(&fp->uf_def_args);
4926 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927errret_2:
4928 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004929 if (fp != NULL)
4930 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004931 if (free_fp)
4932 {
4933 vim_free(fp);
4934 fp = NULL;
4935 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004937 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004939 if (name != name_arg)
4940 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004941 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004943
4944 return fp;
4945}
4946
4947/*
4948 * ":function"
4949 */
4950 void
4951ex_function(exarg_T *eap)
4952{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004953 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004954
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004955 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4956 (void)define_function(eap, NULL, &lines_to_free);
4957 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004958}
4959
4960/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004961 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004962 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004963 */
4964 void
4965ex_defcompile(exarg_T *eap UNUSED)
4966{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004967 long todo = (long)func_hashtab.ht_used;
4968 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004969 hashitem_T *hi;
4970 ufunc_T *ufunc;
4971
4972 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4973 {
4974 if (!HASHITEM_EMPTY(hi))
4975 {
4976 --todo;
4977 ufunc = HI2UF(hi);
4978 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004979 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4980 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004981 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004982 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004983
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004984 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004985 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004986 // a function has been added or removed, need to start over
4987 todo = (long)func_hashtab.ht_used;
4988 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004989 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004990 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004991 }
4992 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004993 }
4994 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004995}
4996
4997/*
4998 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4999 * Return 2 if "p" starts with "s:".
5000 * Return 0 otherwise.
5001 */
5002 int
5003eval_fname_script(char_u *p)
5004{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005005 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5006 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005007 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5008 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5009 return 5;
5010 if (p[0] == 's' && p[1] == ':')
5011 return 2;
5012 return 0;
5013}
5014
5015 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005016translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017{
5018 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005019 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005020 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005021}
5022
5023/*
5024 * Return TRUE when "ufunc" has old-style "..." varargs
5025 * or named varargs "...name: type".
5026 */
5027 int
5028has_varargs(ufunc_T *ufunc)
5029{
5030 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005031}
5032
5033/*
5034 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005035 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005036 */
5037 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005038function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005039{
5040 char_u *nm = name;
5041 char_u *p;
5042 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005043 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005044 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005045
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005046 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5047 if (no_deref)
5048 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005049 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005050 nm = skipwhite(nm);
5051
Bram Moolenaare38eab22019-12-05 21:50:01 +01005052 // Only accept "funcname", "funcname ", "funcname (..." and
5053 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005054 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005055 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005056 vim_free(p);
5057 return n;
5058}
5059
Bram Moolenaar113e1072019-01-20 15:30:40 +01005060#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005061 char_u *
5062get_expanded_name(char_u *name, int check)
5063{
5064 char_u *nm = name;
5065 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005066 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005068 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005069 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005070
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005071 if (p != NULL && *nm == NUL
5072 && (!check || translated_function_exists(p, is_global)))
5073 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074
5075 vim_free(p);
5076 return NULL;
5077}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005078#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005079
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080/*
5081 * Function given to ExpandGeneric() to obtain the list of user defined
5082 * function names.
5083 */
5084 char_u *
5085get_user_func_name(expand_T *xp, int idx)
5086{
5087 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005088 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005089 static hashitem_T *hi;
5090 ufunc_T *fp;
5091
5092 if (idx == 0)
5093 {
5094 done = 0;
5095 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005096 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005097 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005098 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005099 {
5100 if (done++ > 0)
5101 ++hi;
5102 while (HASHITEM_EMPTY(hi))
5103 ++hi;
5104 fp = HI2UF(hi);
5105
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005106 // don't show dead, dict and lambda functions
5107 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005108 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005109 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005110
5111 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005112 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005113
5114 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005115 if (xp->xp_context != EXPAND_USER_FUNC
5116 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005117 {
5118 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005119 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005120 STRCAT(IObuff, ")");
5121 }
5122 return IObuff;
5123 }
5124 return NULL;
5125}
5126
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127/*
5128 * ":delfunction {name}"
5129 */
5130 void
5131ex_delfunction(exarg_T *eap)
5132{
5133 ufunc_T *fp = NULL;
5134 char_u *p;
5135 char_u *name;
5136 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005137 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005138
5139 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005140 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5141 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005142 vim_free(fudi.fd_newkey);
5143 if (name == NULL)
5144 {
5145 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005146 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147 return;
5148 }
5149 if (!ends_excmd(*skipwhite(p)))
5150 {
5151 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005152 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153 return;
5154 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005155 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156 if (eap->nextcmd != NULL)
5157 *p = NUL;
5158
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005159 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005160 {
5161 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005162 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005163 vim_free(name);
5164 return;
5165 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005166 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005167 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005168 vim_free(name);
5169
5170 if (!eap->skip)
5171 {
5172 if (fp == NULL)
5173 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005174 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005175 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005176 return;
5177 }
5178 if (fp->uf_calls > 0)
5179 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005180 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005181 return;
5182 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005183 if (fp->uf_flags & FC_VIM9)
5184 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005185 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005186 return;
5187 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005188
5189 if (fudi.fd_dict != NULL)
5190 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005191 // Delete the dict item that refers to the function, it will
5192 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005193 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5194 }
5195 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005196 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005197 // A normal function (not a numbered function or lambda) has a
5198 // refcount of 1 for the entry in the hashtable. When deleting
5199 // it and the refcount is more than one, it should be kept.
5200 // A numbered function and lambda should be kept if the refcount is
5201 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005202 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005203 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005204 // Function is still referenced somewhere. Don't free it but
5205 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005206 if (func_remove(fp))
5207 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005208 }
5209 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005210 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005211 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 }
5213}
5214
5215/*
5216 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005217 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218 */
5219 void
5220func_unref(char_u *name)
5221{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005222 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005224 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005225 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005226 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005227 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005228 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005229#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005230 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005231#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005232 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005233 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005234 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005235}
5236
5237/*
5238 * Unreference a Function: decrement the reference count and free it when it
5239 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005240 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005241 */
5242 void
5243func_ptr_unref(ufunc_T *fp)
5244{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005245 if (fp != NULL && (--fp->uf_refcount <= 0
5246 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5247 && fp->uf_partial->pt_refcount <= 1
5248 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005249 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005250 // Only delete it when it's not being used. Otherwise it's done
5251 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005252 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005253 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005254 }
5255}
5256
5257/*
5258 * Count a reference to a Function.
5259 */
5260 void
5261func_ref(char_u *name)
5262{
5263 ufunc_T *fp;
5264
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005265 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005266 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005267 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005268 if (fp != NULL)
5269 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005270 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005271 // Only give an error for a numbered function.
5272 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005273 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005274}
5275
5276/*
5277 * Count a reference to a Function.
5278 */
5279 void
5280func_ptr_ref(ufunc_T *fp)
5281{
5282 if (fp != NULL)
5283 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005284}
5285
5286/*
5287 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5288 * referenced from anywhere that is in use.
5289 */
5290 static int
5291can_free_funccal(funccall_T *fc, int copyID)
5292{
5293 return (fc->l_varlist.lv_copyID != copyID
5294 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005295 && fc->l_avars.dv_copyID != copyID
5296 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297}
5298
5299/*
5300 * ":return [expr]"
5301 */
5302 void
5303ex_return(exarg_T *eap)
5304{
5305 char_u *arg = eap->arg;
5306 typval_T rettv;
5307 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005308 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005309
5310 if (current_funccal == NULL)
5311 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005312 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005313 return;
5314 }
5315
Bram Moolenaar844fb642021-10-23 13:32:30 +01005316 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005317 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5318
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319 if (eap->skip)
5320 ++emsg_skip;
5321
5322 eap->nextcmd = NULL;
5323 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005324 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005325 {
5326 if (!eap->skip)
5327 returning = do_return(eap, FALSE, TRUE, &rettv);
5328 else
5329 clear_tv(&rettv);
5330 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005331 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005332 else if (!eap->skip)
5333 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005334 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005335 update_force_abort();
5336
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337 /*
5338 * Return unless the expression evaluation has been cancelled due to an
5339 * aborting error, an interrupt, or an exception.
5340 */
5341 if (!aborting())
5342 returning = do_return(eap, FALSE, TRUE, NULL);
5343 }
5344
Bram Moolenaare38eab22019-12-05 21:50:01 +01005345 // When skipping or the return gets pending, advance to the next command
5346 // in this line (!returning). Otherwise, ignore the rest of the line.
5347 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 if (returning)
5349 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005350 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005351 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005352
5353 if (eap->skip)
5354 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005355 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005356}
5357
5358/*
5359 * ":1,25call func(arg1, arg2)" function call.
5360 */
5361 void
5362ex_call(exarg_T *eap)
5363{
5364 char_u *arg = eap->arg;
5365 char_u *startarg;
5366 char_u *name;
5367 char_u *tofree;
5368 int len;
5369 typval_T rettv;
5370 linenr_T lnum;
5371 int doesrange;
5372 int failed = FALSE;
5373 funcdict_T fudi;
5374 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005375 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005376 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005377 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005378 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005379
Bram Moolenaare6b53242020-07-01 17:28:33 +02005380 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005381 if (eap->skip)
5382 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005383 // trans_function_name() doesn't work well when skipping, use eval0()
5384 // instead to skip to any following command, e.g. for:
5385 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005386 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005387 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005388 clear_tv(&rettv);
5389 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005390 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005391 return;
5392 }
5393
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005394 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005395 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005396 if (fudi.fd_newkey != NULL)
5397 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005398 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005399 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005400 vim_free(fudi.fd_newkey);
5401 }
5402 if (tofree == NULL)
5403 return;
5404
Bram Moolenaare38eab22019-12-05 21:50:01 +01005405 // Increase refcount on dictionary, it could get deleted when evaluating
5406 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005407 if (fudi.fd_dict != NULL)
5408 ++fudi.fd_dict->dv_refcount;
5409
Bram Moolenaare38eab22019-12-05 21:50:01 +01005410 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5411 // contents. For VAR_PARTIAL get its partial, unless we already have one
5412 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005413 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005414 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005415 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005416 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005417
Bram Moolenaare38eab22019-12-05 21:50:01 +01005418 // Skip white space to allow ":call func ()". Not good, but required for
5419 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005420 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005421 if (*startarg != '(')
5422 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005423 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005424 goto end;
5425 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005426 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005427 {
5428 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5429 goto end;
5430 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005431
5432 /*
5433 * When skipping, evaluate the function once, to find the end of the
5434 * arguments.
5435 * When the function takes a range, this is discovered after the first
5436 * call, and the loop is broken.
5437 */
5438 if (eap->skip)
5439 {
5440 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005441 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442 }
5443 else
5444 lnum = eap->line1;
5445 for ( ; lnum <= eap->line2; ++lnum)
5446 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005447 funcexe_T funcexe;
5448
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005449 if (!eap->skip && eap->addr_count > 0)
5450 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005451 if (lnum > curbuf->b_ml.ml_line_count)
5452 {
5453 // If the function deleted lines or switched to another buffer
5454 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005455 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005456 break;
5457 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005458 curwin->w_cursor.lnum = lnum;
5459 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005460 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461 }
5462 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005463
Bram Moolenaara80faa82020-04-12 19:37:17 +02005464 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005465 funcexe.fe_firstline = eap->line1;
5466 funcexe.fe_lastline = eap->line2;
5467 funcexe.fe_doesrange = &doesrange;
5468 funcexe.fe_evaluate = !eap->skip;
5469 funcexe.fe_partial = partial;
5470 funcexe.fe_selfdict = fudi.fd_dict;
5471 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005472 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005473 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005474 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005475 {
5476 failed = TRUE;
5477 break;
5478 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005479 if (has_watchexpr())
5480 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005481
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005482 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005483 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005484 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005485 {
5486 failed = TRUE;
5487 break;
5488 }
5489
5490 clear_tv(&rettv);
5491 if (doesrange || eap->skip)
5492 break;
5493
Bram Moolenaare38eab22019-12-05 21:50:01 +01005494 // Stop when immediately aborting on error, or when an interrupt
5495 // occurred or an exception was thrown but not caught.
5496 // get_func_tv() returned OK, so that the check for trailing
5497 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005498 if (aborting())
5499 break;
5500 }
5501 if (eap->skip)
5502 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005503 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005504
Bram Moolenaar1d341892021-09-18 15:25:52 +02005505 // When inside :try we need to check for following "| catch" or "| endtry".
5506 // Not when there was an error, but do check if an exception was thrown.
5507 if ((!aborting() || did_throw)
5508 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005509 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005510 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005511 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005512 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005513 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005514 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005515 {
5516 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005517 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519 }
5520 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005521 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005522 }
5523
5524end:
5525 dict_unref(fudi.fd_dict);
5526 vim_free(tofree);
5527}
5528
5529/*
5530 * Return from a function. Possibly makes the return pending. Also called
5531 * for a pending return at the ":endtry" or after returning from an extra
5532 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5533 * when called due to a ":return" command. "rettv" may point to a typval_T
5534 * with the return rettv. Returns TRUE when the return can be carried out,
5535 * FALSE when the return gets pending.
5536 */
5537 int
5538do_return(
5539 exarg_T *eap,
5540 int reanimate,
5541 int is_cmd,
5542 void *rettv)
5543{
5544 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005545 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005546
5547 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005548 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005549 current_funccal->returned = FALSE;
5550
5551 /*
5552 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5553 * not in its finally clause (which then is to be executed next) is found.
5554 * In this case, make the ":return" pending for execution at the ":endtry".
5555 * Otherwise, return normally.
5556 */
5557 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5558 if (idx >= 0)
5559 {
5560 cstack->cs_pending[idx] = CSTP_RETURN;
5561
5562 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005563 // A pending return again gets pending. "rettv" points to an
5564 // allocated variable with the rettv of the original ":return"'s
5565 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005566 cstack->cs_rettv[idx] = rettv;
5567 else
5568 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005569 // When undoing a return in order to make it pending, get the stored
5570 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005571 if (reanimate)
5572 rettv = current_funccal->rettv;
5573
5574 if (rettv != NULL)
5575 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005576 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005577 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5578 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5579 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005580 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005581 }
5582 else
5583 cstack->cs_rettv[idx] = NULL;
5584
5585 if (reanimate)
5586 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005587 // The pending return value could be overwritten by a ":return"
5588 // without argument in a finally clause; reset the default
5589 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005590 current_funccal->rettv->v_type = VAR_NUMBER;
5591 current_funccal->rettv->vval.v_number = 0;
5592 }
5593 }
5594 report_make_pending(CSTP_RETURN, rettv);
5595 }
5596 else
5597 {
5598 current_funccal->returned = TRUE;
5599
Bram Moolenaare38eab22019-12-05 21:50:01 +01005600 // If the return is carried out now, store the return value. For
5601 // a return immediately after reanimation, the value is already
5602 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005603 if (!reanimate && rettv != NULL)
5604 {
5605 clear_tv(current_funccal->rettv);
5606 *current_funccal->rettv = *(typval_T *)rettv;
5607 if (!is_cmd)
5608 vim_free(rettv);
5609 }
5610 }
5611
5612 return idx < 0;
5613}
5614
5615/*
5616 * Free the variable with a pending return value.
5617 */
5618 void
5619discard_pending_return(void *rettv)
5620{
5621 free_tv((typval_T *)rettv);
5622}
5623
5624/*
5625 * Generate a return command for producing the value of "rettv". The result
5626 * is an allocated string. Used by report_pending() for verbose messages.
5627 */
5628 char_u *
5629get_return_cmd(void *rettv)
5630{
5631 char_u *s = NULL;
5632 char_u *tofree = NULL;
5633 char_u numbuf[NUMBUFLEN];
5634
5635 if (rettv != NULL)
5636 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5637 if (s == NULL)
5638 s = (char_u *)"";
5639
5640 STRCPY(IObuff, ":return ");
5641 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5642 if (STRLEN(s) + 8 >= IOSIZE)
5643 STRCPY(IObuff + IOSIZE - 4, "...");
5644 vim_free(tofree);
5645 return vim_strsave(IObuff);
5646}
5647
5648/*
5649 * Get next function line.
5650 * Called by do_cmdline() to get the next line.
5651 * Returns allocated string, or NULL for end of function.
5652 */
5653 char_u *
5654get_func_line(
5655 int c UNUSED,
5656 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005657 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005658 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005659{
5660 funccall_T *fcp = (funccall_T *)cookie;
5661 ufunc_T *fp = fcp->func;
5662 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005663 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005664
Bram Moolenaare38eab22019-12-05 21:50:01 +01005665 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005666 if (fcp->dbg_tick != debug_tick)
5667 {
5668 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005669 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005670 fcp->dbg_tick = debug_tick;
5671 }
5672#ifdef FEAT_PROFILE
5673 if (do_profiling == PROF_YES)
5674 func_line_end(cookie);
5675#endif
5676
5677 gap = &fp->uf_lines;
5678 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5679 || fcp->returned)
5680 retval = NULL;
5681 else
5682 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005683 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005684 while (fcp->linenr < gap->ga_len
5685 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5686 ++fcp->linenr;
5687 if (fcp->linenr >= gap->ga_len)
5688 retval = NULL;
5689 else
5690 {
5691 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005692 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005693#ifdef FEAT_PROFILE
5694 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005695 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005696#endif
5697 }
5698 }
5699
Bram Moolenaare38eab22019-12-05 21:50:01 +01005700 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005701 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005702 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005703 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005704 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005705 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005706 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005707 fcp->dbg_tick = debug_tick;
5708 }
5709
5710 return retval;
5711}
5712
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005713/*
5714 * Return TRUE if the currently active function should be ended, because a
5715 * return was encountered or an error occurred. Used inside a ":while".
5716 */
5717 int
5718func_has_ended(void *cookie)
5719{
5720 funccall_T *fcp = (funccall_T *)cookie;
5721
Bram Moolenaare38eab22019-12-05 21:50:01 +01005722 // Ignore the "abort" flag if the abortion behavior has been changed due to
5723 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005724 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5725 || fcp->returned);
5726}
5727
5728/*
5729 * return TRUE if cookie indicates a function which "abort"s on errors.
5730 */
5731 int
5732func_has_abort(
5733 void *cookie)
5734{
5735 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5736}
5737
5738
5739/*
5740 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5741 * Don't do this when "Func" is already a partial that was bound
5742 * explicitly (pt_auto is FALSE).
5743 * Changes "rettv" in-place.
5744 * Returns the updated "selfdict_in".
5745 */
5746 dict_T *
5747make_partial(dict_T *selfdict_in, typval_T *rettv)
5748{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005749 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005750 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005751 char_u fname_buf[FLEN_FIXED + 1];
5752 int error;
5753 dict_T *selfdict = selfdict_in;
5754
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005755 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
5756 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005757 fp = rettv->vval.v_partial->pt_func;
5758 else
5759 {
5760 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005761 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005762 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005763 if (fname == NULL)
5764 {
5765 // There is no point binding a dict to a NULL function, just create
5766 // a function reference.
5767 rettv->v_type = VAR_FUNC;
5768 rettv->vval.v_string = NULL;
5769 }
5770 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00005771 {
5772 char_u *tofree = NULL;
5773
5774 // Translate "s:func" to the stored function name.
5775 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
5776 fp = find_func(fname, FALSE);
5777 vim_free(tofree);
5778 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005780
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005781 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005782 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005783 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005784
5785 if (pt != NULL)
5786 {
5787 pt->pt_refcount = 1;
5788 pt->pt_dict = selfdict;
5789 pt->pt_auto = TRUE;
5790 selfdict = NULL;
5791 if (rettv->v_type == VAR_FUNC)
5792 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005793 // Just a function: Take over the function name and use
5794 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005795 pt->pt_name = rettv->vval.v_string;
5796 }
5797 else
5798 {
5799 partial_T *ret_pt = rettv->vval.v_partial;
5800 int i;
5801
Bram Moolenaare38eab22019-12-05 21:50:01 +01005802 // Partial: copy the function name, use selfdict and copy
5803 // args. Can't take over name or args, the partial might
5804 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005805 if (ret_pt->pt_name != NULL)
5806 {
5807 pt->pt_name = vim_strsave(ret_pt->pt_name);
5808 func_ref(pt->pt_name);
5809 }
5810 else
5811 {
5812 pt->pt_func = ret_pt->pt_func;
5813 func_ptr_ref(pt->pt_func);
5814 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005815 if (ret_pt->pt_argc > 0)
5816 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005817 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005818 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005819 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005820 pt->pt_argc = 0;
5821 else
5822 {
5823 pt->pt_argc = ret_pt->pt_argc;
5824 for (i = 0; i < pt->pt_argc; i++)
5825 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5826 }
5827 }
5828 partial_unref(ret_pt);
5829 }
5830 rettv->v_type = VAR_PARTIAL;
5831 rettv->vval.v_partial = pt;
5832 }
5833 }
5834 return selfdict;
5835}
5836
5837/*
5838 * Return the name of the executed function.
5839 */
5840 char_u *
5841func_name(void *cookie)
5842{
5843 return ((funccall_T *)cookie)->func->uf_name;
5844}
5845
5846/*
5847 * Return the address holding the next breakpoint line for a funccall cookie.
5848 */
5849 linenr_T *
5850func_breakpoint(void *cookie)
5851{
5852 return &((funccall_T *)cookie)->breakpoint;
5853}
5854
5855/*
5856 * Return the address holding the debug tick for a funccall cookie.
5857 */
5858 int *
5859func_dbg_tick(void *cookie)
5860{
5861 return &((funccall_T *)cookie)->dbg_tick;
5862}
5863
5864/*
5865 * Return the nesting level for a funccall cookie.
5866 */
5867 int
5868func_level(void *cookie)
5869{
5870 return ((funccall_T *)cookie)->level;
5871}
5872
5873/*
5874 * Return TRUE when a function was ended by a ":return" command.
5875 */
5876 int
5877current_func_returned(void)
5878{
5879 return current_funccal->returned;
5880}
5881
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005882 int
5883free_unref_funccal(int copyID, int testing)
5884{
5885 int did_free = FALSE;
5886 int did_free_funccal = FALSE;
5887 funccall_T *fc, **pfc;
5888
5889 for (pfc = &previous_funccal; *pfc != NULL; )
5890 {
5891 if (can_free_funccal(*pfc, copyID))
5892 {
5893 fc = *pfc;
5894 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005895 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005896 did_free = TRUE;
5897 did_free_funccal = TRUE;
5898 }
5899 else
5900 pfc = &(*pfc)->caller;
5901 }
5902 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005903 // When a funccal was freed some more items might be garbage
5904 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005905 (void)garbage_collect(testing);
5906
5907 return did_free;
5908}
5909
5910/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005911 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005912 */
5913 static funccall_T *
5914get_funccal(void)
5915{
5916 int i;
5917 funccall_T *funccal;
5918 funccall_T *temp_funccal;
5919
5920 funccal = current_funccal;
5921 if (debug_backtrace_level > 0)
5922 {
5923 for (i = 0; i < debug_backtrace_level; i++)
5924 {
5925 temp_funccal = funccal->caller;
5926 if (temp_funccal)
5927 funccal = temp_funccal;
5928 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005929 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005930 debug_backtrace_level = i;
5931 }
5932 }
5933 return funccal;
5934}
5935
5936/*
5937 * Return the hashtable used for local variables in the current funccal.
5938 * Return NULL if there is no current funccal.
5939 */
5940 hashtab_T *
5941get_funccal_local_ht()
5942{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005943 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005944 return NULL;
5945 return &get_funccal()->l_vars.dv_hashtab;
5946}
5947
5948/*
5949 * Return the l: scope variable.
5950 * Return NULL if there is no current funccal.
5951 */
5952 dictitem_T *
5953get_funccal_local_var()
5954{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005955 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005956 return NULL;
5957 return &get_funccal()->l_vars_var;
5958}
5959
5960/*
5961 * Return the hashtable used for argument in the current funccal.
5962 * Return NULL if there is no current funccal.
5963 */
5964 hashtab_T *
5965get_funccal_args_ht()
5966{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005967 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005968 return NULL;
5969 return &get_funccal()->l_avars.dv_hashtab;
5970}
5971
5972/*
5973 * Return the a: scope variable.
5974 * Return NULL if there is no current funccal.
5975 */
5976 dictitem_T *
5977get_funccal_args_var()
5978{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005979 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005980 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005981 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005982}
5983
5984/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005985 * List function variables, if there is a function.
5986 */
5987 void
5988list_func_vars(int *first)
5989{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005990 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005991 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005992 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005993}
5994
5995/*
5996 * If "ht" is the hashtable for local variables in the current funccal, return
5997 * the dict that contains it.
5998 * Otherwise return NULL.
5999 */
6000 dict_T *
6001get_current_funccal_dict(hashtab_T *ht)
6002{
6003 if (current_funccal != NULL
6004 && ht == &current_funccal->l_vars.dv_hashtab)
6005 return &current_funccal->l_vars;
6006 return NULL;
6007}
6008
6009/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006010 * Search hashitem in parent scope.
6011 */
6012 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006013find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006014{
6015 funccall_T *old_current_funccal = current_funccal;
6016 hashtab_T *ht;
6017 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006018 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006019
6020 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6021 return NULL;
6022
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006023 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006024 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006025 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006026 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006027 ht = find_var_ht(name, &varname);
6028 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006029 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006030 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006031 if (!HASHITEM_EMPTY(hi))
6032 {
6033 *pht = ht;
6034 break;
6035 }
6036 }
6037 if (current_funccal == current_funccal->func->uf_scoped)
6038 break;
6039 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006040 }
6041 current_funccal = old_current_funccal;
6042
6043 return hi;
6044}
6045
6046/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006047 * Search variable in parent scope.
6048 */
6049 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006050find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006051{
6052 dictitem_T *v = NULL;
6053 funccall_T *old_current_funccal = current_funccal;
6054 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006055 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006056
6057 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6058 return NULL;
6059
Bram Moolenaare38eab22019-12-05 21:50:01 +01006060 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006061 current_funccal = current_funccal->func->uf_scoped;
6062 while (current_funccal)
6063 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006064 ht = find_var_ht(name, &varname);
6065 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006066 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006067 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006068 if (v != NULL)
6069 break;
6070 }
6071 if (current_funccal == current_funccal->func->uf_scoped)
6072 break;
6073 current_funccal = current_funccal->func->uf_scoped;
6074 }
6075 current_funccal = old_current_funccal;
6076
6077 return v;
6078}
6079
6080/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006081 * Set "copyID + 1" in previous_funccal and callers.
6082 */
6083 int
6084set_ref_in_previous_funccal(int copyID)
6085{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006086 funccall_T *fc;
6087
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006088 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006089 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006090 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006091 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6092 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6093 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6094 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006095 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006096 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006097}
6098
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006099 static int
6100set_ref_in_funccal(funccall_T *fc, int copyID)
6101{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006102 if (fc->fc_copyID != copyID)
6103 {
6104 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006105 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6106 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6107 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6108 || set_ref_in_func(NULL, fc->func, copyID))
6109 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006110 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006111 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006112}
6113
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006114/*
6115 * Set "copyID" in all local vars and arguments in the call stack.
6116 */
6117 int
6118set_ref_in_call_stack(int copyID)
6119{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006120 funccall_T *fc;
6121 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006122
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006123 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6124 if (set_ref_in_funccal(fc, copyID))
6125 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006126
6127 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006128 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6129 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6130 if (set_ref_in_funccal(fc, copyID))
6131 return TRUE;
6132 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006133}
6134
6135/*
6136 * Set "copyID" in all functions available by name.
6137 */
6138 int
6139set_ref_in_functions(int copyID)
6140{
6141 int todo;
6142 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006143 ufunc_T *fp;
6144
6145 todo = (int)func_hashtab.ht_used;
6146 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006147 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006148 if (!HASHITEM_EMPTY(hi))
6149 {
6150 --todo;
6151 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006152 if (!func_name_refcount(fp->uf_name)
6153 && set_ref_in_func(NULL, fp, copyID))
6154 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006155 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006156 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006157 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006158}
6159
6160/*
6161 * Set "copyID" in all function arguments.
6162 */
6163 int
6164set_ref_in_func_args(int copyID)
6165{
6166 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006167
6168 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006169 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6170 copyID, NULL, NULL))
6171 return TRUE;
6172 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006173}
6174
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006175/*
6176 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006177 * Returns TRUE if setting references failed somehow.
6178 */
6179 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006180set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006181{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006182 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006183 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006184 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006185 char_u fname_buf[FLEN_FIXED + 1];
6186 char_u *tofree = NULL;
6187 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006188 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006189
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006190 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006191 return FALSE;
6192
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006193 if (fp_in == NULL)
6194 {
6195 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006196 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006197 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006198 if (fp != NULL)
6199 {
6200 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006201 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006202 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006203
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006204 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006205 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006206}
6207
Bram Moolenaare38eab22019-12-05 21:50:01 +01006208#endif // FEAT_EVAL