blob: 6a5d84bfd51d6905dcdbd20a1c5808f5dbdcff8d [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;
432 }
433 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100434 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200435
436 if (varargs)
437 {
438 char_u *p;
439
440 // Move the last argument "...name: type" to uf_va_name and
441 // uf_va_type.
442 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
443 [fp->uf_args.ga_len - 1];
444 --fp->uf_args.ga_len;
445 p = ((char_u **)argtypes->ga_data)[len];
446 if (p == NULL)
447 // TODO: get type from default value
448 fp->uf_va_type = &t_list_any;
449 else
450 {
451 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
452 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
453 {
454 semsg(_(e_variable_arguments_type_must_be_list_str),
455 ((char_u **)argtypes->ga_data)[len]);
456 return FAIL;
457 }
458 }
459 if (fp->uf_va_type == NULL)
460 return FAIL;
461 }
462
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100463 return OK;
464}
465
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100466 static int
467parse_return_type(ufunc_T *fp, char_u *ret_type)
468{
469 if (ret_type == NULL)
470 fp->uf_ret_type = &t_void;
471 else
472 {
473 char_u *p = ret_type;
474
475 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
476 if (fp->uf_ret_type == NULL)
477 {
478 fp->uf_ret_type = &t_void;
479 return FAIL;
480 }
481 }
482 return OK;
483}
484
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100485/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200486 * Register function "fp" as using "current_funccal" as its scope.
487 */
488 static int
489register_closure(ufunc_T *fp)
490{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200491 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100492 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200493 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200494 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 fp->uf_scoped = current_funccal;
496 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497
Bram Moolenaar58016442016-07-31 18:30:22 +0200498 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
499 return FAIL;
500 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
501 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200502 return OK;
503}
504
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100505 static void
506set_ufunc_name(ufunc_T *fp, char_u *name)
507{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100508 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
509 // actually extends beyond the struct.
510 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100511
512 if (name[0] == K_SPECIAL)
513 {
514 fp->uf_name_exp = alloc(STRLEN(name) + 3);
515 if (fp->uf_name_exp != NULL)
516 {
517 STRCPY(fp->uf_name_exp, "<SNR>");
518 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
519 }
520 }
521}
522
Bram Moolenaar58016442016-07-31 18:30:22 +0200523/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200524 * Get a name for a lambda. Returned in static memory.
525 */
526 char_u *
527get_lambda_name(void)
528{
529 static char_u name[30];
530 static int lambda_no = 0;
531
532 sprintf((char*)name, "<lambda>%d", ++lambda_no);
533 return name;
534}
535
Bram Moolenaar801ab062020-06-25 19:27:56 +0200536#if defined(FEAT_LUA) || defined(PROTO)
537/*
538 * Registers a native C callback which can be called from Vim script.
539 * Returns the name of the Vim script function.
540 */
541 char_u *
542register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
543{
544 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200545 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200546
547 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
548 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200549 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200550
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200551 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200552 fp->uf_refcount = 1;
553 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000554 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200555 fp->uf_calls = 0;
556 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200557 fp->uf_cb = cb;
558 fp->uf_cb_free = cb_free;
559 fp->uf_cb_state = state;
560
561 set_ufunc_name(fp, name);
562 hash_add(&func_hashtab, UF2HIKEY(fp));
563
564 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200565}
566#endif
567
Bram Moolenaar04b12692020-05-04 23:24:44 +0200568/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100569 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100570 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100571 * If "white_error" is not NULL check for correct use of white space and set
572 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100573 * Return NULL if no valid arrow found.
574 */
575 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576skip_arrow(
577 char_u *start,
578 int equal_arrow,
579 char_u **ret_type,
580 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100581{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100582 char_u *s = start;
583 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100584
585 if (equal_arrow)
586 {
587 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100588 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100589 if (white_error != NULL && !VIM_ISWHITE(s[1]))
590 {
591 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100592 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100593 return NULL;
594 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100595 s = skipwhite(s + 1);
596 *ret_type = s;
597 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100598 if (s == *ret_type)
599 {
600 emsg(_(e_missing_return_type));
601 return NULL;
602 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100603 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100604 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100605 s = skipwhite(s);
606 if (*s != '=')
607 return NULL;
608 ++s;
609 }
610 if (*s != '>')
611 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100612 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
613 || !IS_WHITE_OR_NUL(s[1])))
614 {
615 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100616 semsg(_(e_white_space_required_before_and_after_str_at_str),
617 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100618 return NULL;
619 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100620 return skipwhite(s + 1);
621}
622
623/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100624 * Check if "*cmd" points to a function command and if so advance "*cmd" and
625 * return TRUE.
626 * Otherwise return FALSE;
627 * Do not consider "function(" to be a command.
628 */
629 static int
630is_function_cmd(char_u **cmd)
631{
632 char_u *p = *cmd;
633
634 if (checkforcmd(&p, "function", 2))
635 {
636 if (*p == '(')
637 return FALSE;
638 *cmd = p;
639 return TRUE;
640 }
641 return FALSE;
642}
643
644/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200645 * Called when defining a function: The context may be needed for script
646 * variables declared in a block that is visible now but not when the function
647 * is compiled or called later.
648 */
649 static void
650function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
651{
652 if (cstack != NULL && cstack->cs_idx >= 0)
653 {
654 int count = cstack->cs_idx + 1;
655 int i;
656
657 fp->uf_block_ids = ALLOC_MULT(int, count);
658 if (fp->uf_block_ids != NULL)
659 {
660 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
661 sizeof(int) * count);
662 fp->uf_block_depth = count;
663 }
664
665 // Set flag in each block to indicate a function was defined. This
666 // is used to keep the variable when leaving the block, see
667 // hide_script_var().
668 for (i = 0; i <= cstack->cs_idx; ++i)
669 cstack->cs_flags[i] |= CSF_FUNC_DEF;
670 }
671}
672
673/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100674 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200675 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100676 * "newlines" must already have been initialized.
677 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
678 */
679 static int
680get_function_body(
681 exarg_T *eap,
682 garray_T *newlines,
683 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000684 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100685{
686 linenr_T sourcing_lnum_top = SOURCING_LNUM;
687 linenr_T sourcing_lnum_off;
688 int saved_wait_return = need_wait_return;
689 char_u *line_arg = line_arg_in;
690 int vim9_function = eap->cmdidx == CMD_def
691 || eap->cmdidx == CMD_block;
692#define MAX_FUNC_NESTING 50
693 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200694 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100695 int nesting = 0;
696 getline_opt_T getline_options;
697 int indent = 2;
698 char_u *skip_until = NULL;
699 int ret = FAIL;
700 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200701 int heredoc_concat_len = 0;
702 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100703 char_u *heredoc_trimmed = NULL;
704
Bram Moolenaar20677332021-06-06 17:02:53 +0200705 ga_init2(&heredoc_ga, 1, 500);
706
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100707 // Detect having skipped over comment lines to find the return
708 // type. Add NULL lines to keep the line count correct.
709 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
710 if (SOURCING_LNUM < sourcing_lnum_off)
711 {
712 sourcing_lnum_off -= SOURCING_LNUM;
713 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
714 goto theend;
715 while (sourcing_lnum_off-- > 0)
716 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
717 }
718
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200719 nesting_def[0] = vim9_function;
720 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100721 getline_options = vim9_function
722 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
723 for (;;)
724 {
725 char_u *theline;
726 char_u *p;
727 char_u *arg;
728
729 if (KeyTyped)
730 {
731 msg_scroll = TRUE;
732 saved_wait_return = FALSE;
733 }
734 need_wait_return = FALSE;
735
736 if (line_arg != NULL)
737 {
738 // Use eap->arg, split up in parts by line breaks.
739 theline = line_arg;
740 p = vim_strchr(theline, '\n');
741 if (p == NULL)
742 line_arg += STRLEN(line_arg);
743 else
744 {
745 *p = NUL;
746 line_arg = p + 1;
747 }
748 }
749 else
750 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000751 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100752 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100753 }
754 if (KeyTyped)
755 lines_left = Rows - 1;
756 if (theline == NULL)
757 {
758 // Use the start of the function for the line number.
759 SOURCING_LNUM = sourcing_lnum_top;
760 if (skip_until != NULL)
761 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200762 else if (nesting_inline[nesting])
763 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100764 else if (eap->cmdidx == CMD_def)
765 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100766 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000767 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100768 goto theend;
769 }
770
771 // Detect line continuation: SOURCING_LNUM increased more than one.
772 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
773 if (SOURCING_LNUM < sourcing_lnum_off)
774 sourcing_lnum_off -= SOURCING_LNUM;
775 else
776 sourcing_lnum_off = 0;
777
778 if (skip_until != NULL)
779 {
780 // Don't check for ":endfunc"/":enddef" between
781 // * ":append" and "."
782 // * ":python <<EOF" and "EOF"
783 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
784 if (heredoc_trimmed == NULL
785 || (is_heredoc && skipwhite(theline) == theline)
786 || STRNCMP(theline, heredoc_trimmed,
787 STRLEN(heredoc_trimmed)) == 0)
788 {
789 if (heredoc_trimmed == NULL)
790 p = theline;
791 else if (is_heredoc)
792 p = skipwhite(theline) == theline
793 ? theline : theline + STRLEN(heredoc_trimmed);
794 else
795 p = theline + STRLEN(heredoc_trimmed);
796 if (STRCMP(p, skip_until) == 0)
797 {
798 VIM_CLEAR(skip_until);
799 VIM_CLEAR(heredoc_trimmed);
800 getline_options = vim9_function
801 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
802 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200803
804 if (heredoc_concat_len > 0)
805 {
806 // Replace the starting line with all the concatenated
807 // lines.
808 ga_concat(&heredoc_ga, theline);
809 vim_free(((char_u **)(newlines->ga_data))[
810 heredoc_concat_len - 1]);
811 ((char_u **)(newlines->ga_data))[
812 heredoc_concat_len - 1] = heredoc_ga.ga_data;
813 ga_init(&heredoc_ga);
814 heredoc_concat_len = 0;
815 theline += STRLEN(theline); // skip the "EOF"
816 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100817 }
818 }
819 }
820 else
821 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200822 int c;
823 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000824 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100825
826 // skip ':' and blanks
827 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
828 ;
829
830 // Check for "endfunction", "enddef" or "}".
831 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000832 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200833 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100834 ? *p == '}'
835 : (checkforcmd(&p, nesting_def[nesting]
836 ? "enddef" : "endfunction", 4)
837 && *p != ':'))
838 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000839 if (!nesting_inline[nesting] && nesting_def[nesting]
840 && p < cmd + 6)
841 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100842 if (nesting-- == 0)
843 {
844 char_u *nextcmd = NULL;
845
846 if (*p == '|' || *p == '}')
847 nextcmd = p + 1;
848 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
849 nextcmd = line_arg;
850 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100851 && (vim9_function || p_verbose > 0))
852 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200853 SOURCING_LNUM = sourcing_lnum_top
854 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100855 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000856 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100857 else
858 give_warning2((char_u *)
859 _("W22: Text found after :endfunction: %s"),
860 p, TRUE);
861 }
862 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100863 {
864 // Another command follows. If the line came from "eap"
865 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000866 // change "eap->cmdlinep" to point to the last fetched
867 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000869 if (lines_to_free->ga_len > 0
870 && *eap->cmdlinep !=
871 ((char_u **)lines_to_free->ga_data)
872 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100873 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000874 // *cmdlinep will be freed later, thus remove the
875 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100876 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000877 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
878 [lines_to_free->ga_len - 1];
879 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100880 }
881 }
882 break;
883 }
884 }
885
886 // Check for mismatched "endfunc" or "enddef".
887 // We don't check for "def" inside "func" thus we also can't check
888 // for "enddef".
889 // We continue to find the end of the function, although we might
890 // not find it.
891 else if (nesting_def[nesting])
892 {
893 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
894 emsg(_(e_mismatched_endfunction));
895 }
896 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
897 emsg(_(e_mismatched_enddef));
898
899 // Increase indent inside "if", "while", "for" and "try", decrease
900 // at "end".
901 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
902 indent -= 2;
903 else if (STRNCMP(p, "if", 2) == 0
904 || STRNCMP(p, "wh", 2) == 0
905 || STRNCMP(p, "for", 3) == 0
906 || STRNCMP(p, "try", 3) == 0)
907 indent += 2;
908
909 // Check for defining a function inside this function.
910 // Only recognize "def" inside "def", not inside "function",
911 // For backwards compatibility, see Test_function_python().
912 c = *p;
913 if (is_function_cmd(&p)
914 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
915 {
916 if (*p == '!')
917 p = skipwhite(p + 1);
918 p += eval_fname_script(p);
919 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
920 NULL, NULL));
921 if (*skipwhite(p) == '(')
922 {
923 if (nesting == MAX_FUNC_NESTING - 1)
924 emsg(_(e_function_nesting_too_deep));
925 else
926 {
927 ++nesting;
928 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200929 nesting_inline[nesting] = FALSE;
930 indent += 2;
931 }
932 }
933 }
934
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200935 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200936 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200937 // Not a comment line: check for nested inline function.
938 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200939 while (end > p && VIM_ISWHITE(*end))
940 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200941 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200942 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200943 int is_block;
944
945 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200946 --end;
947 while (end > p && VIM_ISWHITE(*end))
948 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200949 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
950 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200951 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200952 char_u *s = p;
953
954 // check for line starting with "au" for :autocmd or
955 // "com" for :command, these can use a {} block
956 is_block = checkforcmd_noparen(&s, "autocmd", 2)
957 || checkforcmd_noparen(&s, "command", 3);
958 }
959
960 if (is_block)
961 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200962 if (nesting == MAX_FUNC_NESTING - 1)
963 emsg(_(e_function_nesting_too_deep));
964 else
965 {
966 ++nesting;
967 nesting_def[nesting] = TRUE;
968 nesting_inline[nesting] = TRUE;
969 indent += 2;
970 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100971 }
972 }
973 }
974
975 // Check for ":append", ":change", ":insert". Not for :def.
976 p = skip_range(p, FALSE, NULL);
977 if (!vim9_function
978 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
979 || (p[0] == 'c'
980 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
981 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
982 && (STRNCMP(&p[3], "nge", 3) != 0
983 || !ASCII_ISALPHA(p[6])))))))
984 || (p[0] == 'i'
985 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
986 && (!ASCII_ISALPHA(p[2])
987 || (p[2] == 's'
988 && (!ASCII_ISALPHA(p[3])
989 || p[3] == 'e'))))))))
990 skip_until = vim_strsave((char_u *)".");
991
992 // Check for ":python <<EOF", ":tcl <<EOF", etc.
993 arg = skipwhite(skiptowhite(p));
994 if (arg[0] == '<' && arg[1] =='<'
995 && ((p[0] == 'p' && p[1] == 'y'
996 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
997 || ((p[2] == '3' || p[2] == 'x')
998 && !ASCII_ISALPHA(p[3]))))
999 || (p[0] == 'p' && p[1] == 'e'
1000 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1001 || (p[0] == 't' && p[1] == 'c'
1002 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1003 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1004 && !ASCII_ISALPHA(p[3]))
1005 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1006 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1007 || (p[0] == 'm' && p[1] == 'z'
1008 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1009 ))
1010 {
1011 // ":python <<" continues until a dot, like ":append"
1012 p = skipwhite(arg + 2);
1013 if (STRNCMP(p, "trim", 4) == 0)
1014 {
1015 // Ignore leading white space.
1016 p = skipwhite(p + 4);
1017 heredoc_trimmed = vim_strnsave(theline,
1018 skipwhite(theline) - theline);
1019 }
1020 if (*p == NUL)
1021 skip_until = vim_strsave((char_u *)".");
1022 else
1023 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1024 getline_options = GETLINE_NONE;
1025 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001026 if (eap->cmdidx == CMD_def)
1027 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001028 }
1029
1030 // Check for ":cmd v =<< [trim] EOF"
1031 // and ":cmd [a, b] =<< [trim] EOF"
1032 // and "lines =<< [trim] EOF" for Vim9
1033 // Where "cmd" can be "let", "var", "final" or "const".
1034 arg = skipwhite(skiptowhite(p));
1035 if (*arg == '[')
1036 arg = vim_strchr(arg, ']');
1037 if (arg != NULL)
1038 {
1039 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1040 && arg[1] == '<' && arg[2] =='<');
1041
1042 if (!found)
1043 // skip over the argument after "cmd"
1044 arg = skipwhite(skiptowhite(arg));
1045 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1046 && (checkforcmd(&p, "let", 2)
1047 || checkforcmd(&p, "var", 3)
1048 || checkforcmd(&p, "final", 5)
1049 || checkforcmd(&p, "const", 5))))
1050 {
1051 p = skipwhite(arg + 3);
1052 if (STRNCMP(p, "trim", 4) == 0)
1053 {
1054 // Ignore leading white space.
1055 p = skipwhite(p + 4);
1056 heredoc_trimmed = vim_strnsave(theline,
1057 skipwhite(theline) - theline);
1058 }
1059 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1060 getline_options = GETLINE_NONE;
1061 is_heredoc = TRUE;
1062 }
1063 }
1064 }
1065
1066 // Add the line to the function.
1067 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1068 goto theend;
1069
Bram Moolenaar20677332021-06-06 17:02:53 +02001070 if (heredoc_concat_len > 0)
1071 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001072 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001073 // to be used for the instruction later.
1074 ga_concat(&heredoc_ga, theline);
1075 ga_concat(&heredoc_ga, (char_u *)"\n");
1076 p = vim_strsave((char_u *)"");
1077 }
1078 else
1079 {
1080 // Copy the line to newly allocated memory. get_one_sourceline()
1081 // allocates 250 bytes per line, this saves 80% on average. The
1082 // cost is an extra alloc/free.
1083 p = vim_strsave(theline);
1084 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001085 if (p == NULL)
1086 goto theend;
1087 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1088
1089 // Add NULL lines for continuation lines, so that the line count is
1090 // equal to the index in the growarray.
1091 while (sourcing_lnum_off-- > 0)
1092 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1093
1094 // Check for end of eap->arg.
1095 if (line_arg != NULL && *line_arg == NUL)
1096 line_arg = NULL;
1097 }
1098
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001099 // Return OK when no error was detected.
1100 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001101 ret = OK;
1102
1103theend:
1104 vim_free(skip_until);
1105 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001106 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 need_wait_return |= saved_wait_return;
1108 return ret;
1109}
1110
1111/*
1112 * Handle the body of a lambda. *arg points to the "{", process statements
1113 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001114 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001115 * When successful "rettv" is set to a funcref.
1116 */
1117 static int
1118lambda_function_body(
1119 char_u **arg,
1120 typval_T *rettv,
1121 evalarg_T *evalarg,
1122 garray_T *newargs,
1123 garray_T *argtypes,
1124 int varargs,
1125 garray_T *default_args,
1126 char_u *ret_type)
1127{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001128 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001129 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001130 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001131 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001132 exarg_T eap;
1133 garray_T newlines;
1134 char_u *cmdline = NULL;
1135 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001136 partial_T *pt;
1137 char_u *name;
1138 int lnum_save = -1;
1139 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1140
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001141 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1142 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001143 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001144 return FAIL;
1145 }
1146
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001147 CLEAR_FIELD(eap);
1148 eap.cmdidx = CMD_block;
1149 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001150 eap.cmdlinep = &cmdline;
1151 eap.skip = !evaluate;
1152 if (evalarg->eval_cctx != NULL)
1153 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1154 else
1155 {
1156 eap.getline = evalarg->eval_getline;
1157 eap.cookie = evalarg->eval_cookie;
1158 }
1159
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001160 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001161 if (get_function_body(&eap, &newlines, NULL,
1162 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001163 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001164
1165 // When inside a lambda must add the function lines to evalarg.eval_ga.
1166 evalarg->eval_break_count += newlines.ga_len;
1167 if (gap->ga_itemsize > 0)
1168 {
1169 int idx;
1170 char_u *last;
1171 size_t plen;
1172 char_u *pnl;
1173
1174 for (idx = 0; idx < newlines.ga_len; ++idx)
1175 {
1176 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1177
Bram Moolenaarecb66452021-05-18 15:09:18 +02001178 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001179 goto erret;
1180
1181 // Going to concatenate the lines after parsing. For an empty or
1182 // comment line use an empty string.
1183 // Insert NL characters at the start of each line, the string will
1184 // be split again later in .get_lambda_tv().
1185 if (*p == NUL || vim9_comment_start(p))
1186 p = (char_u *)"";
1187 plen = STRLEN(p);
1188 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1189 if (pnl != NULL)
1190 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001191 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1192 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001193 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001194 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001195 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001196 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001197 // more is following after the "}", which was skipped
1198 last = cmdline;
1199 else
1200 // nothing is following the "}"
1201 last = (char_u *)"}";
1202 plen = STRLEN(last);
1203 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1204 if (pnl != NULL)
1205 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001206 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1207 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001208 }
1209
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001210 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001211 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001212 garray_T *tfgap = &evalarg->eval_tofree_ga;
1213
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001214 // Something comes after the "}".
1215 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001216
1217 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001218 if (ga_grow(tfgap, 1) == OK)
1219 {
1220 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1221 evalarg->eval_using_cmdline = TRUE;
1222 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001223 }
1224 else
1225 *arg = (char_u *)"";
1226
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001227 if (!evaluate)
1228 {
1229 ret = OK;
1230 goto erret;
1231 }
1232
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001233 name = get_lambda_name();
1234 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1235 if (ufunc == NULL)
1236 goto erret;
1237 set_ufunc_name(ufunc, name);
1238 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001239 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001240 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001241 ufunc->uf_refcount = 1;
1242 ufunc->uf_args = *newargs;
1243 newargs->ga_data = NULL;
1244 ufunc->uf_def_args = *default_args;
1245 default_args->ga_data = NULL;
1246 ufunc->uf_func_type = &t_func_any;
1247
1248 // error messages are for the first function line
1249 lnum_save = SOURCING_LNUM;
1250 SOURCING_LNUM = sourcing_lnum_top;
1251
1252 // parse argument types
1253 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1254 {
1255 SOURCING_LNUM = lnum_save;
1256 goto erret;
1257 }
1258
1259 // parse the return type, if any
1260 if (parse_return_type(ufunc, ret_type) == FAIL)
1261 goto erret;
1262
1263 pt = ALLOC_CLEAR_ONE(partial_T);
1264 if (pt == NULL)
1265 goto erret;
1266 pt->pt_func = ufunc;
1267 pt->pt_refcount = 1;
1268
1269 ufunc->uf_lines = newlines;
1270 newlines.ga_data = NULL;
1271 if (sandbox)
1272 ufunc->uf_flags |= FC_SANDBOX;
1273 if (!ASCII_ISUPPER(*ufunc->uf_name))
1274 ufunc->uf_flags |= FC_VIM9;
1275 ufunc->uf_script_ctx = current_sctx;
1276 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1277 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1278 set_function_type(ufunc);
1279
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001280 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1281
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 rettv->vval.v_partial = pt;
1283 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001284 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 ret = OK;
1286
1287erret:
1288 if (lnum_save >= 0)
1289 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001290 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001291 if (newargs != NULL)
1292 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001293 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001294 if (ufunc != NULL)
1295 {
1296 func_clear(ufunc, TRUE);
1297 func_free(ufunc, TRUE);
1298 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001299 return ret;
1300}
1301
1302/*
1303 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001304 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001305 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001306 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1307 */
1308 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001309get_lambda_tv(
1310 char_u **arg,
1311 typval_T *rettv,
1312 int types_optional,
1313 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001315 int evaluate = evalarg != NULL
1316 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 garray_T newargs;
1318 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001319 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001320 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001321 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001322 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001323 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001325 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001326 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001327 char_u *s;
1328 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001329 int *old_eval_lavars = eval_lavars_used;
1330 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001331 char_u *tofree1 = NULL;
1332 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001333 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001334 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001335 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001336 int vim9script = in_vim9script();
Bram Moolenaar65c44152020-12-24 15:14:01 +01001337
Bram Moolenaar4525a572022-02-13 11:57:33 +00001338 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001339 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001340
1341 ga_init(&newargs);
1342 ga_init(&newlines);
1343
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001344 // First, check if this is really a lambda expression. "->" or "=>" must
1345 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001346 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001347 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001348 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001349 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001350 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001351 {
1352 if (types_optional)
1353 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001354 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001355 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001357 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001358 if (evaluate)
1359 pnewargs = &newargs;
1360 else
1361 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001362 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001363 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001364 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001365 &varargs, &default_args,
1366 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001367 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001368 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001369 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001370 {
1371 if (types_optional)
1372 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001373 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001374 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001375 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001376 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001377
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001378 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1379 if (ret_type != NULL)
1380 {
1381 ret_type = vim_strsave(ret_type);
1382 tofree2 = ret_type;
1383 }
1384
Bram Moolenaare38eab22019-12-05 21:50:01 +01001385 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001386 if (evaluate)
1387 eval_lavars_used = &eval_lavars;
1388
Bram Moolenaar65c44152020-12-24 15:14:01 +01001389 *arg = skipwhite_and_linebreak(*arg, evalarg);
1390
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001391 // Recognize "{" as the start of a function body.
1392 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001393 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001394 if (evalarg == NULL)
1395 // cannot happen?
1396 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001397 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1398 types_optional ? &argtypes : NULL, varargs,
1399 &default_args, ret_type) == FAIL)
1400 goto errret;
1401 goto theend;
1402 }
1403 if (default_args.ga_len > 0)
1404 {
1405 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001406 goto errret;
1407 }
1408
Bram Moolenaare38eab22019-12-05 21:50:01 +01001409 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001410 start = *arg;
1411 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001412 if (ret == FAIL)
1413 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001414 if (evalarg != NULL)
1415 {
1416 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001417 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001418 evalarg->eval_tofree = NULL;
1419 }
1420
Bram Moolenaar65c44152020-12-24 15:14:01 +01001421 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001422 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001423 *arg = skipwhite_and_linebreak(*arg, evalarg);
1424 if (**arg != '}')
1425 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001426 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001427 goto errret;
1428 }
1429 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001430 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001431
1432 if (evaluate)
1433 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001434 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001435 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001436 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001437 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001438 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001439
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001440 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001441 if (fp == NULL)
1442 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001443 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001444 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001445 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001446 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001448 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449 if (ga_grow(&newlines, 1) == FAIL)
1450 goto errret;
1451
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001452 // If there are line breaks, we need to split up the string.
1453 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001454 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001455 line_end = end;
1456
1457 // Add "return " before the expression (or the first line).
1458 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001459 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460 if (p == NULL)
1461 goto errret;
1462 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1463 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001464 vim_strncpy(p + 7, start, line_end - start);
1465
1466 if (line_end != end)
1467 {
1468 // Add more lines, split by line breaks. Thus is used when a
1469 // lambda with { cmds } is encountered.
1470 while (*line_end == '\n')
1471 {
1472 if (ga_grow(&newlines, 1) == FAIL)
1473 goto errret;
1474 start = line_end + 1;
1475 line_end = vim_strchr(start, '\n');
1476 if (line_end == NULL)
1477 line_end = end;
1478 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1479 vim_strnsave(start, line_end - start);
1480 }
1481 }
1482
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001483 if (strstr((char *)p + 7, "a:") == NULL)
1484 // No a: variables are used for sure.
1485 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486
1487 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001488 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001489 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001490 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001491 if (types_optional)
1492 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001493 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001494 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001495 goto errret;
1496 if (ret_type != NULL)
1497 {
1498 fp->uf_ret_type = parse_type(&ret_type,
1499 &fp->uf_type_list, TRUE);
1500 if (fp->uf_ret_type == NULL)
1501 goto errret;
1502 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001503 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001504 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001505 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001506
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001508 if (current_funccal != NULL && eval_lavars)
1509 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001510 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001511 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001512 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001513 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001514
1515#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 if (prof_def_func())
1517 func_do_profile(fp);
1518#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001519 if (sandbox)
1520 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001521 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001522 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001523 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001524 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001526 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001527 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001529 function_using_block_scopes(fp, evalarg->eval_cstack);
1530
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001531 pt->pt_func = fp;
1532 pt->pt_refcount = 1;
1533 rettv->vval.v_partial = pt;
1534 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001535
1536 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001538
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001539theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001540 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001541 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001542 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001543 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001544 vim_free(tofree1);
1545 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001546 if (types_optional)
1547 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001548
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549 return OK;
1550
1551errret:
1552 ga_clear_strings(&newargs);
1553 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001554 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001555 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001556 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001557 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001558 if (fp != NULL)
1559 vim_free(fp->uf_arg_types);
1560 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001562 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001563 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001564 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001565 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001566 vim_free(tofree1);
1567 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001568 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001569 return FAIL;
1570}
1571
1572/*
1573 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1574 * name it contains, otherwise return "name".
1575 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1576 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001577 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1578 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001579 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001580 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001581 */
1582 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001583deref_func_name(
1584 char_u *name,
1585 int *lenp,
1586 partial_T **partialp,
1587 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001588 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001589 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001590 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001591{
1592 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001593 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001595 char_u *s = NULL;
1596 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001597 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598
1599 if (partialp != NULL)
1600 *partialp = NULL;
1601
1602 cc = name[*lenp];
1603 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001604
Bram Moolenaar71f21932022-01-07 18:20:55 +00001605 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001606 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001607 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001609 tv = &v->di_tv;
1610 }
1611 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1612 {
1613 imported_T *import;
1614 char_u *p = name;
1615 int len = *lenp;
1616
1617 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001619 p = name + 2;
1620 len -= 2;
1621 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001622 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001623
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001624 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001625 if (import != NULL)
1626 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001627 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001628 if (new_function)
1629 semsg(_(e_redefining_imported_item_str), name);
1630 else
1631 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001632 name[len] = cc;
1633 *lenp = 0;
1634 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001635 }
1636 }
1637
1638 if (tv != NULL)
1639 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001640 if (found_var != NULL)
1641 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001642 if (tv->v_type == VAR_FUNC)
1643 {
1644 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001645 {
1646 *lenp = 0;
1647 return (char_u *)""; // just in case
1648 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001649 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001650 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001651 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001653 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001655 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001656
1657 if (pt == NULL)
1658 {
1659 *lenp = 0;
1660 return (char_u *)""; // just in case
1661 }
1662 if (partialp != NULL)
1663 *partialp = pt;
1664 s = partial_name(pt);
1665 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001666 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001667
1668 if (s != NULL)
1669 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001670 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001671 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001672 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001673
1674 if (sv != NULL)
1675 *type = sv->sv_type;
1676 }
1677 return s;
1678 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679 }
1680
1681 return name;
1682}
1683
1684/*
1685 * Give an error message with a function name. Handle <SNR> things.
1686 * "ermsg" is to be passed without translation, use N_() instead of _().
1687 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001688 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001689emsg_funcname(char *ermsg, char_u *name)
1690{
Bram Moolenaar54598062022-01-13 12:05:09 +00001691 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692
Bram Moolenaar54598062022-01-13 12:05:09 +00001693 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001695 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 if (p != name)
1697 vim_free(p);
1698}
1699
1700/*
1701 * Allocate a variable for the result of a function.
1702 * Return OK or FAIL.
1703 */
1704 int
1705get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001706 char_u *name, // name of the function
1707 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001709 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001710 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001711 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001712{
1713 char_u *argp;
1714 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001715 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1716 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001717 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001718 int evaluate = evalarg == NULL
1719 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720
1721 /*
1722 * Get the arguments.
1723 */
1724 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001725 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1726 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001727 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001728 // skip the '(' or ',' and possibly line breaks
1729 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1730
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001731 if (*argp == ')' || *argp == ',' || *argp == NUL)
1732 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001733 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734 {
1735 ret = FAIL;
1736 break;
1737 }
1738 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001739 // The comma should come right after the argument, but this wasn't
1740 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001741 if (vim9script)
1742 {
1743 if (*argp != ',' && *skipwhite(argp) == ',')
1744 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001745 if (evaluate)
1746 semsg(_(e_no_white_space_allowed_before_str_str),
1747 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001748 ret = FAIL;
1749 break;
1750 }
1751 }
1752 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001753 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754 if (*argp != ',')
1755 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001756 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1757 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001758 if (evaluate)
1759 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001760 ret = FAIL;
1761 break;
1762 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001763 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001764 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765 if (*argp == ')')
1766 ++argp;
1767 else
1768 ret = FAIL;
1769
1770 if (ret == OK)
1771 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001772 int i = 0;
1773 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001774
1775 if (get_vim_var_nr(VV_TESTING))
1776 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001777 // Prepare for calling test_garbagecollect_now(), need to know
1778 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001779 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001780 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001781 for (i = 0; i < argcount; ++i)
1782 if (ga_grow(&funcargs, 1) == OK)
1783 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1784 &argvars[i];
1785 }
1786
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001787 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001788 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001789 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001790 // An error in a builtin function does not return FAIL, but we do
1791 // want to abort further processing if an error was given.
1792 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001793 clear_tv(rettv);
1794 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795
1796 funcargs.ga_len -= i;
1797 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001798 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799 {
1800 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001801 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001803 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804 }
1805
1806 while (--argcount >= 0)
1807 clear_tv(&argvars[argcount]);
1808
Bram Moolenaar4525a572022-02-13 11:57:33 +00001809 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001810 *arg = argp;
1811 else
1812 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813 return ret;
1814}
1815
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816/*
1817 * Return TRUE if "p" starts with "<SID>" or "s:".
1818 * Only works if eval_fname_script() returned non-zero for "p"!
1819 */
1820 static int
1821eval_fname_sid(char_u *p)
1822{
1823 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1824}
1825
1826/*
1827 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1828 * Change <SNR>123_name() to K_SNR 123_name().
1829 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1830 * (slow).
1831 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001832 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1834{
1835 int llen;
1836 char_u *fname;
1837 int i;
1838
1839 llen = eval_fname_script(name);
1840 if (llen > 0)
1841 {
1842 fname_buf[0] = K_SPECIAL;
1843 fname_buf[1] = KS_EXTRA;
1844 fname_buf[2] = (int)KE_SNR;
1845 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001846 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001847 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001848 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001849 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 else
1851 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001852 sprintf((char *)fname_buf + 3, "%ld_",
1853 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 i = (int)STRLEN(fname_buf);
1855 }
1856 }
1857 if (i + STRLEN(name + llen) < FLEN_FIXED)
1858 {
1859 STRCPY(fname_buf + i, name + llen);
1860 fname = fname_buf;
1861 }
1862 else
1863 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001864 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001865 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001866 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001867 else
1868 {
1869 *tofree = fname;
1870 mch_memmove(fname, fname_buf, (size_t)i);
1871 STRCPY(fname + i, name + llen);
1872 }
1873 }
1874 }
1875 else
1876 fname = name;
1877 return fname;
1878}
1879
1880/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001881 * Find a function "name" in script "sid".
1882 */
1883 static ufunc_T *
1884find_func_with_sid(char_u *name, int sid)
1885{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001886 hashitem_T *hi;
1887 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888
Bram Moolenaarb8822442022-01-11 15:24:05 +00001889 if (!SCRIPT_ID_VALID(sid))
1890 return NULL; // not in a script
1891
1892 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001893 buffer[0] = K_SPECIAL;
1894 buffer[1] = KS_EXTRA;
1895 buffer[2] = (int)KE_SNR;
1896 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1897 (long)sid, name);
1898 hi = hash_find(&func_hashtab, buffer);
1899 if (!HASHITEM_EMPTY(hi))
1900 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001901 return NULL;
1902}
1903
1904/*
1905 * Find a function "name" in script "sid" prefixing the autoload prefix.
1906 */
1907 static ufunc_T *
1908find_func_with_prefix(char_u *name, int sid)
1909{
1910 hashitem_T *hi;
1911 char_u buffer[200];
1912 scriptitem_T *si;
1913
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001914 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001915 return NULL; // already has the prefix
1916 if (!SCRIPT_ID_VALID(sid))
1917 return NULL; // not in a script
1918 si = SCRIPT_ITEM(sid);
1919 if (si->sn_autoload_prefix != NULL)
1920 {
1921 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1922 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001923 char_u *namep;
1924
1925 // skip a "<SNR>99_" prefix
1926 namep = untrans_function_name(name);
1927 if (namep == NULL)
1928 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001929
1930 // An exported function in an autoload script is stored as
1931 // "dir#path#name".
1932 if (len < sizeof(buffer))
1933 auto_name = buffer;
1934 else
1935 auto_name = alloc(len);
1936 if (auto_name != NULL)
1937 {
1938 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001939 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001940 hi = hash_find(&func_hashtab, auto_name);
1941 if (auto_name != buffer)
1942 vim_free(auto_name);
1943 if (!HASHITEM_EMPTY(hi))
1944 return HI2UF(hi);
1945 }
1946 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001947
1948 return NULL;
1949}
1950
1951/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001952 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001953 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1954 * functions.
1955 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956 * Return NULL for unknown function.
1957 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001958 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001959find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001960{
1961 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001962 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001963
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001964 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001965 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00001966 // Find script-local function before global one.
1967 if (in_vim9script() && eval_isnamec1(*name)
1968 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001969 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001970 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1971 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001972 if (func != NULL)
1973 return func;
1974 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00001975 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
1976 {
1977 char_u *p = name + 5;
1978 long sid;
1979
1980 // printable "<SNR>123_Name" form
1981 sid = getdigits(&p);
1982 if (*p == '_')
1983 {
1984 func = find_func_with_sid(p + 1, (int)sid);
1985 if (func != NULL)
1986 return func;
1987 }
1988 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001989 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001990
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001991 if ((flags & FFED_NO_GLOBAL) == 0)
1992 {
1993 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02001994 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001995 if (!HASHITEM_EMPTY(hi))
1996 return HI2UF(hi);
1997 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998
Bram Moolenaarb8822442022-01-11 15:24:05 +00001999 // Find autoload function if this is an autoload script.
2000 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2001 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002002}
2003
2004/*
2005 * Find a function by name, return pointer to it in ufuncs.
2006 * "cctx" is passed in a :def function to find imported functions.
2007 * Return NULL for unknown or dead function.
2008 */
2009 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002010find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002011{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002012 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002013
2014 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2015 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 return NULL;
2017}
2018
2019/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002020 * Return TRUE if "ufunc" is a global function.
2021 */
2022 int
2023func_is_global(ufunc_T *ufunc)
2024{
2025 return ufunc->uf_name[0] != K_SPECIAL;
2026}
2027
2028/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002029 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2030 */
2031 int
2032func_requires_g_prefix(ufunc_T *ufunc)
2033{
2034 return ufunc->uf_name[0] != K_SPECIAL
2035 && (ufunc->uf_flags & FC_LAMBDA) == 0
2036 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2037}
2038
2039/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002040 * Copy the function name of "fp" to buffer "buf".
2041 * "buf" must be able to hold the function name plus three bytes.
2042 * Takes care of script-local function names.
2043 */
2044 static void
2045cat_func_name(char_u *buf, ufunc_T *fp)
2046{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002047 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002048 {
2049 STRCPY(buf, "<SNR>");
2050 STRCAT(buf, fp->uf_name + 3);
2051 }
2052 else
2053 STRCPY(buf, fp->uf_name);
2054}
2055
2056/*
2057 * Add a number variable "name" to dict "dp" with value "nr".
2058 */
2059 static void
2060add_nr_var(
2061 dict_T *dp,
2062 dictitem_T *v,
2063 char *name,
2064 varnumber_T nr)
2065{
2066 STRCPY(v->di_key, name);
2067 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2068 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2069 v->di_tv.v_type = VAR_NUMBER;
2070 v->di_tv.v_lock = VAR_FIXED;
2071 v->di_tv.vval.v_number = nr;
2072}
2073
2074/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002075 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002076 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002077 static void
2078free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002079{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002080 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002081
2082 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2083 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002084 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002085
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002086 // When garbage collecting a funccall_T may be freed before the
2087 // function that references it, clear its uf_scoped field.
2088 // The function may have been redefined and point to another
2089 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002090 if (fp != NULL && fp->uf_scoped == fc)
2091 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002092 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002093 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002094
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002095 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002096 vim_free(fc);
2097}
2098
2099/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002100 * Free "fc" and what it contains.
2101 * Can be called only when "fc" is kept beyond the period of it called,
2102 * i.e. after cleanup_function_call(fc).
2103 */
2104 static void
2105free_funccal_contents(funccall_T *fc)
2106{
2107 listitem_T *li;
2108
2109 // Free all l: variables.
2110 vars_clear(&fc->l_vars.dv_hashtab);
2111
2112 // Free all a: variables.
2113 vars_clear(&fc->l_avars.dv_hashtab);
2114
2115 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002116 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002117 clear_tv(&li->li_tv);
2118
2119 free_funccal(fc);
2120}
2121
2122/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002123 * Handle the last part of returning from a function: free the local hashtable.
2124 * Unless it is still in use by a closure.
2125 */
2126 static void
2127cleanup_function_call(funccall_T *fc)
2128{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002129 int may_free_fc = fc->fc_refcount <= 0;
2130 int free_fc = TRUE;
2131
Bram Moolenaar6914c642017-04-01 21:21:30 +02002132 current_funccal = fc->caller;
2133
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002134 // Free all l: variables if not referred.
2135 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2136 vars_clear(&fc->l_vars.dv_hashtab);
2137 else
2138 free_fc = FALSE;
2139
2140 // If the a:000 list and the l: and a: dicts are not referenced and
2141 // there is no closure using it, we can free the funccall_T and what's
2142 // in it.
2143 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2144 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002145 else
2146 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002147 int todo;
2148 hashitem_T *hi;
2149 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002150
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002151 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002152
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002153 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002154 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2155 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2156 {
2157 if (!HASHITEM_EMPTY(hi))
2158 {
2159 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002160 di = HI2DI(hi);
2161 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002162 }
2163 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002164 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002165
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002166 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2167 fc->l_varlist.lv_first = NULL;
2168 else
2169 {
2170 listitem_T *li;
2171
2172 free_fc = FALSE;
2173
2174 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002175 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002176 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002177 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002178
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002179 if (free_fc)
2180 free_funccal(fc);
2181 else
2182 {
2183 static int made_copy = 0;
2184
2185 // "fc" is still in use. This can happen when returning "a:000",
2186 // assigning "l:" to a global variable or defining a closure.
2187 // Link "fc" in the list for garbage collection later.
2188 fc->caller = previous_funccal;
2189 previous_funccal = fc;
2190
2191 if (want_garbage_collect)
2192 // If garbage collector is ready, clear count.
2193 made_copy = 0;
2194 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002195 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002196 // We have made a lot of copies, worth 4 Mbyte. This can happen
2197 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002198 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002199 // too much memory.
2200 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002201 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002202 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002203 }
2204}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002205
2206/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002207 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2208 */
2209 static int
2210numbered_function(char_u *name)
2211{
2212 return isdigit(*name)
2213 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2214}
2215
2216/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002217 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002218 * 1. ordinary names, function defined with :function or :def;
2219 * can start with "<SNR>123_" literally or with K_SPECIAL.
2220 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002221 * For the first we only count the name stored in func_hashtab as a reference,
2222 * using function() does not count as a reference, because the function is
2223 * looked up by name.
2224 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002225 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002226func_name_refcount(char_u *name)
2227{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002228 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002229}
2230
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002231/*
2232 * Unreference "fc": decrement the reference count and free it when it
2233 * becomes zero. "fp" is detached from "fc".
2234 * When "force" is TRUE we are exiting.
2235 */
2236 static void
2237funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2238{
2239 funccall_T **pfc;
2240 int i;
2241
2242 if (fc == NULL)
2243 return;
2244
2245 if (--fc->fc_refcount <= 0 && (force || (
2246 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2247 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2248 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2249 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2250 {
2251 if (fc == *pfc)
2252 {
2253 *pfc = fc->caller;
2254 free_funccal_contents(fc);
2255 return;
2256 }
2257 }
2258 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2259 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2260 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2261}
2262
2263/*
2264 * Remove the function from the function hashtable. If the function was
2265 * deleted while it still has references this was already done.
2266 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2267 */
2268 static int
2269func_remove(ufunc_T *fp)
2270{
2271 hashitem_T *hi;
2272
2273 // Return if it was already virtually deleted.
2274 if (fp->uf_flags & FC_DEAD)
2275 return FALSE;
2276
2277 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2278 if (!HASHITEM_EMPTY(hi))
2279 {
2280 // When there is a def-function index do not actually remove the
2281 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002282 // Do remove it when it's a copy.
2283 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002284 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002285 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002286 return FALSE;
2287 }
2288 hash_remove(&func_hashtab, hi);
2289 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002290 return TRUE;
2291 }
2292 return FALSE;
2293}
2294
2295 static void
2296func_clear_items(ufunc_T *fp)
2297{
2298 ga_clear_strings(&(fp->uf_args));
2299 ga_clear_strings(&(fp->uf_def_args));
2300 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002301 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002302 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002303 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002304 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002305
2306 // Increment the refcount of this function to avoid it being freed
2307 // recursively when the partial is freed.
2308 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002309 partial_unref(fp->uf_partial);
2310 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002311 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002312
2313#ifdef FEAT_LUA
2314 if (fp->uf_cb_free != NULL)
2315 {
2316 fp->uf_cb_free(fp->uf_cb_state);
2317 fp->uf_cb_free = NULL;
2318 }
2319
2320 fp->uf_cb_state = NULL;
2321 fp->uf_cb = NULL;
2322#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323#ifdef FEAT_PROFILE
2324 VIM_CLEAR(fp->uf_tml_count);
2325 VIM_CLEAR(fp->uf_tml_total);
2326 VIM_CLEAR(fp->uf_tml_self);
2327#endif
2328}
2329
2330/*
2331 * Free all things that a function contains. Does not free the function
2332 * itself, use func_free() for that.
2333 * When "force" is TRUE we are exiting.
2334 */
2335 static void
2336func_clear(ufunc_T *fp, int force)
2337{
2338 if (fp->uf_cleared)
2339 return;
2340 fp->uf_cleared = TRUE;
2341
2342 // clear this function
2343 func_clear_items(fp);
2344 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002345 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002346}
2347
2348/*
2349 * Free a function and remove it from the list of functions. Does not free
2350 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002351 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002352 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002353 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002354 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002355func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002356{
2357 // Only remove it when not done already, otherwise we would remove a newer
2358 // version of the function with the same name.
2359 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2360 func_remove(fp);
2361
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002362 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002363 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002364 if (fp->uf_dfunc_idx > 0)
2365 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002366 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002367 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002368 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002369 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002370 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002371}
2372
2373/*
2374 * Free all things that a function contains and free the function itself.
2375 * When "force" is TRUE we are exiting.
2376 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002377 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002378func_clear_free(ufunc_T *fp, int force)
2379{
2380 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002381 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2382 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002383 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002384 else
2385 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002386}
2387
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002388/*
2389 * Copy already defined function "lambda" to a new function with name "global".
2390 * This is for when a compiled function defines a global function.
2391 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002392 int
2393copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002394{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002395 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002396 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002397
2398 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002399 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002400 semsg(_(e_lambda_function_not_found_str), lambda);
2401 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002402 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002403
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002404 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002405 if (fp != NULL)
2406 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002407 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002408 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002409 return FAIL;
2410 }
2411
2412 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2413 if (fp == NULL)
2414 return FAIL;
2415
2416 fp->uf_varargs = ufunc->uf_varargs;
2417 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2418 fp->uf_def_status = ufunc->uf_def_status;
2419 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2420 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2421 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2422 == FAIL
2423 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2424 goto failed;
2425
2426 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2427 : vim_strsave(ufunc->uf_name_exp);
2428 if (ufunc->uf_arg_types != NULL)
2429 {
2430 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2431 if (fp->uf_arg_types == NULL)
2432 goto failed;
2433 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2434 sizeof(type_T *) * fp->uf_args.ga_len);
2435 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002436 if (ufunc->uf_va_name != NULL)
2437 {
2438 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2439 if (fp->uf_va_name == NULL)
2440 goto failed;
2441 }
2442 fp->uf_ret_type = ufunc->uf_ret_type;
2443
2444 fp->uf_refcount = 1;
2445 STRCPY(fp->uf_name, global);
2446 hash_add(&func_hashtab, UF2HIKEY(fp));
2447
2448 // the referenced dfunc_T is now used one more time
2449 link_def_function(fp);
2450
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002451 // Create a partial to store the context of the function where it was
2452 // instantiated. Only needs to be done once. Do this on the original
2453 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002454 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2455 {
2456 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2457
2458 if (pt == NULL)
2459 goto failed;
2460 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002461 {
2462 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002463 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002464 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002465 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002466 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002467 }
2468
2469 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002470
2471failed:
2472 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002473 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002474}
2475
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002476static int funcdepth = 0;
2477
2478/*
2479 * Increment the function call depth count.
2480 * Return FAIL when going over 'maxfuncdepth'.
2481 * Otherwise return OK, must call funcdepth_decrement() later!
2482 */
2483 int
2484funcdepth_increment(void)
2485{
2486 if (funcdepth >= p_mfd)
2487 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002488 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002489 return FAIL;
2490 }
2491 ++funcdepth;
2492 return OK;
2493}
2494
2495 void
2496funcdepth_decrement(void)
2497{
2498 --funcdepth;
2499}
2500
2501/*
2502 * Get the current function call depth.
2503 */
2504 int
2505funcdepth_get(void)
2506{
2507 return funcdepth;
2508}
2509
2510/*
2511 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002512 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002513 * times as funcdepth_increment().
2514 */
2515 void
2516funcdepth_restore(int depth)
2517{
2518 funcdepth = depth;
2519}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002520
2521/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 * Call a user function.
2523 */
2524 static void
2525call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002526 ufunc_T *fp, // pointer to function
2527 int argcount, // nr of args
2528 typval_T *argvars, // arguments
2529 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002530 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002531 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002533 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002534 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002535 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536 funccall_T *fc;
2537 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002538 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002540 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 int i;
2542 int ai;
2543 int islambda = FALSE;
2544 char_u numbuf[NUMBUFLEN];
2545 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002546 typval_T *tv_to_free[MAX_FUNC_ARGS];
2547 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002549 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002550#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002551 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552
Bram Moolenaarb2049902021-01-24 12:53:53 +01002553#ifdef FEAT_PROFILE
2554 CLEAR_FIELD(profile_info);
2555#endif
2556
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002557 // If depth of calling is getting too high, don't execute the function.
2558 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002560 rettv->v_type = VAR_NUMBER;
2561 rettv->vval.v_number = -1;
2562 return;
2563 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564
Bram Moolenaare38eab22019-12-05 21:50:01 +01002565 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002567 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002568 if (fc == NULL)
2569 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 fc->caller = current_funccal;
2571 current_funccal = fc;
2572 fc->func = fp;
2573 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002574 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002575 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2577 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002578 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002579 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002580 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002581
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002582 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002583 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002584#ifdef FEAT_PROFILE
2585 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2586#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002587 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002588#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002589 if (do_profiling == PROF_YES)
2590 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002591#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002592 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002593 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002594 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002595#ifdef FEAT_PROFILE
2596 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002597 || (caller != NULL && caller->uf_profiling)))
2598 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002599#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002600 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002601 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002602 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002603 return;
2604 }
2605
Bram Moolenaar38453522021-11-28 22:00:12 +00002606 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607
2608 /*
2609 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2610 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2611 * each argument variable and saves a lot of time.
2612 */
2613 /*
2614 * Init l: variables.
2615 */
2616 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2617 if (selfdict != NULL)
2618 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002619 // Set l:self to "selfdict". Use "name" to avoid a warning from
2620 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 v = &fc->fixvar[fixvar_idx++].var;
2622 name = v->di_key;
2623 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002624 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002625 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2626 v->di_tv.v_type = VAR_DICT;
2627 v->di_tv.v_lock = 0;
2628 v->di_tv.vval.v_dict = selfdict;
2629 ++selfdict->dv_refcount;
2630 }
2631
2632 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002633 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002634 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002635 * Set a:000 to a list with room for the "..." arguments.
2636 */
2637 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002638 if ((fp->uf_flags & FC_NOARGS) == 0)
2639 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002640 (varnumber_T)(argcount >= fp->uf_args.ga_len
2641 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002642 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002643 if ((fp->uf_flags & FC_NOARGS) == 0)
2644 {
2645 // Use "name" to avoid a warning from some compiler that checks the
2646 // destination size.
2647 v = &fc->fixvar[fixvar_idx++].var;
2648 name = v->di_key;
2649 STRCPY(name, "000");
2650 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2651 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2652 v->di_tv.v_type = VAR_LIST;
2653 v->di_tv.v_lock = VAR_FIXED;
2654 v->di_tv.vval.v_list = &fc->l_varlist;
2655 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002656 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2658 fc->l_varlist.lv_lock = VAR_FIXED;
2659
2660 /*
2661 * Set a:firstline to "firstline" and a:lastline to "lastline".
2662 * Set a:name to named arguments.
2663 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002664 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002666 if ((fp->uf_flags & FC_NOARGS) == 0)
2667 {
2668 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002669 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002670 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002671 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002672 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002673 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 {
2675 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002676 typval_T def_rettv;
2677 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678
2679 ai = i - fp->uf_args.ga_len;
2680 if (ai < 0)
2681 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002682 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683 name = FUNCARG(fp, i);
2684 if (islambda)
2685 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002686
2687 // evaluate named argument default expression
2688 isdefault = ai + fp->uf_def_args.ga_len >= 0
2689 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2690 && argvars[i].vval.v_number == VVAL_NONE));
2691 if (isdefault)
2692 {
2693 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002694
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002695 def_rettv.v_type = VAR_NUMBER;
2696 def_rettv.vval.v_number = -1;
2697
2698 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2699 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002700 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002701 {
2702 default_arg_err = 1;
2703 break;
2704 }
2705 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 }
2707 else
2708 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002709 if ((fp->uf_flags & FC_NOARGS) != 0)
2710 // Bail out if no a: arguments used (in lambda).
2711 break;
2712
Bram Moolenaare38eab22019-12-05 21:50:01 +01002713 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 sprintf((char *)numbuf, "%d", ai + 1);
2715 name = numbuf;
2716 }
2717 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2718 {
2719 v = &fc->fixvar[fixvar_idx++].var;
2720 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002721 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722 }
2723 else
2724 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002725 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002726 if (v == NULL)
2727 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002728 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002729 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002731 // Note: the values are copied directly to avoid alloc/free.
2732 // "argvars" must have VAR_FIXED for v_lock.
2733 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734 v->di_tv.v_lock = VAR_FIXED;
2735
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002736 if (isdefault)
2737 // Need to free this later, no matter where it's stored.
2738 tv_to_free[tv_to_free_len++] = &v->di_tv;
2739
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002740 if (addlocal)
2741 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002742 // Named arguments should be accessed without the "a:" prefix in
2743 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002744 copy_tv(&v->di_tv, &v->di_tv);
2745 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002747 else
2748 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002749
2750 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2751 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002752 listitem_T *li = &fc->l_listitems[ai];
2753
2754 li->li_tv = argvars[i];
2755 li->li_tv.v_lock = VAR_FIXED;
2756 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757 }
2758 }
2759
Bram Moolenaare38eab22019-12-05 21:50:01 +01002760 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002762
2763 if (fp->uf_flags & FC_SANDBOX)
2764 {
2765 using_sandbox = TRUE;
2766 ++sandbox;
2767 }
2768
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002769 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002770 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002771 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002773 ++no_wait_return;
2774 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002776 smsg(_("calling %s"), SOURCING_NAME);
2777 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002779 char_u buf[MSG_BUF_LEN];
2780 char_u numbuf2[NUMBUFLEN];
2781 char_u *tofree;
2782 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002784 msg_puts("(");
2785 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002787 if (i > 0)
2788 msg_puts(", ");
2789 if (argvars[i].v_type == VAR_NUMBER)
2790 msg_outnum((long)argvars[i].vval.v_number);
2791 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002793 // Do not want errors such as E724 here.
2794 ++emsg_off;
2795 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2796 --emsg_off;
2797 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002799 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002801 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2802 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002803 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002804 msg_puts((char *)s);
2805 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 }
2807 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002808 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002809 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002811 msg_puts("\n"); // don't overwrite this either
2812
2813 verbose_leave_scroll();
2814 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 }
2816#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002817 if (do_profiling == PROF_YES)
2818 profile_may_start_func(&profile_info, fp,
2819 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820#endif
2821
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002822 // "legacy" does not apply to commands in the function
2823 sticky_cmdmod_flags = 0;
2824
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002825 save_current_sctx = current_sctx;
2826 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 save_did_emsg = did_emsg;
2828 did_emsg = FALSE;
2829
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002830 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2831 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002832 else if (islambda)
2833 {
2834 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2835
2836 // A Lambda always has the command "return {expr}". It is much faster
2837 // to evaluate {expr} directly.
2838 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002839 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002840 --ex_nesting_level;
2841 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002842 else
2843 // call do_cmdline() to execute the lines
2844 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002845 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2846
2847 --RedrawingDisabled;
2848
Bram Moolenaare38eab22019-12-05 21:50:01 +01002849 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2851 {
2852 clear_tv(rettv);
2853 rettv->v_type = VAR_NUMBER;
2854 rettv->vval.v_number = -1;
2855 }
2856
2857#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002858 if (do_profiling == PROF_YES)
2859 {
2860 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2861
2862 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2863 profile_may_end_func(&profile_info, fp, caller);
2864 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865#endif
2866
Bram Moolenaare38eab22019-12-05 21:50:01 +01002867 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 if (p_verbose >= 12)
2869 {
2870 ++no_wait_return;
2871 verbose_enter_scroll();
2872
2873 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002874 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002876 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002877 (long)fc->rettv->vval.v_number);
2878 else
2879 {
2880 char_u buf[MSG_BUF_LEN];
2881 char_u numbuf2[NUMBUFLEN];
2882 char_u *tofree;
2883 char_u *s;
2884
Bram Moolenaare38eab22019-12-05 21:50:01 +01002885 // The value may be very long. Skip the middle part, so that we
2886 // have some idea how it starts and ends. smsg() would always
2887 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 ++emsg_off;
2889 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2890 --emsg_off;
2891 if (s != NULL)
2892 {
2893 if (vim_strsize(s) > MSG_BUF_CLEN)
2894 {
2895 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2896 s = buf;
2897 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002898 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002899 vim_free(tofree);
2900 }
2901 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002902 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903
2904 verbose_leave_scroll();
2905 --no_wait_return;
2906 }
2907
Bram Moolenaare31ee862020-01-07 20:59:34 +01002908 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002909 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002910 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911#ifdef FEAT_PROFILE
2912 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002913 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002914#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002915 if (using_sandbox)
2916 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002917 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002919 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920 {
2921 ++no_wait_return;
2922 verbose_enter_scroll();
2923
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002924 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002925 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002926
2927 verbose_leave_scroll();
2928 --no_wait_return;
2929 }
2930
2931 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002932 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002933 for (i = 0; i < tv_to_free_len; ++i)
2934 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002935 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936}
2937
2938/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002939 * Check the argument count for user function "fp".
2940 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2941 */
2942 int
2943check_user_func_argcount(ufunc_T *fp, int argcount)
2944{
2945 int regular_args = fp->uf_args.ga_len;
2946
2947 if (argcount < regular_args - fp->uf_def_args.ga_len)
2948 return FCERR_TOOFEW;
2949 else if (!has_varargs(fp) && argcount > regular_args)
2950 return FCERR_TOOMANY;
2951 return FCERR_UNKNOWN;
2952}
2953
2954/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002955 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002956 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002957 int
2958call_user_func_check(
2959 ufunc_T *fp,
2960 int argcount,
2961 typval_T *argvars,
2962 typval_T *rettv,
2963 funcexe_T *funcexe,
2964 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002965{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002966 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002967
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002968 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2969 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002970 error = check_user_func_argcount(fp, argcount);
2971 if (error != FCERR_UNKNOWN)
2972 return error;
2973 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002974 error = FCERR_DICT;
2975 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002976 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002977 int did_save_redo = FALSE;
2978 save_redo_T save_redo;
2979
2980 /*
2981 * Call the user function.
2982 * Save and restore search patterns, script variables and
2983 * redo buffer.
2984 */
2985 save_search_patterns();
2986 if (!ins_compl_active())
2987 {
2988 saveRedobuff(&save_redo);
2989 did_save_redo = TRUE;
2990 }
2991 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002992 call_user_func(fp, argcount, argvars, rettv, funcexe,
2993 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002994 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2995 // Function was unreferenced while being used, free it now.
2996 func_clear_free(fp, FALSE);
2997 if (did_save_redo)
2998 restoreRedobuff(&save_redo);
2999 restore_search_patterns();
3000 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003001 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003002 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003003}
3004
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003005static funccal_entry_T *funccal_stack = NULL;
3006
3007/*
3008 * Save the current function call pointer, and set it to NULL.
3009 * Used when executing autocommands and for ":source".
3010 */
3011 void
3012save_funccal(funccal_entry_T *entry)
3013{
3014 entry->top_funccal = current_funccal;
3015 entry->next = funccal_stack;
3016 funccal_stack = entry;
3017 current_funccal = NULL;
3018}
3019
3020 void
3021restore_funccal(void)
3022{
3023 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003024 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003025 else
3026 {
3027 current_funccal = funccal_stack->top_funccal;
3028 funccal_stack = funccal_stack->next;
3029 }
3030}
3031
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003032 funccall_T *
3033get_current_funccal(void)
3034{
3035 return current_funccal;
3036}
3037
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003038/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003039 * Return TRUE when currently at the script level:
3040 * - not in a function
3041 * - not executing an autocommand
3042 * Note that when an autocommand sources a script the result is FALSE;
3043 */
3044 int
3045at_script_level(void)
3046{
3047 return current_funccal == NULL && autocmd_match == NULL;
3048}
3049
3050/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003051 * Mark all functions of script "sid" as deleted.
3052 */
3053 void
3054delete_script_functions(int sid)
3055{
3056 hashitem_T *hi;
3057 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003058 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003059 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003060 size_t len;
3061
3062 buf[0] = K_SPECIAL;
3063 buf[1] = KS_EXTRA;
3064 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003065 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003066 len = STRLEN(buf);
3067
Bram Moolenaarce658352020-07-31 23:47:12 +02003068 while (todo > 0)
3069 {
3070 todo = func_hashtab.ht_used;
3071 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3072 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003073 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003074 fp = HI2UF(hi);
3075 if (STRNCMP(fp->uf_name, buf, len) == 0)
3076 {
3077 int changed = func_hashtab.ht_changed;
3078
3079 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003080
3081 if (fp->uf_calls > 0)
3082 {
3083 // Function is executing, don't free it but do remove
3084 // it from the hashtable.
3085 if (func_remove(fp))
3086 fp->uf_refcount--;
3087 }
3088 else
3089 {
3090 func_clear(fp, TRUE);
3091 // When clearing a function another function can be
3092 // cleared as a side effect. When that happens start
3093 // over.
3094 if (changed != func_hashtab.ht_changed)
3095 break;
3096 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003097 }
3098 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003099 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003100 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003101}
3102
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103#if defined(EXITFREE) || defined(PROTO)
3104 void
3105free_all_functions(void)
3106{
3107 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003108 ufunc_T *fp;
3109 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003110 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003111 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112
Bram Moolenaare38eab22019-12-05 21:50:01 +01003113 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003114 while (current_funccal != NULL)
3115 {
3116 clear_tv(current_funccal->rettv);
3117 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003118 if (current_funccal == NULL && funccal_stack != NULL)
3119 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003120 }
3121
Bram Moolenaare38eab22019-12-05 21:50:01 +01003122 // First clear what the functions contain. Since this may lower the
3123 // reference count of a function, it may also free a function and change
3124 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003125 while (todo > 0)
3126 {
3127 todo = func_hashtab.ht_used;
3128 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3129 if (!HASHITEM_EMPTY(hi))
3130 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003131 // clear the def function index now
3132 fp = HI2UF(hi);
3133 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003134 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003135
Bram Moolenaare38eab22019-12-05 21:50:01 +01003136 // Only free functions that are not refcounted, those are
3137 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003138 if (func_name_refcount(fp->uf_name))
3139 ++skipped;
3140 else
3141 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003142 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003143 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003144 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003145 {
3146 skipped = 0;
3147 break;
3148 }
3149 }
3150 --todo;
3151 }
3152 }
3153
Bram Moolenaare38eab22019-12-05 21:50:01 +01003154 // Now actually free the functions. Need to start all over every time,
3155 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003156 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003157 while (func_hashtab.ht_used > skipped)
3158 {
3159 todo = func_hashtab.ht_used;
3160 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161 if (!HASHITEM_EMPTY(hi))
3162 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003163 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003164 // Only free functions that are not refcounted, those are
3165 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003166 fp = HI2UF(hi);
3167 if (func_name_refcount(fp->uf_name))
3168 ++skipped;
3169 else
3170 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003171 if (func_free(fp, FALSE) == OK)
3172 {
3173 skipped = 0;
3174 break;
3175 }
3176 // did not actually free it
3177 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003178 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003180 }
3181 if (skipped == 0)
3182 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003183
3184 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003185}
3186#endif
3187
3188/*
3189 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003190 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3191 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192 * "len" is the length of "name", or -1 for NUL terminated.
3193 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003194 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195builtin_function(char_u *name, int len)
3196{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003197 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003198
Bram Moolenaara26b9702020-04-18 19:53:28 +02003199 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003200 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003201 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3202 {
3203 if (name[i] == AUTOLOAD_CHAR)
3204 return FALSE;
3205 if (!eval_isnamec(name[i]))
3206 {
3207 // "name.something" is not a builtin function
3208 if (name[i] == '.')
3209 return FALSE;
3210 break;
3211 }
3212 }
3213 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214}
3215
3216 int
3217func_call(
3218 char_u *name,
3219 typval_T *args,
3220 partial_T *partial,
3221 dict_T *selfdict,
3222 typval_T *rettv)
3223{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003224 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003225 listitem_T *item;
3226 typval_T argv[MAX_FUNC_ARGS + 1];
3227 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228 int r = 0;
3229
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003230 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003231 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 {
3233 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3234 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003235 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 break;
3237 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003238 // Make a copy of each argument. This is needed to be able to set
3239 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003240 copy_tv(&item->li_tv, &argv[argc++]);
3241 }
3242
3243 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003244 {
3245 funcexe_T funcexe;
3246
Bram Moolenaara80faa82020-04-12 19:37:17 +02003247 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003248 funcexe.fe_firstline = curwin->w_cursor.lnum;
3249 funcexe.fe_lastline = curwin->w_cursor.lnum;
3250 funcexe.fe_evaluate = TRUE;
3251 funcexe.fe_partial = partial;
3252 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003253 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3254 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003255
Bram Moolenaare38eab22019-12-05 21:50:01 +01003256 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003257 while (argc > 0)
3258 clear_tv(&argv[--argc]);
3259
3260 return r;
3261}
3262
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003263static int callback_depth = 0;
3264
3265 int
3266get_callback_depth(void)
3267{
3268 return callback_depth;
3269}
3270
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003272 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003273 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003274 */
3275 int
3276call_callback(
3277 callback_T *callback,
3278 int len, // length of "name" or -1 to use strlen()
3279 typval_T *rettv, // return value goes here
3280 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003281 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003282 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003283{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003284 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003285 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003286
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003287 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3288 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003289 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003290 funcexe.fe_evaluate = TRUE;
3291 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003292 ++callback_depth;
3293 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3294 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003295
3296 // When a :def function was called that uses :try an error would be turned
3297 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003298 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003299 {
3300 need_rethrow = FALSE;
3301 handle_did_throw();
3302 }
3303
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003304 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003305}
3306
3307/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003308 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003309 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003310 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3311 */
3312 varnumber_T
3313call_callback_retnr(
3314 callback_T *callback,
3315 int argcount, // number of "argvars"
3316 typval_T *argvars) // vars for arguments, must have "argcount"
3317 // PLUS ONE elements!
3318{
3319 typval_T rettv;
3320 varnumber_T retval;
3321
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003322 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003323 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003324
3325 retval = tv_get_number_chk(&rettv, NULL);
3326 clear_tv(&rettv);
3327 return retval;
3328}
3329
3330/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003331 * Give an error message for the result of a function.
3332 * Nothing if "error" is FCERR_NONE.
3333 */
3334 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003335user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003336{
3337 switch (error)
3338 {
3339 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003340 if (funcexe->fe_found_var)
3341 semsg(_(e_not_callable_type_str), name);
3342 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003343 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003344 break;
3345 case FCERR_NOTMETHOD:
3346 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003347 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003348 break;
3349 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003350 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003351 break;
3352 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003353 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003354 break;
3355 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003356 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003357 break;
3358 case FCERR_SCRIPT:
3359 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003360 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003361 break;
3362 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003363 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3364 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003365 break;
3366 }
3367}
3368
3369/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003371 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 * Return FAIL when the function can't be called, OK otherwise.
3373 * Also returns OK when an error was encountered while executing the function.
3374 */
3375 int
3376call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003377 char_u *funcname, // name of the function
3378 int len, // length of "name" or -1 to use strlen()
3379 typval_T *rettv, // return value goes here
3380 int argcount_in, // number of "argvars"
3381 typval_T *argvars_in, // vars for arguments, must have "argcount"
3382 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003383 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384{
3385 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003386 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003388 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 char_u fname_buf[FLEN_FIXED + 1];
3390 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003391 char_u *fname = NULL;
3392 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393 int argcount = argcount_in;
3394 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003395 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003396 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003397 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003399 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003400 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003401 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003402 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003404 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3405 // even when call_func() returns FAIL.
3406 rettv->v_type = VAR_UNKNOWN;
3407
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003408 if (partial != NULL)
3409 fp = partial->pt_func;
3410 if (fp == NULL)
3411 {
3412 // Make a copy of the name, if it comes from a funcref variable it
3413 // could be changed or deleted in the called function.
3414 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3415 if (name == NULL)
3416 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003418 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3419 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003421 if (funcexe->fe_doesrange != NULL)
3422 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423
3424 if (partial != NULL)
3425 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003426 // When the function has a partial with a dict and there is a dict
3427 // argument, use the dict argument. That is backwards compatible.
3428 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003429 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003431 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003432 {
3433 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003434 {
3435 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3436 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003437 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003438 goto theend;
3439 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003441 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 for (i = 0; i < argcount_in; ++i)
3443 argv[i + argv_clear] = argvars_in[i];
3444 argvars = argv;
3445 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003446
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003447 if (funcexe->fe_check_type != NULL
3448 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003449 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003450 // Now funcexe->fe_check_type is missing the added arguments,
3451 // make a copy of the type with the correction.
3452 check_type = *funcexe->fe_check_type;
3453 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003454 check_type.tt_args = check_type_args;
3455 CLEAR_FIELD(check_type_args);
3456 for (i = 0; i < check_type.tt_argcount; ++i)
3457 check_type_args[i + partial->pt_argc] =
3458 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003459 check_type.tt_argcount += partial->pt_argc;
3460 check_type.tt_min_argcount += partial->pt_argc;
3461 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 }
3463 }
3464
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003465 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3466 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003467 {
3468 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003469 if (check_argument_types(funcexe->fe_check_type,
3470 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003471 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003472 error = FCERR_OTHER;
3473 }
3474
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003475 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476 {
3477 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003478 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479
Bram Moolenaar333894b2020-08-01 18:53:07 +02003480 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003481 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003482 {
3483 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003485 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486
Bram Moolenaare38eab22019-12-05 21:50:01 +01003487 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003488 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003489 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003491 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492 {
3493 /*
3494 * User defined function.
3495 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003496 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003497 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003498 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003499 if (fp != NULL && !is_global && in_vim9script()
3500 && func_requires_g_prefix(fp))
3501 // In Vim9 script g: is required to find a global
3502 // non-autoload function.
3503 fp = NULL;
3504 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505
Bram Moolenaare38eab22019-12-05 21:50:01 +01003506 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 if (fp == NULL
3508 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003509 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003510 && !aborting())
3511 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003512 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003513 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003515 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3517 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003518 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003519 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003521 if (fp == NULL)
3522 {
3523 char_u *p = untrans_function_name(rfname);
3524
3525 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003526 // Don't do this if the name starts with "s:".
3527 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003528 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003529 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003531 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003532 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003533#ifdef FEAT_LUA
3534 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3535 {
3536 cfunc_T cb = fp->uf_cb;
3537
3538 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3539 }
3540#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003541 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003543 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003544 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003545 argcount = funcexe->fe_argv_func(argcount, argvars,
3546 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003547
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003548 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003549 {
3550 // Method call: base->Method()
3551 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003552 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003553 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003554 argvars = argv;
3555 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003556 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003557
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003558 error = call_user_func_check(fp, argcount, argvars, rettv,
3559 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 }
3561 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003562 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003563 {
3564 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003565 * expr->method(): Find the method name in the table, call its
3566 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003567 */
3568 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003569 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003570 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003571 else
3572 {
3573 /*
3574 * Find the function name in the table, call its implementation.
3575 */
3576 error = call_internal_func(fname, argcount, argvars, rettv);
3577 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003578
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 /*
3580 * The function call (or "FuncUndefined" autocommand sequence) might
3581 * have been aborted by an error, an interrupt, or an explicitly thrown
3582 * exception that has not been caught so far. This situation can be
3583 * tested for by calling aborting(). For an error in an internal
3584 * function or for the "E132" error in call_user_func(), however, the
3585 * throw point at which the "force_abort" flag (temporarily reset by
3586 * emsg()) is normally updated has not been reached yet. We need to
3587 * update that flag first to make aborting() reliable.
3588 */
3589 update_force_abort();
3590 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003591 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 ret = OK;
3593
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003594theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 /*
3596 * Report an error unless the argument evaluation or function call has been
3597 * cancelled due to an aborting error, an interrupt, or an exception.
3598 */
3599 if (!aborting())
3600 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003601 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 }
3603
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003604 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003606 clear_tv(&argv[--argv_clear + argv_base]);
3607
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 vim_free(tofree);
3609 vim_free(name);
3610
3611 return ret;
3612}
3613
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003614 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003615printable_func_name(ufunc_T *fp)
3616{
3617 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3618}
3619
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003621 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 */
3623 static void
3624list_func_head(ufunc_T *fp, int indent)
3625{
3626 int j;
3627
3628 msg_start();
3629 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003630 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003631 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003632 msg_puts("def ");
3633 else
3634 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003635 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 msg_putchar('(');
3637 for (j = 0; j < fp->uf_args.ga_len; ++j)
3638 {
3639 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003640 msg_puts(", ");
3641 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003642 if (fp->uf_arg_types != NULL)
3643 {
3644 char *tofree;
3645
3646 msg_puts(": ");
3647 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3648 vim_free(tofree);
3649 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003650 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3651 {
3652 msg_puts(" = ");
3653 msg_puts(((char **)(fp->uf_def_args.ga_data))
3654 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3655 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003656 }
3657 if (fp->uf_varargs)
3658 {
3659 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003660 msg_puts(", ");
3661 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003663 if (fp->uf_va_name != NULL)
3664 {
3665 if (j)
3666 msg_puts(", ");
3667 msg_puts("...");
3668 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003669 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003670 {
3671 char *tofree;
3672
3673 msg_puts(": ");
3674 msg_puts(type_name(fp->uf_va_type, &tofree));
3675 vim_free(tofree);
3676 }
3677 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003679
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003680 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003681 {
3682 if (fp->uf_ret_type != &t_void)
3683 {
3684 char *tofree;
3685
3686 msg_puts(": ");
3687 msg_puts(type_name(fp->uf_ret_type, &tofree));
3688 vim_free(tofree);
3689 }
3690 }
3691 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003692 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003694 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003696 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003697 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003698 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 msg_clr_eos();
3700 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003701 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702}
3703
3704/*
3705 * Get a function name, translating "<SID>" and "<SNR>".
3706 * Also handles a Funcref in a List or Dictionary.
3707 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003708 * Set "*is_global" to TRUE when the function must be global, unless
3709 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 * flags:
3711 * TFN_INT: internal function name OK
3712 * TFN_QUIET: be quiet
3713 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003714 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 * Advances "pp" to just after the function name (if no error).
3716 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003717 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718trans_function_name(
3719 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003720 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003721 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003723 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003724 partial_T **partial, // return: partial of a FuncRef
3725 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726{
3727 char_u *name = NULL;
3728 char_u *start;
3729 char_u *end;
3730 int lead;
3731 char_u sid_buf[20];
3732 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003733 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003734 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003736 int vim9script = in_vim9script();
3737 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738
3739 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003740 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 start = *pp;
3742
Bram Moolenaare38eab22019-12-05 21:50:01 +01003743 // Check for hard coded <SNR>: already translated function ID (from a user
3744 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003745 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3746 && (*pp)[2] == (int)KE_SNR)
3747 {
3748 *pp += 3;
3749 len = get_id_len(pp) + 3;
3750 return vim_strnsave(start, len);
3751 }
3752
Bram Moolenaare38eab22019-12-05 21:50:01 +01003753 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3754 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 lead = eval_fname_script(start);
3756 if (lead > 2)
3757 start += lead;
3758
Bram Moolenaare38eab22019-12-05 21:50:01 +01003759 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003760 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003762 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003763 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 {
3765 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003766 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 goto theend;
3768 }
3769 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3770 {
3771 /*
3772 * Report an invalid expression in braces, unless the expression
3773 * evaluation has been cancelled due to an aborting error, an
3774 * interrupt, or an exception.
3775 */
3776 if (!aborting())
3777 {
3778 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003779 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 }
3781 else
3782 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3783 goto theend;
3784 }
3785
3786 if (lv.ll_tv != NULL)
3787 {
3788 if (fdp != NULL)
3789 {
3790 fdp->fd_dict = lv.ll_dict;
3791 fdp->fd_newkey = lv.ll_newkey;
3792 lv.ll_newkey = NULL;
3793 fdp->fd_di = lv.ll_di;
3794 }
3795 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3796 {
3797 name = vim_strsave(lv.ll_tv->vval.v_string);
3798 *pp = end;
3799 }
3800 else if (lv.ll_tv->v_type == VAR_PARTIAL
3801 && lv.ll_tv->vval.v_partial != NULL)
3802 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003803 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 *pp = end;
3805 if (partial != NULL)
3806 *partial = lv.ll_tv->vval.v_partial;
3807 }
3808 else
3809 {
3810 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3811 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003812 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813 else
3814 *pp = end;
3815 name = NULL;
3816 }
3817 goto theend;
3818 }
3819
3820 if (lv.ll_name == NULL)
3821 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003822 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 *pp = end;
3824 goto theend;
3825 }
3826
Bram Moolenaare38eab22019-12-05 21:50:01 +01003827 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 if (lv.ll_exp_name != NULL)
3829 {
3830 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003831 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003832 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 if (name == lv.ll_exp_name)
3834 name = NULL;
3835 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003836 else if (lv.ll_sid > 0)
3837 {
3838 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3839 int cc = *lv.ll_name_end;
3840
3841 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3842 *lv.ll_name_end = NUL;
3843 if (si->sn_autoload_prefix != NULL)
3844 {
3845 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3846 }
3847 else
3848 {
3849 sid_buf[0] = K_SPECIAL;
3850 sid_buf[1] = KS_EXTRA;
3851 sid_buf[2] = (int)KE_SNR;
3852 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003853 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003854 name = concat_str(sid_buf, lv.ll_name);
3855 }
3856 *lv.ll_name_end = cc;
3857 *pp = end;
3858 goto theend;
3859 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003860 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861 {
3862 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003863 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003864 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865 if (name == *pp)
3866 name = NULL;
3867 }
3868 if (name != NULL)
3869 {
3870 name = vim_strsave(name);
3871 *pp = end;
3872 if (STRNCMP(name, "<SNR>", 5) == 0)
3873 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003874 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003875 name[0] = K_SPECIAL;
3876 name[1] = KS_EXTRA;
3877 name[2] = (int)KE_SNR;
3878 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3879 }
3880 goto theend;
3881 }
3882
3883 if (lv.ll_exp_name != NULL)
3884 {
3885 len = (int)STRLEN(lv.ll_exp_name);
3886 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3887 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3888 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003889 // When there was "s:" already or the name expanded to get a
3890 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003891 lv.ll_name += 2;
3892 len -= 2;
3893 lead = 2;
3894 }
3895 }
3896 else
3897 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003898 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003900 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003901 if (lv.ll_name[0] == 'g')
3902 {
3903 if (is_global != NULL)
3904 {
3905 *is_global = TRUE;
3906 }
3907 else
3908 {
3909 // dropping "g:" without setting "is_global" won't work in
3910 // Vim9script, put it back later
3911 prefix_g = TRUE;
3912 extra = 2;
3913 }
3914 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 len = (int)(end - lv.ll_name);
3918 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003919 if (len <= 0)
3920 {
3921 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003922 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003923 goto theend;
3924 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003926 // In Vim9 script a user function is script-local by default, unless it
3927 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003928 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003929
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 /*
3931 * Copy the function name to allocated memory.
3932 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3933 * Accept <SNR>123_name() outside a script.
3934 */
3935 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003936 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003937 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003939 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003940 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003941 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
Bram Moolenaar3787f262022-02-07 21:54:01 +00003942 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003943 semsg(_(vim9script
Bram Moolenaar3787f262022-02-07 21:54:01 +00003944 ? e_function_name_must_start_with_capital_str
3945 : e_function_name_must_start_with_capital_or_s_str),
3946 start);
3947 goto theend;
3948 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003949 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00003950 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00003951 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003952 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953 || eval_fname_sid(*pp))
3954 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003955 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003956 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003958 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003959 goto theend;
3960 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003961 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003962 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003963 extra = 3 + (int)STRLEN(sid_buf);
3964 else
3965 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 }
3967 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003968 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00003969 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003971 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00003972 : e_function_name_must_start_with_capital_or_s_str),
3973 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003974 goto theend;
3975 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003976 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977 {
3978 char_u *cp = vim_strchr(lv.ll_name, ':');
3979
3980 if (cp != NULL && cp < end)
3981 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003982 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 goto theend;
3984 }
3985 }
3986
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003987 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988 if (name != NULL)
3989 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003990 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991 {
3992 name[0] = K_SPECIAL;
3993 name[1] = KS_EXTRA;
3994 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003995 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996 STRCPY(name + 3, sid_buf);
3997 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003998 else if (prefix_g)
3999 {
4000 name[0] = 'g';
4001 name[1] = ':';
4002 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004003 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4004 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005 }
4006 *pp = end;
4007
4008theend:
4009 clear_lval(&lv);
4010 return name;
4011}
4012
4013/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004014 * Assuming "name" is the result of trans_function_name() and it was prefixed
4015 * to use the script-local name, return the unmodified name (points into
4016 * "name"). Otherwise return NULL.
4017 * This can be used to first search for a script-local function and fall back
4018 * to the global function if not found.
4019 */
4020 char_u *
4021untrans_function_name(char_u *name)
4022{
4023 char_u *p;
4024
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004025 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004026 {
4027 p = vim_strchr(name, '_');
4028 if (p != NULL)
4029 return p + 1;
4030 }
4031 return NULL;
4032}
4033
4034/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004035 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4036 * current script ID and returns the expanded function name. The caller should
4037 * free the returned name. If not called from a script context or the function
4038 * name doesn't start with these prefixes, then returns NULL.
4039 * This doesn't check whether the script-local function exists or not.
4040 */
4041 char_u *
4042get_scriptlocal_funcname(char_u *funcname)
4043{
4044 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004045 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004046 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004047 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004048
4049 if (funcname == NULL)
4050 return NULL;
4051
4052 if (STRNCMP(funcname, "s:", 2) != 0
4053 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004054 {
4055 ufunc_T *ufunc;
4056
4057 // The function name does not have a script-local prefix. Try finding
4058 // it when in a Vim9 script and there is no "g:" prefix.
4059 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4060 return NULL;
4061 ufunc = find_func(funcname, FALSE);
4062 if (ufunc == NULL || func_is_global(ufunc)
4063 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4064 return NULL;
4065 ++p;
4066 off = 0;
4067 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004068 else
4069 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004070
4071 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4072 {
4073 emsg(_(e_using_sid_not_in_script_context));
4074 return NULL;
4075 }
4076 // Expand s: prefix into <SNR>nr_<name>
4077 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4078 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004079 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004080 if (newname == NULL)
4081 return NULL;
4082 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004083 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004084
4085 return newname;
4086}
4087
4088/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004089 * Return script-local "fname" with the 3-byte sequence replaced by
4090 * printable <SNR> in allocated memory.
4091 */
4092 char_u *
4093alloc_printable_func_name(char_u *fname)
4094{
4095 char_u *n = alloc(STRLEN(fname + 3) + 6);
4096
4097 if (n != NULL)
4098 {
4099 STRCPY(n, "<SNR>");
4100 STRCPY(n + 5, fname + 3);
4101 }
4102 return n;
4103}
4104
4105/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004106 * Call trans_function_name(), except that a lambda is returned as-is.
4107 * Returns the name in allocated memory.
4108 */
4109 char_u *
4110save_function_name(
4111 char_u **name,
4112 int *is_global,
4113 int skip,
4114 int flags,
4115 funcdict_T *fudi)
4116{
4117 char_u *p = *name;
4118 char_u *saved;
4119
4120 if (STRNCMP(p, "<lambda>", 8) == 0)
4121 {
4122 p += 8;
4123 (void)getdigits(&p);
4124 saved = vim_strnsave(*name, p - *name);
4125 if (fudi != NULL)
4126 CLEAR_POINTER(fudi);
4127 }
4128 else
4129 saved = trans_function_name(&p, is_global, skip,
4130 flags, fudi, NULL, NULL);
4131 *name = p;
4132 return saved;
4133}
4134
4135/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004136 * List functions. When "regmatch" is NULL all of then.
4137 * Otherwise functions matching "regmatch".
4138 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004139 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004140list_functions(regmatch_T *regmatch)
4141{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004142 int changed = func_hashtab.ht_changed;
4143 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004144 hashitem_T *hi;
4145
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004146 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004147 {
4148 if (!HASHITEM_EMPTY(hi))
4149 {
4150 ufunc_T *fp = HI2UF(hi);
4151
4152 --todo;
4153 if ((fp->uf_flags & FC_DEAD) == 0
4154 && (regmatch == NULL
4155 ? !message_filtered(fp->uf_name)
4156 && !func_name_refcount(fp->uf_name)
4157 : !isdigit(*fp->uf_name)
4158 && vim_regexec(regmatch, fp->uf_name, 0)))
4159 {
4160 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004161 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004162 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004163 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004164 return;
4165 }
4166 }
4167 }
4168 }
4169}
4170
4171/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004172 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004173 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4174 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004175 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004176 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004178 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004179define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004180{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 int j;
4182 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004183 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004184 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004185 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186 char_u *p;
4187 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004188 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 char_u *line_arg = NULL;
4190 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004191 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004192 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 garray_T newlines;
4194 int varargs = FALSE;
4195 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004196 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004197 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004198 int fp_allocated = FALSE;
4199 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004200 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 dictitem_T *v;
4202 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004203 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004205 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004206 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004207 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004208 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209
4210 /*
4211 * ":function" without argument: list functions.
4212 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004213 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214 {
4215 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004216 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004217 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004218 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004219 }
4220
4221 /*
4222 * ":function /pat": list functions matching pattern.
4223 */
4224 if (*eap->arg == '/')
4225 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004226 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 if (!eap->skip)
4228 {
4229 regmatch_T regmatch;
4230
4231 c = *p;
4232 *p = NUL;
4233 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4234 *p = c;
4235 if (regmatch.regprog != NULL)
4236 {
4237 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004238 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239 vim_regfree(regmatch.regprog);
4240 }
4241 }
4242 if (*p == '/')
4243 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004244 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004245 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004246 }
4247
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004248 ga_init(&newargs);
4249 ga_init(&argtypes);
4250 ga_init(&default_args);
4251
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 /*
4253 * Get the function name. There are these situations:
4254 * func normal function name
4255 * "name" == func, "fudi.fd_dict" == NULL
4256 * dict.func new dictionary entry
4257 * "name" == NULL, "fudi.fd_dict" set,
4258 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4259 * dict.func existing dict entry with a Funcref
4260 * "name" == func, "fudi.fd_dict" set,
4261 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4262 * dict.func existing dict entry that's not a Funcref
4263 * "name" == NULL, "fudi.fd_dict" set,
4264 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4265 * s:func script-local function name
4266 * g:func global function name, same as "func"
4267 */
4268 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004269 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004271 // nested function, argument is (args).
4272 paren = TRUE;
4273 CLEAR_FIELD(fudi);
4274 }
4275 else
4276 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004277 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004278 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004279 if (p[0] == 's' && p[1] == ':')
4280 {
4281 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4282 return NULL;
4283 }
4284 p = to_name_end(p, TRUE);
4285 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4286 {
4287 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4288 eap->arg);
4289 return NULL;
4290 }
4291 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004292 }
4293
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004294 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004295 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004296 paren = (vim_strchr(p, '(') != NULL);
4297 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004298 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004299 /*
4300 * Return on an invalid expression in braces, unless the expression
4301 * evaluation has been cancelled due to an aborting error, an
4302 * interrupt, or an exception.
4303 */
4304 if (!aborting())
4305 {
4306 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004307 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004308 vim_free(fudi.fd_newkey);
4309 return NULL;
4310 }
4311 else
4312 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004314
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004315 // For "export def FuncName()" in an autoload script the function name
4316 // is stored with the legacy autoload name "dir#script#FuncName" so
4317 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004318 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004319 {
4320 char_u *prefixed = may_prefix_autoload(name);
4321
4322 if (prefixed != NULL && prefixed != name)
4323 {
4324 vim_free(name);
4325 name = prefixed;
4326 }
4327 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004328 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004329 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004330 {
4331 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4332 goto ret_free;
4333 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004334 }
4335
Bram Moolenaare38eab22019-12-05 21:50:01 +01004336 // An error in a function call during evaluation of an expression in magic
4337 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004338 saved_did_emsg = did_emsg;
4339 did_emsg = FALSE;
4340
4341 /*
4342 * ":function func" with only function name: list function.
4343 */
4344 if (!paren)
4345 {
4346 if (!ends_excmd(*skipwhite(p)))
4347 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004348 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 goto ret_free;
4350 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004351 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 if (eap->nextcmd != NULL)
4353 *p = NUL;
4354 if (!eap->skip && !got_int)
4355 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004356 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004357 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4358 {
4359 char_u *up = untrans_function_name(name);
4360
4361 // With Vim9 script the name was made script-local, if not
4362 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004363 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004364 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004365 }
4366
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 if (fp != NULL)
4368 {
4369 list_func_head(fp, TRUE);
4370 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4371 {
4372 if (FUNCLINE(fp, j) == NULL)
4373 continue;
4374 msg_putchar('\n');
4375 msg_outnum((long)(j + 1));
4376 if (j < 9)
4377 msg_putchar(' ');
4378 if (j < 99)
4379 msg_putchar(' ');
4380 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004381 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 ui_breakcheck();
4383 }
4384 if (!got_int)
4385 {
4386 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004387 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004388 msg_puts(" enddef");
4389 else
4390 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391 }
4392 }
4393 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004394 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004395 }
4396 goto ret_free;
4397 }
4398
4399 /*
4400 * ":function name(arg1, arg2)" Define function.
4401 */
4402 p = skipwhite(p);
4403 if (*p != '(')
4404 {
4405 if (!eap->skip)
4406 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004407 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 goto ret_free;
4409 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004410 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 if (vim_strchr(p, '(') != NULL)
4412 p = vim_strchr(p, '(');
4413 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004415 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4416 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004417 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004418 goto ret_free;
4419 }
4420
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004421 // In Vim9 script only global functions can be redefined.
4422 if (vim9script && eap->forceit && !is_global)
4423 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004424 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004425 goto ret_free;
4426 }
4427
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004428 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429
Bram Moolenaar04b12692020-05-04 23:24:44 +02004430 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004432 // Check the name of the function. Unless it's a dictionary function
4433 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 if (name != NULL)
4435 arg = name;
4436 else
4437 arg = fudi.fd_newkey;
4438 if (arg != NULL && (fudi.fd_di == NULL
4439 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4440 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4441 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004442 char_u *name_base = arg;
4443 int i;
4444
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004445 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004446 {
4447 name_base = vim_strchr(arg, '_');
4448 if (name_base == NULL)
4449 name_base = arg + 3;
4450 else
4451 ++name_base;
4452 }
4453 for (i = 0; name_base[i] != NUL && (i == 0
4454 ? eval_isnamec1(name_base[i])
4455 : eval_isnamec(name_base[i])); ++i)
4456 ;
4457 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004458 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004459
4460 // In Vim9 script a function cannot have the same name as a
4461 // variable.
4462 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004463 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4464 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004465 + EVAL_VAR_NO_FUNC) == OK)
4466 {
4467 semsg(_(e_redefining_script_item_str), name_base);
4468 goto ret_free;
4469 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004471 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004473 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004474 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004475 goto ret_free;
4476 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477 }
4478
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004479 // This may get more lines and make the pointers into the first line
4480 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004481 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004482 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004483 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004484 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004485 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004487 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004489 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004490 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004491 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004492 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004494 if (*p != ':')
4495 {
4496 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4497 p = skipwhite(p);
4498 }
4499 else if (!IS_WHITE_OR_NUL(p[1]))
4500 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004501 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004502 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004503 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004504 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004505 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004506 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004507 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004508 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004509 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004510 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004511 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004512 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004513 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004515 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004517 else
4518 // find extra arguments "range", "dict", "abort" and "closure"
4519 for (;;)
4520 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004521 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004522 p = skipwhite(p);
4523 if (STRNCMP(p, "range", 5) == 0)
4524 {
4525 flags |= FC_RANGE;
4526 p += 5;
4527 }
4528 else if (STRNCMP(p, "dict", 4) == 0)
4529 {
4530 flags |= FC_DICT;
4531 p += 4;
4532 }
4533 else if (STRNCMP(p, "abort", 5) == 0)
4534 {
4535 flags |= FC_ABORT;
4536 p += 5;
4537 }
4538 else if (STRNCMP(p, "closure", 7) == 0)
4539 {
4540 flags |= FC_CLOSURE;
4541 p += 7;
4542 if (current_funccal == NULL)
4543 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004544 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004545 name == NULL ? (char_u *)"" : name);
4546 goto erret;
4547 }
4548 }
4549 else
4550 break;
4551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552
Bram Moolenaare38eab22019-12-05 21:50:01 +01004553 // When there is a line break use what follows for the function body.
4554 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 if (*p == '\n')
4556 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004557 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004558 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4559 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004560 && !(VIM_ISWHITE(*whitep) && *p == '#'
4561 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004562 && !eap->skip
4563 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004564 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565
4566 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004567 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4568 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 */
4570 if (KeyTyped)
4571 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004572 // Check if the function already exists, don't let the user type the
4573 // whole function before telling him it doesn't work! For a script we
4574 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 if (!eap->skip && !eap->forceit)
4576 {
4577 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004578 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004579 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004580 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 }
4582
4583 if (!eap->skip && did_emsg)
4584 goto erret;
4585
Bram Moolenaare38eab22019-12-05 21:50:01 +01004586 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 cmdline_row = msg_row;
4588 }
4589
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004590 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004591 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004592
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004593 // Do not define the function when getting the body fails and when
4594 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004595 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004596 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004597 goto erret;
4598
4599 /*
4600 * If there are no errors, add the function
4601 */
4602 if (fudi.fd_dict == NULL)
4603 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004604 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004605 char_u *find_name = name;
4606 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004607 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004608
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004609 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004610 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004611 var_conflict = TRUE;
4612
4613 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4614 {
4615 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4616
4617 if (si->sn_autoload_prefix != NULL)
4618 {
4619 if (is_export)
4620 {
4621 find_name = name + STRLEN(si->sn_autoload_prefix);
4622 v = find_var(find_name, &ht, TRUE);
4623 if (v != NULL)
4624 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004625 // Only check if the function already exists in the script,
4626 // global functions can be shadowed.
4627 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004628 }
4629 else
4630 {
4631 char_u *prefixed = may_prefix_autoload(name);
4632
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004633 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004634 {
4635 v = find_var(prefixed, &ht, TRUE);
4636 if (v != NULL)
4637 var_conflict = TRUE;
4638 vim_free(prefixed);
4639 }
4640 }
4641 }
4642 }
4643 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004644 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004645 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004646 goto erret;
4647 }
4648
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004649 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004650 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004652 char_u *uname = untrans_function_name(name);
4653
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004654 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004655 }
4656
4657 if (fp != NULL || import != NULL)
4658 {
4659 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004660
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004661 // Function can be replaced with "function!" and when sourcing the
4662 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004663 // A name that is used by an import can not be overruled.
4664 if (import != NULL
4665 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004666 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004667 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004669 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004670 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004671 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004672 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004673 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 goto erret;
4675 }
4676 if (fp->uf_calls > 0)
4677 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004678 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004679 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 goto erret;
4681 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004682 if (fp->uf_refcount > 1)
4683 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004684 // This function is referenced somewhere, don't redefine it but
4685 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004686 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004687 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004688 fp = NULL;
4689 overwrite = TRUE;
4690 }
4691 else
4692 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004693 char_u *exp_name = fp->uf_name_exp;
4694
4695 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004696 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004697 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004698 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004699 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004700 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004701#ifdef FEAT_PROFILE
4702 fp->uf_profiling = FALSE;
4703 fp->uf_prof_initialized = FALSE;
4704#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004705 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004706 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 }
4708 }
4709 else
4710 {
4711 char numbuf[20];
4712
4713 fp = NULL;
4714 if (fudi.fd_newkey == NULL && !eap->forceit)
4715 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004716 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717 goto erret;
4718 }
4719 if (fudi.fd_di == NULL)
4720 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004721 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004722 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 goto erret;
4724 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004725 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004726 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004727 goto erret;
4728
Bram Moolenaare38eab22019-12-05 21:50:01 +01004729 // Give the function a sequential number. Can only be used with a
4730 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 vim_free(name);
4732 sprintf(numbuf, "%d", ++func_nr);
4733 name = vim_strsave((char_u *)numbuf);
4734 if (name == NULL)
4735 goto erret;
4736 }
4737
4738 if (fp == NULL)
4739 {
4740 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4741 {
4742 int slen, plen;
4743 char_u *scriptname;
4744
Bram Moolenaare38eab22019-12-05 21:50:01 +01004745 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004747 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748 {
4749 scriptname = autoload_name(name);
4750 if (scriptname != NULL)
4751 {
4752 p = vim_strchr(scriptname, '/');
4753 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004754 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004755 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004756 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 j = OK;
4758 vim_free(scriptname);
4759 }
4760 }
4761 if (j == FAIL)
4762 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004763 linenr_T save_lnum = SOURCING_LNUM;
4764
4765 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004766 semsg(_(e_function_name_does_not_match_script_file_name_str),
4767 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004768 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 goto erret;
4770 }
4771 }
4772
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004773 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 if (fp == NULL)
4775 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004776 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777
4778 if (fudi.fd_dict != NULL)
4779 {
4780 if (fudi.fd_di == NULL)
4781 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004782 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4784 if (fudi.fd_di == NULL)
4785 {
4786 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004787 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788 goto erret;
4789 }
4790 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4791 {
4792 vim_free(fudi.fd_di);
4793 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004794 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 goto erret;
4796 }
4797 }
4798 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004799 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 clear_tv(&fudi.fd_di->di_tv);
4801 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004802 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004803
Bram Moolenaare38eab22019-12-05 21:50:01 +01004804 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004805 flags |= FC_DICT;
4806 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 }
4808 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004809 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004810 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004811 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004812
4813 if (eap->cmdidx == CMD_def)
4814 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004815 int lnum_save = SOURCING_LNUM;
4816 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004817
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004818 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004819
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004820 // error messages are for the first function line
4821 SOURCING_LNUM = sourcing_lnum_top;
4822
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004823 // The function may use script variables from the context.
4824 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004825
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004826 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004827 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004828 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004829 free_fp = fp_allocated;
4830 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004831 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004832 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004833
4834 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004835 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004836 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004837 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004838 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004839 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004840 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004841 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004842 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004843 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004844 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004845
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004846 if (fp_allocated)
4847 {
4848 // insert the new function in the function list
4849 set_ufunc_name(fp, name);
4850 if (overwrite)
4851 {
4852 hi = hash_find(&func_hashtab, name);
4853 hi->hi_key = UF2HIKEY(fp);
4854 }
4855 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4856 {
4857 free_fp = TRUE;
4858 goto erret;
4859 }
4860 fp->uf_refcount = 1;
4861 }
4862
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004864 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004865 if ((flags & FC_CLOSURE) != 0)
4866 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004867 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004868 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004869 }
4870 else
4871 fp->uf_scoped = NULL;
4872
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004873#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 if (prof_def_func())
4875 func_do_profile(fp);
4876#endif
4877 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004878 if (sandbox)
4879 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004880 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004881 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004882 fp->uf_flags = flags;
4883 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004884 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004885 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004886 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004887 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004888 if (is_export)
4889 {
4890 fp->uf_flags |= FC_EXPORT;
4891 // let ex_export() know the export worked.
4892 is_export = FALSE;
4893 }
4894
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004895 if (eap->cmdidx == CMD_def)
4896 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004897 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4898 // :func does not use Vim9 script syntax, even in a Vim9 script file
4899 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004900
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 goto ret_free;
4902
4903erret:
4904 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004905 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004906 if (fp != NULL)
4907 {
4908 ga_init(&fp->uf_args);
4909 ga_init(&fp->uf_def_args);
4910 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911errret_2:
4912 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004913 if (fp != NULL)
4914 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004915 if (free_fp)
4916 {
4917 vim_free(fp);
4918 fp = NULL;
4919 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004920ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004921 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004922 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004923 if (name != name_arg)
4924 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004925 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004926 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004927
4928 return fp;
4929}
4930
4931/*
4932 * ":function"
4933 */
4934 void
4935ex_function(exarg_T *eap)
4936{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004937 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004938
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004939 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4940 (void)define_function(eap, NULL, &lines_to_free);
4941 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004942}
4943
4944/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004945 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004946 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004947 */
4948 void
4949ex_defcompile(exarg_T *eap UNUSED)
4950{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004951 long todo = (long)func_hashtab.ht_used;
4952 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004953 hashitem_T *hi;
4954 ufunc_T *ufunc;
4955
4956 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4957 {
4958 if (!HASHITEM_EMPTY(hi))
4959 {
4960 --todo;
4961 ufunc = HI2UF(hi);
4962 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004963 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4964 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004965 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004966 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004967
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004968 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004969 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004970 // a function has been added or removed, need to start over
4971 todo = (long)func_hashtab.ht_used;
4972 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004973 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004974 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004975 }
4976 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004977 }
4978 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979}
4980
4981/*
4982 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4983 * Return 2 if "p" starts with "s:".
4984 * Return 0 otherwise.
4985 */
4986 int
4987eval_fname_script(char_u *p)
4988{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004989 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4990 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004991 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4992 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4993 return 5;
4994 if (p[0] == 's' && p[1] == ':')
4995 return 2;
4996 return 0;
4997}
4998
4999 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005000translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005001{
5002 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005003 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005004 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005005}
5006
5007/*
5008 * Return TRUE when "ufunc" has old-style "..." varargs
5009 * or named varargs "...name: type".
5010 */
5011 int
5012has_varargs(ufunc_T *ufunc)
5013{
5014 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005015}
5016
5017/*
5018 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005019 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005020 */
5021 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005022function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005023{
5024 char_u *nm = name;
5025 char_u *p;
5026 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005027 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005028 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005029
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005030 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5031 if (no_deref)
5032 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005033 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005034 nm = skipwhite(nm);
5035
Bram Moolenaare38eab22019-12-05 21:50:01 +01005036 // Only accept "funcname", "funcname ", "funcname (..." and
5037 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005038 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005039 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005040 vim_free(p);
5041 return n;
5042}
5043
Bram Moolenaar113e1072019-01-20 15:30:40 +01005044#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005045 char_u *
5046get_expanded_name(char_u *name, int check)
5047{
5048 char_u *nm = name;
5049 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005050 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005051
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005052 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005053 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005054
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005055 if (p != NULL && *nm == NUL
5056 && (!check || translated_function_exists(p, is_global)))
5057 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005058
5059 vim_free(p);
5060 return NULL;
5061}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005062#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005064/*
5065 * Function given to ExpandGeneric() to obtain the list of user defined
5066 * function names.
5067 */
5068 char_u *
5069get_user_func_name(expand_T *xp, int idx)
5070{
5071 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005072 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005073 static hashitem_T *hi;
5074 ufunc_T *fp;
5075
5076 if (idx == 0)
5077 {
5078 done = 0;
5079 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005080 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005081 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005082 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005083 {
5084 if (done++ > 0)
5085 ++hi;
5086 while (HASHITEM_EMPTY(hi))
5087 ++hi;
5088 fp = HI2UF(hi);
5089
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005090 // don't show dead, dict and lambda functions
5091 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005092 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005093 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005094
5095 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005096 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005097
5098 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005099 if (xp->xp_context != EXPAND_USER_FUNC
5100 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005101 {
5102 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005103 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005104 STRCAT(IObuff, ")");
5105 }
5106 return IObuff;
5107 }
5108 return NULL;
5109}
5110
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005111/*
5112 * ":delfunction {name}"
5113 */
5114 void
5115ex_delfunction(exarg_T *eap)
5116{
5117 ufunc_T *fp = NULL;
5118 char_u *p;
5119 char_u *name;
5120 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005121 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122
5123 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005124 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5125 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126 vim_free(fudi.fd_newkey);
5127 if (name == NULL)
5128 {
5129 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005130 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005131 return;
5132 }
5133 if (!ends_excmd(*skipwhite(p)))
5134 {
5135 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005136 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005137 return;
5138 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005139 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005140 if (eap->nextcmd != NULL)
5141 *p = NUL;
5142
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005143 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005144 {
5145 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005146 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005147 vim_free(name);
5148 return;
5149 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005151 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 vim_free(name);
5153
5154 if (!eap->skip)
5155 {
5156 if (fp == NULL)
5157 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005158 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005159 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005160 return;
5161 }
5162 if (fp->uf_calls > 0)
5163 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005164 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165 return;
5166 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005167 if (fp->uf_flags & FC_VIM9)
5168 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005169 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005170 return;
5171 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172
5173 if (fudi.fd_dict != NULL)
5174 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005175 // Delete the dict item that refers to the function, it will
5176 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5178 }
5179 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005180 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005181 // A normal function (not a numbered function or lambda) has a
5182 // refcount of 1 for the entry in the hashtable. When deleting
5183 // it and the refcount is more than one, it should be kept.
5184 // A numbered function and lambda should be kept if the refcount is
5185 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005186 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005187 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005188 // Function is still referenced somewhere. Don't free it but
5189 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005190 if (func_remove(fp))
5191 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005192 }
5193 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005194 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005195 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005196 }
5197}
5198
5199/*
5200 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005201 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005202 */
5203 void
5204func_unref(char_u *name)
5205{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005206 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005208 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005210 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005211 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005213#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005214 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005216 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005217 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005218 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005219}
5220
5221/*
5222 * Unreference a Function: decrement the reference count and free it when it
5223 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005224 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005225 */
5226 void
5227func_ptr_unref(ufunc_T *fp)
5228{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005229 if (fp != NULL && (--fp->uf_refcount <= 0
5230 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5231 && fp->uf_partial->pt_refcount <= 1
5232 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005233 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005234 // Only delete it when it's not being used. Otherwise it's done
5235 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005236 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005237 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005238 }
5239}
5240
5241/*
5242 * Count a reference to a Function.
5243 */
5244 void
5245func_ref(char_u *name)
5246{
5247 ufunc_T *fp;
5248
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005249 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005250 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005251 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005252 if (fp != NULL)
5253 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005254 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005255 // Only give an error for a numbered function.
5256 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005257 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005258}
5259
5260/*
5261 * Count a reference to a Function.
5262 */
5263 void
5264func_ptr_ref(ufunc_T *fp)
5265{
5266 if (fp != NULL)
5267 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005268}
5269
5270/*
5271 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5272 * referenced from anywhere that is in use.
5273 */
5274 static int
5275can_free_funccal(funccall_T *fc, int copyID)
5276{
5277 return (fc->l_varlist.lv_copyID != copyID
5278 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005279 && fc->l_avars.dv_copyID != copyID
5280 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005281}
5282
5283/*
5284 * ":return [expr]"
5285 */
5286 void
5287ex_return(exarg_T *eap)
5288{
5289 char_u *arg = eap->arg;
5290 typval_T rettv;
5291 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005292 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005293
5294 if (current_funccal == NULL)
5295 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005296 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 return;
5298 }
5299
Bram Moolenaar844fb642021-10-23 13:32:30 +01005300 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005301 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5302
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005303 if (eap->skip)
5304 ++emsg_skip;
5305
5306 eap->nextcmd = NULL;
5307 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005308 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005309 {
5310 if (!eap->skip)
5311 returning = do_return(eap, FALSE, TRUE, &rettv);
5312 else
5313 clear_tv(&rettv);
5314 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005315 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005316 else if (!eap->skip)
5317 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005318 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005319 update_force_abort();
5320
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005321 /*
5322 * Return unless the expression evaluation has been cancelled due to an
5323 * aborting error, an interrupt, or an exception.
5324 */
5325 if (!aborting())
5326 returning = do_return(eap, FALSE, TRUE, NULL);
5327 }
5328
Bram Moolenaare38eab22019-12-05 21:50:01 +01005329 // When skipping or the return gets pending, advance to the next command
5330 // in this line (!returning). Otherwise, ignore the rest of the line.
5331 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005332 if (returning)
5333 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005334 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005335 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005336
5337 if (eap->skip)
5338 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005339 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005340}
5341
5342/*
5343 * ":1,25call func(arg1, arg2)" function call.
5344 */
5345 void
5346ex_call(exarg_T *eap)
5347{
5348 char_u *arg = eap->arg;
5349 char_u *startarg;
5350 char_u *name;
5351 char_u *tofree;
5352 int len;
5353 typval_T rettv;
5354 linenr_T lnum;
5355 int doesrange;
5356 int failed = FALSE;
5357 funcdict_T fudi;
5358 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005359 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005360 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005361 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005362 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005363
Bram Moolenaare6b53242020-07-01 17:28:33 +02005364 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005365 if (eap->skip)
5366 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005367 // trans_function_name() doesn't work well when skipping, use eval0()
5368 // instead to skip to any following command, e.g. for:
5369 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005370 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005371 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005372 clear_tv(&rettv);
5373 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005374 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005375 return;
5376 }
5377
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005378 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005379 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005380 if (fudi.fd_newkey != NULL)
5381 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005382 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005383 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005384 vim_free(fudi.fd_newkey);
5385 }
5386 if (tofree == NULL)
5387 return;
5388
Bram Moolenaare38eab22019-12-05 21:50:01 +01005389 // Increase refcount on dictionary, it could get deleted when evaluating
5390 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005391 if (fudi.fd_dict != NULL)
5392 ++fudi.fd_dict->dv_refcount;
5393
Bram Moolenaare38eab22019-12-05 21:50:01 +01005394 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5395 // contents. For VAR_PARTIAL get its partial, unless we already have one
5396 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005397 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005398 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005399 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005400 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005401
Bram Moolenaare38eab22019-12-05 21:50:01 +01005402 // Skip white space to allow ":call func ()". Not good, but required for
5403 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005404 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005405 if (*startarg != '(')
5406 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005407 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005408 goto end;
5409 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005410 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005411 {
5412 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5413 goto end;
5414 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005415
5416 /*
5417 * When skipping, evaluate the function once, to find the end of the
5418 * arguments.
5419 * When the function takes a range, this is discovered after the first
5420 * call, and the loop is broken.
5421 */
5422 if (eap->skip)
5423 {
5424 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005425 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005426 }
5427 else
5428 lnum = eap->line1;
5429 for ( ; lnum <= eap->line2; ++lnum)
5430 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005431 funcexe_T funcexe;
5432
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005433 if (!eap->skip && eap->addr_count > 0)
5434 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005435 if (lnum > curbuf->b_ml.ml_line_count)
5436 {
5437 // If the function deleted lines or switched to another buffer
5438 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005439 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005440 break;
5441 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442 curwin->w_cursor.lnum = lnum;
5443 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005444 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005445 }
5446 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005447
Bram Moolenaara80faa82020-04-12 19:37:17 +02005448 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005449 funcexe.fe_firstline = eap->line1;
5450 funcexe.fe_lastline = eap->line2;
5451 funcexe.fe_doesrange = &doesrange;
5452 funcexe.fe_evaluate = !eap->skip;
5453 funcexe.fe_partial = partial;
5454 funcexe.fe_selfdict = fudi.fd_dict;
5455 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005456 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005457 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005458 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005459 {
5460 failed = TRUE;
5461 break;
5462 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005463 if (has_watchexpr())
5464 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005465
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005466 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005467 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005468 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005469 {
5470 failed = TRUE;
5471 break;
5472 }
5473
5474 clear_tv(&rettv);
5475 if (doesrange || eap->skip)
5476 break;
5477
Bram Moolenaare38eab22019-12-05 21:50:01 +01005478 // Stop when immediately aborting on error, or when an interrupt
5479 // occurred or an exception was thrown but not caught.
5480 // get_func_tv() returned OK, so that the check for trailing
5481 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005482 if (aborting())
5483 break;
5484 }
5485 if (eap->skip)
5486 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005487 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005488
Bram Moolenaar1d341892021-09-18 15:25:52 +02005489 // When inside :try we need to check for following "| catch" or "| endtry".
5490 // Not when there was an error, but do check if an exception was thrown.
5491 if ((!aborting() || did_throw)
5492 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005493 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005494 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005495 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005496 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005497 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005498 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005499 {
5500 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005501 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005502 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005503 }
5504 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005505 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005506 }
5507
5508end:
5509 dict_unref(fudi.fd_dict);
5510 vim_free(tofree);
5511}
5512
5513/*
5514 * Return from a function. Possibly makes the return pending. Also called
5515 * for a pending return at the ":endtry" or after returning from an extra
5516 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5517 * when called due to a ":return" command. "rettv" may point to a typval_T
5518 * with the return rettv. Returns TRUE when the return can be carried out,
5519 * FALSE when the return gets pending.
5520 */
5521 int
5522do_return(
5523 exarg_T *eap,
5524 int reanimate,
5525 int is_cmd,
5526 void *rettv)
5527{
5528 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005529 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005530
5531 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005532 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005533 current_funccal->returned = FALSE;
5534
5535 /*
5536 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5537 * not in its finally clause (which then is to be executed next) is found.
5538 * In this case, make the ":return" pending for execution at the ":endtry".
5539 * Otherwise, return normally.
5540 */
5541 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5542 if (idx >= 0)
5543 {
5544 cstack->cs_pending[idx] = CSTP_RETURN;
5545
5546 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005547 // A pending return again gets pending. "rettv" points to an
5548 // allocated variable with the rettv of the original ":return"'s
5549 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005550 cstack->cs_rettv[idx] = rettv;
5551 else
5552 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005553 // When undoing a return in order to make it pending, get the stored
5554 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005555 if (reanimate)
5556 rettv = current_funccal->rettv;
5557
5558 if (rettv != NULL)
5559 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005560 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005561 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5562 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5563 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005564 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005565 }
5566 else
5567 cstack->cs_rettv[idx] = NULL;
5568
5569 if (reanimate)
5570 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005571 // The pending return value could be overwritten by a ":return"
5572 // without argument in a finally clause; reset the default
5573 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005574 current_funccal->rettv->v_type = VAR_NUMBER;
5575 current_funccal->rettv->vval.v_number = 0;
5576 }
5577 }
5578 report_make_pending(CSTP_RETURN, rettv);
5579 }
5580 else
5581 {
5582 current_funccal->returned = TRUE;
5583
Bram Moolenaare38eab22019-12-05 21:50:01 +01005584 // If the return is carried out now, store the return value. For
5585 // a return immediately after reanimation, the value is already
5586 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005587 if (!reanimate && rettv != NULL)
5588 {
5589 clear_tv(current_funccal->rettv);
5590 *current_funccal->rettv = *(typval_T *)rettv;
5591 if (!is_cmd)
5592 vim_free(rettv);
5593 }
5594 }
5595
5596 return idx < 0;
5597}
5598
5599/*
5600 * Free the variable with a pending return value.
5601 */
5602 void
5603discard_pending_return(void *rettv)
5604{
5605 free_tv((typval_T *)rettv);
5606}
5607
5608/*
5609 * Generate a return command for producing the value of "rettv". The result
5610 * is an allocated string. Used by report_pending() for verbose messages.
5611 */
5612 char_u *
5613get_return_cmd(void *rettv)
5614{
5615 char_u *s = NULL;
5616 char_u *tofree = NULL;
5617 char_u numbuf[NUMBUFLEN];
5618
5619 if (rettv != NULL)
5620 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5621 if (s == NULL)
5622 s = (char_u *)"";
5623
5624 STRCPY(IObuff, ":return ");
5625 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5626 if (STRLEN(s) + 8 >= IOSIZE)
5627 STRCPY(IObuff + IOSIZE - 4, "...");
5628 vim_free(tofree);
5629 return vim_strsave(IObuff);
5630}
5631
5632/*
5633 * Get next function line.
5634 * Called by do_cmdline() to get the next line.
5635 * Returns allocated string, or NULL for end of function.
5636 */
5637 char_u *
5638get_func_line(
5639 int c UNUSED,
5640 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005641 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005642 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005643{
5644 funccall_T *fcp = (funccall_T *)cookie;
5645 ufunc_T *fp = fcp->func;
5646 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005647 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005648
Bram Moolenaare38eab22019-12-05 21:50:01 +01005649 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005650 if (fcp->dbg_tick != debug_tick)
5651 {
5652 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005653 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005654 fcp->dbg_tick = debug_tick;
5655 }
5656#ifdef FEAT_PROFILE
5657 if (do_profiling == PROF_YES)
5658 func_line_end(cookie);
5659#endif
5660
5661 gap = &fp->uf_lines;
5662 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5663 || fcp->returned)
5664 retval = NULL;
5665 else
5666 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005667 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005668 while (fcp->linenr < gap->ga_len
5669 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5670 ++fcp->linenr;
5671 if (fcp->linenr >= gap->ga_len)
5672 retval = NULL;
5673 else
5674 {
5675 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005676 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005677#ifdef FEAT_PROFILE
5678 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005679 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005680#endif
5681 }
5682 }
5683
Bram Moolenaare38eab22019-12-05 21:50:01 +01005684 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005685 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005686 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005687 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005688 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005689 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005690 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005691 fcp->dbg_tick = debug_tick;
5692 }
5693
5694 return retval;
5695}
5696
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005697/*
5698 * Return TRUE if the currently active function should be ended, because a
5699 * return was encountered or an error occurred. Used inside a ":while".
5700 */
5701 int
5702func_has_ended(void *cookie)
5703{
5704 funccall_T *fcp = (funccall_T *)cookie;
5705
Bram Moolenaare38eab22019-12-05 21:50:01 +01005706 // Ignore the "abort" flag if the abortion behavior has been changed due to
5707 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005708 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5709 || fcp->returned);
5710}
5711
5712/*
5713 * return TRUE if cookie indicates a function which "abort"s on errors.
5714 */
5715 int
5716func_has_abort(
5717 void *cookie)
5718{
5719 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5720}
5721
5722
5723/*
5724 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5725 * Don't do this when "Func" is already a partial that was bound
5726 * explicitly (pt_auto is FALSE).
5727 * Changes "rettv" in-place.
5728 * Returns the updated "selfdict_in".
5729 */
5730 dict_T *
5731make_partial(dict_T *selfdict_in, typval_T *rettv)
5732{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005733 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005734 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005735 char_u fname_buf[FLEN_FIXED + 1];
5736 int error;
5737 dict_T *selfdict = selfdict_in;
5738
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005739 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
5740 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005741 fp = rettv->vval.v_partial->pt_func;
5742 else
5743 {
5744 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005745 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005746 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005747 if (fname == NULL)
5748 {
5749 // There is no point binding a dict to a NULL function, just create
5750 // a function reference.
5751 rettv->v_type = VAR_FUNC;
5752 rettv->vval.v_string = NULL;
5753 }
5754 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00005755 {
5756 char_u *tofree = NULL;
5757
5758 // Translate "s:func" to the stored function name.
5759 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
5760 fp = find_func(fname, FALSE);
5761 vim_free(tofree);
5762 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005763 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005764
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005765 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005766 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005767 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005768
5769 if (pt != NULL)
5770 {
5771 pt->pt_refcount = 1;
5772 pt->pt_dict = selfdict;
5773 pt->pt_auto = TRUE;
5774 selfdict = NULL;
5775 if (rettv->v_type == VAR_FUNC)
5776 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005777 // Just a function: Take over the function name and use
5778 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005779 pt->pt_name = rettv->vval.v_string;
5780 }
5781 else
5782 {
5783 partial_T *ret_pt = rettv->vval.v_partial;
5784 int i;
5785
Bram Moolenaare38eab22019-12-05 21:50:01 +01005786 // Partial: copy the function name, use selfdict and copy
5787 // args. Can't take over name or args, the partial might
5788 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005789 if (ret_pt->pt_name != NULL)
5790 {
5791 pt->pt_name = vim_strsave(ret_pt->pt_name);
5792 func_ref(pt->pt_name);
5793 }
5794 else
5795 {
5796 pt->pt_func = ret_pt->pt_func;
5797 func_ptr_ref(pt->pt_func);
5798 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005799 if (ret_pt->pt_argc > 0)
5800 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005801 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005802 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005803 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005804 pt->pt_argc = 0;
5805 else
5806 {
5807 pt->pt_argc = ret_pt->pt_argc;
5808 for (i = 0; i < pt->pt_argc; i++)
5809 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5810 }
5811 }
5812 partial_unref(ret_pt);
5813 }
5814 rettv->v_type = VAR_PARTIAL;
5815 rettv->vval.v_partial = pt;
5816 }
5817 }
5818 return selfdict;
5819}
5820
5821/*
5822 * Return the name of the executed function.
5823 */
5824 char_u *
5825func_name(void *cookie)
5826{
5827 return ((funccall_T *)cookie)->func->uf_name;
5828}
5829
5830/*
5831 * Return the address holding the next breakpoint line for a funccall cookie.
5832 */
5833 linenr_T *
5834func_breakpoint(void *cookie)
5835{
5836 return &((funccall_T *)cookie)->breakpoint;
5837}
5838
5839/*
5840 * Return the address holding the debug tick for a funccall cookie.
5841 */
5842 int *
5843func_dbg_tick(void *cookie)
5844{
5845 return &((funccall_T *)cookie)->dbg_tick;
5846}
5847
5848/*
5849 * Return the nesting level for a funccall cookie.
5850 */
5851 int
5852func_level(void *cookie)
5853{
5854 return ((funccall_T *)cookie)->level;
5855}
5856
5857/*
5858 * Return TRUE when a function was ended by a ":return" command.
5859 */
5860 int
5861current_func_returned(void)
5862{
5863 return current_funccal->returned;
5864}
5865
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005866 int
5867free_unref_funccal(int copyID, int testing)
5868{
5869 int did_free = FALSE;
5870 int did_free_funccal = FALSE;
5871 funccall_T *fc, **pfc;
5872
5873 for (pfc = &previous_funccal; *pfc != NULL; )
5874 {
5875 if (can_free_funccal(*pfc, copyID))
5876 {
5877 fc = *pfc;
5878 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005879 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005880 did_free = TRUE;
5881 did_free_funccal = TRUE;
5882 }
5883 else
5884 pfc = &(*pfc)->caller;
5885 }
5886 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005887 // When a funccal was freed some more items might be garbage
5888 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005889 (void)garbage_collect(testing);
5890
5891 return did_free;
5892}
5893
5894/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005895 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005896 */
5897 static funccall_T *
5898get_funccal(void)
5899{
5900 int i;
5901 funccall_T *funccal;
5902 funccall_T *temp_funccal;
5903
5904 funccal = current_funccal;
5905 if (debug_backtrace_level > 0)
5906 {
5907 for (i = 0; i < debug_backtrace_level; i++)
5908 {
5909 temp_funccal = funccal->caller;
5910 if (temp_funccal)
5911 funccal = temp_funccal;
5912 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005913 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005914 debug_backtrace_level = i;
5915 }
5916 }
5917 return funccal;
5918}
5919
5920/*
5921 * Return the hashtable used for local variables in the current funccal.
5922 * Return NULL if there is no current funccal.
5923 */
5924 hashtab_T *
5925get_funccal_local_ht()
5926{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005927 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005928 return NULL;
5929 return &get_funccal()->l_vars.dv_hashtab;
5930}
5931
5932/*
5933 * Return the l: scope variable.
5934 * Return NULL if there is no current funccal.
5935 */
5936 dictitem_T *
5937get_funccal_local_var()
5938{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005939 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005940 return NULL;
5941 return &get_funccal()->l_vars_var;
5942}
5943
5944/*
5945 * Return the hashtable used for argument in the current funccal.
5946 * Return NULL if there is no current funccal.
5947 */
5948 hashtab_T *
5949get_funccal_args_ht()
5950{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005951 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005952 return NULL;
5953 return &get_funccal()->l_avars.dv_hashtab;
5954}
5955
5956/*
5957 * Return the a: scope variable.
5958 * Return NULL if there is no current funccal.
5959 */
5960 dictitem_T *
5961get_funccal_args_var()
5962{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005963 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005964 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005965 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005966}
5967
5968/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005969 * List function variables, if there is a function.
5970 */
5971 void
5972list_func_vars(int *first)
5973{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005974 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005975 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005976 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005977}
5978
5979/*
5980 * If "ht" is the hashtable for local variables in the current funccal, return
5981 * the dict that contains it.
5982 * Otherwise return NULL.
5983 */
5984 dict_T *
5985get_current_funccal_dict(hashtab_T *ht)
5986{
5987 if (current_funccal != NULL
5988 && ht == &current_funccal->l_vars.dv_hashtab)
5989 return &current_funccal->l_vars;
5990 return NULL;
5991}
5992
5993/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005994 * Search hashitem in parent scope.
5995 */
5996 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005997find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005998{
5999 funccall_T *old_current_funccal = current_funccal;
6000 hashtab_T *ht;
6001 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006002 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006003
6004 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6005 return NULL;
6006
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006007 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006008 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006009 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006010 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006011 ht = find_var_ht(name, &varname);
6012 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006013 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006014 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006015 if (!HASHITEM_EMPTY(hi))
6016 {
6017 *pht = ht;
6018 break;
6019 }
6020 }
6021 if (current_funccal == current_funccal->func->uf_scoped)
6022 break;
6023 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006024 }
6025 current_funccal = old_current_funccal;
6026
6027 return hi;
6028}
6029
6030/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006031 * Search variable in parent scope.
6032 */
6033 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006034find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006035{
6036 dictitem_T *v = NULL;
6037 funccall_T *old_current_funccal = current_funccal;
6038 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006039 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006040
6041 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6042 return NULL;
6043
Bram Moolenaare38eab22019-12-05 21:50:01 +01006044 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006045 current_funccal = current_funccal->func->uf_scoped;
6046 while (current_funccal)
6047 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006048 ht = find_var_ht(name, &varname);
6049 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006050 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006051 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006052 if (v != NULL)
6053 break;
6054 }
6055 if (current_funccal == current_funccal->func->uf_scoped)
6056 break;
6057 current_funccal = current_funccal->func->uf_scoped;
6058 }
6059 current_funccal = old_current_funccal;
6060
6061 return v;
6062}
6063
6064/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006065 * Set "copyID + 1" in previous_funccal and callers.
6066 */
6067 int
6068set_ref_in_previous_funccal(int copyID)
6069{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006070 funccall_T *fc;
6071
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006072 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006073 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006074 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006075 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6076 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6077 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6078 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006079 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006080 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006081}
6082
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006083 static int
6084set_ref_in_funccal(funccall_T *fc, int copyID)
6085{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006086 if (fc->fc_copyID != copyID)
6087 {
6088 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006089 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6090 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6091 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6092 || set_ref_in_func(NULL, fc->func, copyID))
6093 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006094 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006095 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006096}
6097
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006098/*
6099 * Set "copyID" in all local vars and arguments in the call stack.
6100 */
6101 int
6102set_ref_in_call_stack(int copyID)
6103{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006104 funccall_T *fc;
6105 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006106
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006107 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6108 if (set_ref_in_funccal(fc, copyID))
6109 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006110
6111 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006112 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6113 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6114 if (set_ref_in_funccal(fc, copyID))
6115 return TRUE;
6116 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006117}
6118
6119/*
6120 * Set "copyID" in all functions available by name.
6121 */
6122 int
6123set_ref_in_functions(int copyID)
6124{
6125 int todo;
6126 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006127 ufunc_T *fp;
6128
6129 todo = (int)func_hashtab.ht_used;
6130 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006131 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006132 if (!HASHITEM_EMPTY(hi))
6133 {
6134 --todo;
6135 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006136 if (!func_name_refcount(fp->uf_name)
6137 && set_ref_in_func(NULL, fp, copyID))
6138 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006139 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006140 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006141 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006142}
6143
6144/*
6145 * Set "copyID" in all function arguments.
6146 */
6147 int
6148set_ref_in_func_args(int copyID)
6149{
6150 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006151
6152 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006153 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6154 copyID, NULL, NULL))
6155 return TRUE;
6156 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006157}
6158
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006159/*
6160 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006161 * Returns TRUE if setting references failed somehow.
6162 */
6163 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006164set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006165{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006166 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006167 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006168 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006169 char_u fname_buf[FLEN_FIXED + 1];
6170 char_u *tofree = NULL;
6171 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006172 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006173
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006174 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006175 return FALSE;
6176
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006177 if (fp_in == NULL)
6178 {
6179 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006180 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006181 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006182 if (fp != NULL)
6183 {
6184 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006185 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006186 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006187
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006188 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006189 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006190}
6191
Bram Moolenaare38eab22019-12-05 21:50:01 +01006192#endif // FEAT_EVAL