blob: 03b310d67bd18ad7f3fbe7d57f8244e3f5fd9fca [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 Moolenaar7a6eaa02021-03-21 20:53:29 +0100824
825 // skip ':' and blanks
826 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
827 ;
828
829 // Check for "endfunction", "enddef" or "}".
830 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200831 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100832 ? *p == '}'
833 : (checkforcmd(&p, nesting_def[nesting]
834 ? "enddef" : "endfunction", 4)
835 && *p != ':'))
836 {
837 if (nesting-- == 0)
838 {
839 char_u *nextcmd = NULL;
840
841 if (*p == '|' || *p == '}')
842 nextcmd = p + 1;
843 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
844 nextcmd = line_arg;
845 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100846 && (vim9_function || p_verbose > 0))
847 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200848 SOURCING_LNUM = sourcing_lnum_top
849 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100850 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000851 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100852 else
853 give_warning2((char_u *)
854 _("W22: Text found after :endfunction: %s"),
855 p, TRUE);
856 }
857 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100858 {
859 // Another command follows. If the line came from "eap"
860 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000861 // change "eap->cmdlinep" to point to the last fetched
862 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100863 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000864 if (lines_to_free->ga_len > 0
865 && *eap->cmdlinep !=
866 ((char_u **)lines_to_free->ga_data)
867 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000869 // *cmdlinep will be freed later, thus remove the
870 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100871 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000872 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
873 [lines_to_free->ga_len - 1];
874 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100875 }
876 }
877 break;
878 }
879 }
880
881 // Check for mismatched "endfunc" or "enddef".
882 // We don't check for "def" inside "func" thus we also can't check
883 // for "enddef".
884 // We continue to find the end of the function, although we might
885 // not find it.
886 else if (nesting_def[nesting])
887 {
888 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
889 emsg(_(e_mismatched_endfunction));
890 }
891 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
892 emsg(_(e_mismatched_enddef));
893
894 // Increase indent inside "if", "while", "for" and "try", decrease
895 // at "end".
896 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
897 indent -= 2;
898 else if (STRNCMP(p, "if", 2) == 0
899 || STRNCMP(p, "wh", 2) == 0
900 || STRNCMP(p, "for", 3) == 0
901 || STRNCMP(p, "try", 3) == 0)
902 indent += 2;
903
904 // Check for defining a function inside this function.
905 // Only recognize "def" inside "def", not inside "function",
906 // For backwards compatibility, see Test_function_python().
907 c = *p;
908 if (is_function_cmd(&p)
909 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
910 {
911 if (*p == '!')
912 p = skipwhite(p + 1);
913 p += eval_fname_script(p);
914 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
915 NULL, NULL));
916 if (*skipwhite(p) == '(')
917 {
918 if (nesting == MAX_FUNC_NESTING - 1)
919 emsg(_(e_function_nesting_too_deep));
920 else
921 {
922 ++nesting;
923 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200924 nesting_inline[nesting] = FALSE;
925 indent += 2;
926 }
927 }
928 }
929
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200930 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200931 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200932 // Not a comment line: check for nested inline function.
933 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200934 while (end > p && VIM_ISWHITE(*end))
935 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200936 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200937 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200938 int is_block;
939
940 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200941 --end;
942 while (end > p && VIM_ISWHITE(*end))
943 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200944 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
945 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200946 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200947 char_u *s = p;
948
949 // check for line starting with "au" for :autocmd or
950 // "com" for :command, these can use a {} block
951 is_block = checkforcmd_noparen(&s, "autocmd", 2)
952 || checkforcmd_noparen(&s, "command", 3);
953 }
954
955 if (is_block)
956 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200957 if (nesting == MAX_FUNC_NESTING - 1)
958 emsg(_(e_function_nesting_too_deep));
959 else
960 {
961 ++nesting;
962 nesting_def[nesting] = TRUE;
963 nesting_inline[nesting] = TRUE;
964 indent += 2;
965 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100966 }
967 }
968 }
969
970 // Check for ":append", ":change", ":insert". Not for :def.
971 p = skip_range(p, FALSE, NULL);
972 if (!vim9_function
973 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
974 || (p[0] == 'c'
975 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
976 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
977 && (STRNCMP(&p[3], "nge", 3) != 0
978 || !ASCII_ISALPHA(p[6])))))))
979 || (p[0] == 'i'
980 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
981 && (!ASCII_ISALPHA(p[2])
982 || (p[2] == 's'
983 && (!ASCII_ISALPHA(p[3])
984 || p[3] == 'e'))))))))
985 skip_until = vim_strsave((char_u *)".");
986
987 // Check for ":python <<EOF", ":tcl <<EOF", etc.
988 arg = skipwhite(skiptowhite(p));
989 if (arg[0] == '<' && arg[1] =='<'
990 && ((p[0] == 'p' && p[1] == 'y'
991 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
992 || ((p[2] == '3' || p[2] == 'x')
993 && !ASCII_ISALPHA(p[3]))))
994 || (p[0] == 'p' && p[1] == 'e'
995 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
996 || (p[0] == 't' && p[1] == 'c'
997 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
998 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
999 && !ASCII_ISALPHA(p[3]))
1000 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1001 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1002 || (p[0] == 'm' && p[1] == 'z'
1003 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1004 ))
1005 {
1006 // ":python <<" continues until a dot, like ":append"
1007 p = skipwhite(arg + 2);
1008 if (STRNCMP(p, "trim", 4) == 0)
1009 {
1010 // Ignore leading white space.
1011 p = skipwhite(p + 4);
1012 heredoc_trimmed = vim_strnsave(theline,
1013 skipwhite(theline) - theline);
1014 }
1015 if (*p == NUL)
1016 skip_until = vim_strsave((char_u *)".");
1017 else
1018 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1019 getline_options = GETLINE_NONE;
1020 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001021 if (eap->cmdidx == CMD_def)
1022 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001023 }
1024
1025 // Check for ":cmd v =<< [trim] EOF"
1026 // and ":cmd [a, b] =<< [trim] EOF"
1027 // and "lines =<< [trim] EOF" for Vim9
1028 // Where "cmd" can be "let", "var", "final" or "const".
1029 arg = skipwhite(skiptowhite(p));
1030 if (*arg == '[')
1031 arg = vim_strchr(arg, ']');
1032 if (arg != NULL)
1033 {
1034 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1035 && arg[1] == '<' && arg[2] =='<');
1036
1037 if (!found)
1038 // skip over the argument after "cmd"
1039 arg = skipwhite(skiptowhite(arg));
1040 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1041 && (checkforcmd(&p, "let", 2)
1042 || checkforcmd(&p, "var", 3)
1043 || checkforcmd(&p, "final", 5)
1044 || checkforcmd(&p, "const", 5))))
1045 {
1046 p = skipwhite(arg + 3);
1047 if (STRNCMP(p, "trim", 4) == 0)
1048 {
1049 // Ignore leading white space.
1050 p = skipwhite(p + 4);
1051 heredoc_trimmed = vim_strnsave(theline,
1052 skipwhite(theline) - theline);
1053 }
1054 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1055 getline_options = GETLINE_NONE;
1056 is_heredoc = TRUE;
1057 }
1058 }
1059 }
1060
1061 // Add the line to the function.
1062 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1063 goto theend;
1064
Bram Moolenaar20677332021-06-06 17:02:53 +02001065 if (heredoc_concat_len > 0)
1066 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001067 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001068 // to be used for the instruction later.
1069 ga_concat(&heredoc_ga, theline);
1070 ga_concat(&heredoc_ga, (char_u *)"\n");
1071 p = vim_strsave((char_u *)"");
1072 }
1073 else
1074 {
1075 // Copy the line to newly allocated memory. get_one_sourceline()
1076 // allocates 250 bytes per line, this saves 80% on average. The
1077 // cost is an extra alloc/free.
1078 p = vim_strsave(theline);
1079 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 if (p == NULL)
1081 goto theend;
1082 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1083
1084 // Add NULL lines for continuation lines, so that the line count is
1085 // equal to the index in the growarray.
1086 while (sourcing_lnum_off-- > 0)
1087 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1088
1089 // Check for end of eap->arg.
1090 if (line_arg != NULL && *line_arg == NUL)
1091 line_arg = NULL;
1092 }
1093
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001094 // Return OK when no error was detected.
1095 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001096 ret = OK;
1097
1098theend:
1099 vim_free(skip_until);
1100 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001101 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001102 need_wait_return |= saved_wait_return;
1103 return ret;
1104}
1105
1106/*
1107 * Handle the body of a lambda. *arg points to the "{", process statements
1108 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001109 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001110 * When successful "rettv" is set to a funcref.
1111 */
1112 static int
1113lambda_function_body(
1114 char_u **arg,
1115 typval_T *rettv,
1116 evalarg_T *evalarg,
1117 garray_T *newargs,
1118 garray_T *argtypes,
1119 int varargs,
1120 garray_T *default_args,
1121 char_u *ret_type)
1122{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001123 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001124 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001125 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001126 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001127 exarg_T eap;
1128 garray_T newlines;
1129 char_u *cmdline = NULL;
1130 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001131 partial_T *pt;
1132 char_u *name;
1133 int lnum_save = -1;
1134 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1135
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001136 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1137 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001138 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001139 return FAIL;
1140 }
1141
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 CLEAR_FIELD(eap);
1143 eap.cmdidx = CMD_block;
1144 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001145 eap.cmdlinep = &cmdline;
1146 eap.skip = !evaluate;
1147 if (evalarg->eval_cctx != NULL)
1148 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1149 else
1150 {
1151 eap.getline = evalarg->eval_getline;
1152 eap.cookie = evalarg->eval_cookie;
1153 }
1154
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001155 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001156 if (get_function_body(&eap, &newlines, NULL,
1157 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001158 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001159
1160 // When inside a lambda must add the function lines to evalarg.eval_ga.
1161 evalarg->eval_break_count += newlines.ga_len;
1162 if (gap->ga_itemsize > 0)
1163 {
1164 int idx;
1165 char_u *last;
1166 size_t plen;
1167 char_u *pnl;
1168
1169 for (idx = 0; idx < newlines.ga_len; ++idx)
1170 {
1171 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1172
Bram Moolenaarecb66452021-05-18 15:09:18 +02001173 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001174 goto erret;
1175
1176 // Going to concatenate the lines after parsing. For an empty or
1177 // comment line use an empty string.
1178 // Insert NL characters at the start of each line, the string will
1179 // be split again later in .get_lambda_tv().
1180 if (*p == NUL || vim9_comment_start(p))
1181 p = (char_u *)"";
1182 plen = STRLEN(p);
1183 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1184 if (pnl != NULL)
1185 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001186 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1187 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001188 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001189 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001190 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001191 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001192 // more is following after the "}", which was skipped
1193 last = cmdline;
1194 else
1195 // nothing is following the "}"
1196 last = (char_u *)"}";
1197 plen = STRLEN(last);
1198 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1199 if (pnl != NULL)
1200 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001201 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1202 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001203 }
1204
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001205 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001207 garray_T *tfgap = &evalarg->eval_tofree_ga;
1208
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001209 // Something comes after the "}".
1210 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001211
1212 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001213 if (ga_grow(tfgap, 1) == OK)
1214 {
1215 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1216 evalarg->eval_using_cmdline = TRUE;
1217 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001218 }
1219 else
1220 *arg = (char_u *)"";
1221
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001222 if (!evaluate)
1223 {
1224 ret = OK;
1225 goto erret;
1226 }
1227
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001228 name = get_lambda_name();
1229 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1230 if (ufunc == NULL)
1231 goto erret;
1232 set_ufunc_name(ufunc, name);
1233 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001234 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001235 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001236 ufunc->uf_refcount = 1;
1237 ufunc->uf_args = *newargs;
1238 newargs->ga_data = NULL;
1239 ufunc->uf_def_args = *default_args;
1240 default_args->ga_data = NULL;
1241 ufunc->uf_func_type = &t_func_any;
1242
1243 // error messages are for the first function line
1244 lnum_save = SOURCING_LNUM;
1245 SOURCING_LNUM = sourcing_lnum_top;
1246
1247 // parse argument types
1248 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1249 {
1250 SOURCING_LNUM = lnum_save;
1251 goto erret;
1252 }
1253
1254 // parse the return type, if any
1255 if (parse_return_type(ufunc, ret_type) == FAIL)
1256 goto erret;
1257
1258 pt = ALLOC_CLEAR_ONE(partial_T);
1259 if (pt == NULL)
1260 goto erret;
1261 pt->pt_func = ufunc;
1262 pt->pt_refcount = 1;
1263
1264 ufunc->uf_lines = newlines;
1265 newlines.ga_data = NULL;
1266 if (sandbox)
1267 ufunc->uf_flags |= FC_SANDBOX;
1268 if (!ASCII_ISUPPER(*ufunc->uf_name))
1269 ufunc->uf_flags |= FC_VIM9;
1270 ufunc->uf_script_ctx = current_sctx;
1271 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1272 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1273 set_function_type(ufunc);
1274
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001275 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1276
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001277 rettv->vval.v_partial = pt;
1278 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001279 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001280 ret = OK;
1281
1282erret:
1283 if (lnum_save >= 0)
1284 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001286 if (newargs != NULL)
1287 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001288 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001289 if (ufunc != NULL)
1290 {
1291 func_clear(ufunc, TRUE);
1292 func_free(ufunc, TRUE);
1293 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001294 return ret;
1295}
1296
1297/*
1298 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001299 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001300 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001301 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1302 */
1303 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001304get_lambda_tv(
1305 char_u **arg,
1306 typval_T *rettv,
1307 int types_optional,
1308 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001310 int evaluate = evalarg != NULL
1311 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001312 garray_T newargs;
1313 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001314 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001315 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001316 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001318 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001319 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001320 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001321 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001322 char_u *s;
1323 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001324 int *old_eval_lavars = eval_lavars_used;
1325 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001326 char_u *tofree1 = NULL;
1327 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001328 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001329 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001330 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001331 int vim9script = in_vim9script();
Bram Moolenaar65c44152020-12-24 15:14:01 +01001332
Bram Moolenaar4525a572022-02-13 11:57:33 +00001333 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001334 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001335
1336 ga_init(&newargs);
1337 ga_init(&newlines);
1338
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001339 // First, check if this is really a lambda expression. "->" or "=>" must
1340 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001341 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001342 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001343 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001344 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001345 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001346 {
1347 if (types_optional)
1348 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001349 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001350 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001351
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001352 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001353 if (evaluate)
1354 pnewargs = &newargs;
1355 else
1356 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001357 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001358 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001359 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001360 &varargs, &default_args,
1361 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001362 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001363 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001364 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001365 {
1366 if (types_optional)
1367 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001368 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001369 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001370 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001371 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001373 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1374 if (ret_type != NULL)
1375 {
1376 ret_type = vim_strsave(ret_type);
1377 tofree2 = ret_type;
1378 }
1379
Bram Moolenaare38eab22019-12-05 21:50:01 +01001380 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001381 if (evaluate)
1382 eval_lavars_used = &eval_lavars;
1383
Bram Moolenaar65c44152020-12-24 15:14:01 +01001384 *arg = skipwhite_and_linebreak(*arg, evalarg);
1385
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001386 // Recognize "{" as the start of a function body.
1387 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001388 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001389 if (evalarg == NULL)
1390 // cannot happen?
1391 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001392 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1393 types_optional ? &argtypes : NULL, varargs,
1394 &default_args, ret_type) == FAIL)
1395 goto errret;
1396 goto theend;
1397 }
1398 if (default_args.ga_len > 0)
1399 {
1400 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001401 goto errret;
1402 }
1403
Bram Moolenaare38eab22019-12-05 21:50:01 +01001404 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001405 start = *arg;
1406 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001407 if (ret == FAIL)
1408 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001409 if (evalarg != NULL)
1410 {
1411 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001412 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001413 evalarg->eval_tofree = NULL;
1414 }
1415
Bram Moolenaar65c44152020-12-24 15:14:01 +01001416 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001417 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001418 *arg = skipwhite_and_linebreak(*arg, evalarg);
1419 if (**arg != '}')
1420 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001421 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001422 goto errret;
1423 }
1424 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001425 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001426
1427 if (evaluate)
1428 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001429 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001430 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001431 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001432 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001433 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001434
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001435 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001436 if (fp == NULL)
1437 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001438 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001439 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001440 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001441 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001442
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001443 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 if (ga_grow(&newlines, 1) == FAIL)
1445 goto errret;
1446
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001447 // If there are line breaks, we need to split up the string.
1448 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001449 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001450 line_end = end;
1451
1452 // Add "return " before the expression (or the first line).
1453 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001454 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 if (p == NULL)
1456 goto errret;
1457 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1458 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001459 vim_strncpy(p + 7, start, line_end - start);
1460
1461 if (line_end != end)
1462 {
1463 // Add more lines, split by line breaks. Thus is used when a
1464 // lambda with { cmds } is encountered.
1465 while (*line_end == '\n')
1466 {
1467 if (ga_grow(&newlines, 1) == FAIL)
1468 goto errret;
1469 start = line_end + 1;
1470 line_end = vim_strchr(start, '\n');
1471 if (line_end == NULL)
1472 line_end = end;
1473 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1474 vim_strnsave(start, line_end - start);
1475 }
1476 }
1477
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001478 if (strstr((char *)p + 7, "a:") == NULL)
1479 // No a: variables are used for sure.
1480 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481
1482 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001483 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001485 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001486 if (types_optional)
1487 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001488 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001489 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001490 goto errret;
1491 if (ret_type != NULL)
1492 {
1493 fp->uf_ret_type = parse_type(&ret_type,
1494 &fp->uf_type_list, TRUE);
1495 if (fp->uf_ret_type == NULL)
1496 goto errret;
1497 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001498 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001499 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001500 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001501
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001502 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001503 if (current_funccal != NULL && eval_lavars)
1504 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001505 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001506 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001507 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001508 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509
1510#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511 if (prof_def_func())
1512 func_do_profile(fp);
1513#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001514 if (sandbox)
1515 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001516 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001517 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001518 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001519 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001521 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001522 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001524 function_using_block_scopes(fp, evalarg->eval_cstack);
1525
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001526 pt->pt_func = fp;
1527 pt->pt_refcount = 1;
1528 rettv->vval.v_partial = pt;
1529 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001530
1531 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001533
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001534theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001535 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001536 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001537 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001538 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001539 vim_free(tofree1);
1540 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001541 if (types_optional)
1542 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001543
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 return OK;
1545
1546errret:
1547 ga_clear_strings(&newargs);
1548 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001549 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001550 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001551 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001552 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001553 if (fp != NULL)
1554 vim_free(fp->uf_arg_types);
1555 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001557 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001558 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001559 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001560 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001561 vim_free(tofree1);
1562 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001563 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 return FAIL;
1565}
1566
1567/*
1568 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1569 * name it contains, otherwise return "name".
1570 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1571 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001572 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1573 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001574 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001575 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 */
1577 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001578deref_func_name(
1579 char_u *name,
1580 int *lenp,
1581 partial_T **partialp,
1582 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001583 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001584 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001585 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001586{
1587 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001588 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001590 char_u *s = NULL;
1591 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001592 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593
1594 if (partialp != NULL)
1595 *partialp = NULL;
1596
1597 cc = name[*lenp];
1598 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001599
Bram Moolenaar71f21932022-01-07 18:20:55 +00001600 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001602 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001604 tv = &v->di_tv;
1605 }
1606 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1607 {
1608 imported_T *import;
1609 char_u *p = name;
1610 int len = *lenp;
1611
1612 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001614 p = name + 2;
1615 len -= 2;
1616 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001617 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001618
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001619 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001620 if (import != NULL)
1621 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001622 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001623 if (new_function)
1624 semsg(_(e_redefining_imported_item_str), name);
1625 else
1626 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001627 name[len] = cc;
1628 *lenp = 0;
1629 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001630 }
1631 }
1632
1633 if (tv != NULL)
1634 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001635 if (found_var != NULL)
1636 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001637 if (tv->v_type == VAR_FUNC)
1638 {
1639 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001640 {
1641 *lenp = 0;
1642 return (char_u *)""; // just in case
1643 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001644 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001645 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001646 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001648 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001650 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001651
1652 if (pt == NULL)
1653 {
1654 *lenp = 0;
1655 return (char_u *)""; // just in case
1656 }
1657 if (partialp != NULL)
1658 *partialp = pt;
1659 s = partial_name(pt);
1660 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001662
1663 if (s != NULL)
1664 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001665 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001666 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001667 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001668
1669 if (sv != NULL)
1670 *type = sv->sv_type;
1671 }
1672 return s;
1673 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001674 }
1675
1676 return name;
1677}
1678
1679/*
1680 * Give an error message with a function name. Handle <SNR> things.
1681 * "ermsg" is to be passed without translation, use N_() instead of _().
1682 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001683 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684emsg_funcname(char *ermsg, char_u *name)
1685{
Bram Moolenaar54598062022-01-13 12:05:09 +00001686 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687
Bram Moolenaar54598062022-01-13 12:05:09 +00001688 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001689 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001690 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 if (p != name)
1692 vim_free(p);
1693}
1694
1695/*
1696 * Allocate a variable for the result of a function.
1697 * Return OK or FAIL.
1698 */
1699 int
1700get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001701 char_u *name, // name of the function
1702 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001704 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001705 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001706 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707{
1708 char_u *argp;
1709 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001710 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1711 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001712 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001713 int evaluate = evalarg == NULL
1714 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715
1716 /*
1717 * Get the arguments.
1718 */
1719 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001720 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1721 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001723 // skip the '(' or ',' and possibly line breaks
1724 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1725
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 if (*argp == ')' || *argp == ',' || *argp == NUL)
1727 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001728 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001729 {
1730 ret = FAIL;
1731 break;
1732 }
1733 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001734 // The comma should come right after the argument, but this wasn't
1735 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001736 if (vim9script)
1737 {
1738 if (*argp != ',' && *skipwhite(argp) == ',')
1739 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001740 if (evaluate)
1741 semsg(_(e_no_white_space_allowed_before_str_str),
1742 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001743 ret = FAIL;
1744 break;
1745 }
1746 }
1747 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001748 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 if (*argp != ',')
1750 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001751 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1752 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001753 if (evaluate)
1754 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001755 ret = FAIL;
1756 break;
1757 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001759 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001760 if (*argp == ')')
1761 ++argp;
1762 else
1763 ret = FAIL;
1764
1765 if (ret == OK)
1766 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001767 int i = 0;
1768 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769
1770 if (get_vim_var_nr(VV_TESTING))
1771 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001772 // Prepare for calling test_garbagecollect_now(), need to know
1773 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001774 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001775 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 for (i = 0; i < argcount; ++i)
1777 if (ga_grow(&funcargs, 1) == OK)
1778 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1779 &argvars[i];
1780 }
1781
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001782 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001783 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001784 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001785 // An error in a builtin function does not return FAIL, but we do
1786 // want to abort further processing if an error was given.
1787 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001788 clear_tv(rettv);
1789 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790
1791 funcargs.ga_len -= i;
1792 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001793 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001794 {
1795 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001796 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001797 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001798 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799 }
1800
1801 while (--argcount >= 0)
1802 clear_tv(&argvars[argcount]);
1803
Bram Moolenaar4525a572022-02-13 11:57:33 +00001804 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001805 *arg = argp;
1806 else
1807 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 return ret;
1809}
1810
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811/*
1812 * Return TRUE if "p" starts with "<SID>" or "s:".
1813 * Only works if eval_fname_script() returned non-zero for "p"!
1814 */
1815 static int
1816eval_fname_sid(char_u *p)
1817{
1818 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1819}
1820
1821/*
1822 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1823 * Change <SNR>123_name() to K_SNR 123_name().
1824 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1825 * (slow).
1826 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001827 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1829{
1830 int llen;
1831 char_u *fname;
1832 int i;
1833
1834 llen = eval_fname_script(name);
1835 if (llen > 0)
1836 {
1837 fname_buf[0] = K_SPECIAL;
1838 fname_buf[1] = KS_EXTRA;
1839 fname_buf[2] = (int)KE_SNR;
1840 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001841 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001842 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001843 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001844 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 else
1846 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001847 sprintf((char *)fname_buf + 3, "%ld_",
1848 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849 i = (int)STRLEN(fname_buf);
1850 }
1851 }
1852 if (i + STRLEN(name + llen) < FLEN_FIXED)
1853 {
1854 STRCPY(fname_buf + i, name + llen);
1855 fname = fname_buf;
1856 }
1857 else
1858 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001859 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001860 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001861 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001862 else
1863 {
1864 *tofree = fname;
1865 mch_memmove(fname, fname_buf, (size_t)i);
1866 STRCPY(fname + i, name + llen);
1867 }
1868 }
1869 }
1870 else
1871 fname = name;
1872 return fname;
1873}
1874
1875/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001876 * Find a function "name" in script "sid".
1877 */
1878 static ufunc_T *
1879find_func_with_sid(char_u *name, int sid)
1880{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001881 hashitem_T *hi;
1882 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001883
Bram Moolenaarb8822442022-01-11 15:24:05 +00001884 if (!SCRIPT_ID_VALID(sid))
1885 return NULL; // not in a script
1886
1887 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888 buffer[0] = K_SPECIAL;
1889 buffer[1] = KS_EXTRA;
1890 buffer[2] = (int)KE_SNR;
1891 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1892 (long)sid, name);
1893 hi = hash_find(&func_hashtab, buffer);
1894 if (!HASHITEM_EMPTY(hi))
1895 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001896 return NULL;
1897}
1898
1899/*
1900 * Find a function "name" in script "sid" prefixing the autoload prefix.
1901 */
1902 static ufunc_T *
1903find_func_with_prefix(char_u *name, int sid)
1904{
1905 hashitem_T *hi;
1906 char_u buffer[200];
1907 scriptitem_T *si;
1908
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001909 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001910 return NULL; // already has the prefix
1911 if (!SCRIPT_ID_VALID(sid))
1912 return NULL; // not in a script
1913 si = SCRIPT_ITEM(sid);
1914 if (si->sn_autoload_prefix != NULL)
1915 {
1916 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1917 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001918 char_u *namep;
1919
1920 // skip a "<SNR>99_" prefix
1921 namep = untrans_function_name(name);
1922 if (namep == NULL)
1923 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001924
1925 // An exported function in an autoload script is stored as
1926 // "dir#path#name".
1927 if (len < sizeof(buffer))
1928 auto_name = buffer;
1929 else
1930 auto_name = alloc(len);
1931 if (auto_name != NULL)
1932 {
1933 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001934 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001935 hi = hash_find(&func_hashtab, auto_name);
1936 if (auto_name != buffer)
1937 vim_free(auto_name);
1938 if (!HASHITEM_EMPTY(hi))
1939 return HI2UF(hi);
1940 }
1941 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942
1943 return NULL;
1944}
1945
1946/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001948 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1949 * functions.
1950 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951 * Return NULL for unknown function.
1952 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001953 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001954find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001955{
1956 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001958
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001959 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00001961 // Find script-local function before global one.
1962 if (in_vim9script() && eval_isnamec1(*name)
1963 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001964 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001965 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1966 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001967 if (func != NULL)
1968 return func;
1969 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00001970 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
1971 {
1972 char_u *p = name + 5;
1973 long sid;
1974
1975 // printable "<SNR>123_Name" form
1976 sid = getdigits(&p);
1977 if (*p == '_')
1978 {
1979 func = find_func_with_sid(p + 1, (int)sid);
1980 if (func != NULL)
1981 return func;
1982 }
1983 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001984 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001985
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001986 if ((flags & FFED_NO_GLOBAL) == 0)
1987 {
1988 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02001989 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001990 if (!HASHITEM_EMPTY(hi))
1991 return HI2UF(hi);
1992 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001993
Bram Moolenaarb8822442022-01-11 15:24:05 +00001994 // Find autoload function if this is an autoload script.
1995 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1996 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001997}
1998
1999/*
2000 * Find a function by name, return pointer to it in ufuncs.
2001 * "cctx" is passed in a :def function to find imported functions.
2002 * Return NULL for unknown or dead function.
2003 */
2004 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002005find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002006{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002007 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002008
2009 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2010 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002011 return NULL;
2012}
2013
2014/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002015 * Return TRUE if "ufunc" is a global function.
2016 */
2017 int
2018func_is_global(ufunc_T *ufunc)
2019{
2020 return ufunc->uf_name[0] != K_SPECIAL;
2021}
2022
2023/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002024 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2025 */
2026 int
2027func_requires_g_prefix(ufunc_T *ufunc)
2028{
2029 return ufunc->uf_name[0] != K_SPECIAL
2030 && (ufunc->uf_flags & FC_LAMBDA) == 0
2031 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2032}
2033
2034/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002035 * Copy the function name of "fp" to buffer "buf".
2036 * "buf" must be able to hold the function name plus three bytes.
2037 * Takes care of script-local function names.
2038 */
2039 static void
2040cat_func_name(char_u *buf, ufunc_T *fp)
2041{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002042 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002043 {
2044 STRCPY(buf, "<SNR>");
2045 STRCAT(buf, fp->uf_name + 3);
2046 }
2047 else
2048 STRCPY(buf, fp->uf_name);
2049}
2050
2051/*
2052 * Add a number variable "name" to dict "dp" with value "nr".
2053 */
2054 static void
2055add_nr_var(
2056 dict_T *dp,
2057 dictitem_T *v,
2058 char *name,
2059 varnumber_T nr)
2060{
2061 STRCPY(v->di_key, name);
2062 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2063 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2064 v->di_tv.v_type = VAR_NUMBER;
2065 v->di_tv.v_lock = VAR_FIXED;
2066 v->di_tv.vval.v_number = nr;
2067}
2068
2069/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002070 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002071 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002072 static void
2073free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002074{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002075 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002076
2077 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2078 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002079 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002080
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002081 // When garbage collecting a funccall_T may be freed before the
2082 // function that references it, clear its uf_scoped field.
2083 // The function may have been redefined and point to another
2084 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002085 if (fp != NULL && fp->uf_scoped == fc)
2086 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002087 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002088 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002089
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002090 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002091 vim_free(fc);
2092}
2093
2094/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002095 * Free "fc" and what it contains.
2096 * Can be called only when "fc" is kept beyond the period of it called,
2097 * i.e. after cleanup_function_call(fc).
2098 */
2099 static void
2100free_funccal_contents(funccall_T *fc)
2101{
2102 listitem_T *li;
2103
2104 // Free all l: variables.
2105 vars_clear(&fc->l_vars.dv_hashtab);
2106
2107 // Free all a: variables.
2108 vars_clear(&fc->l_avars.dv_hashtab);
2109
2110 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002111 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002112 clear_tv(&li->li_tv);
2113
2114 free_funccal(fc);
2115}
2116
2117/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002118 * Handle the last part of returning from a function: free the local hashtable.
2119 * Unless it is still in use by a closure.
2120 */
2121 static void
2122cleanup_function_call(funccall_T *fc)
2123{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002124 int may_free_fc = fc->fc_refcount <= 0;
2125 int free_fc = TRUE;
2126
Bram Moolenaar6914c642017-04-01 21:21:30 +02002127 current_funccal = fc->caller;
2128
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002129 // Free all l: variables if not referred.
2130 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2131 vars_clear(&fc->l_vars.dv_hashtab);
2132 else
2133 free_fc = FALSE;
2134
2135 // If the a:000 list and the l: and a: dicts are not referenced and
2136 // there is no closure using it, we can free the funccall_T and what's
2137 // in it.
2138 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2139 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002140 else
2141 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 int todo;
2143 hashitem_T *hi;
2144 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002145
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002146 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002147
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002148 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002149 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2150 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2151 {
2152 if (!HASHITEM_EMPTY(hi))
2153 {
2154 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002155 di = HI2DI(hi);
2156 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002157 }
2158 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002159 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002160
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002161 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2162 fc->l_varlist.lv_first = NULL;
2163 else
2164 {
2165 listitem_T *li;
2166
2167 free_fc = FALSE;
2168
2169 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002170 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002171 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002172 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002173
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002174 if (free_fc)
2175 free_funccal(fc);
2176 else
2177 {
2178 static int made_copy = 0;
2179
2180 // "fc" is still in use. This can happen when returning "a:000",
2181 // assigning "l:" to a global variable or defining a closure.
2182 // Link "fc" in the list for garbage collection later.
2183 fc->caller = previous_funccal;
2184 previous_funccal = fc;
2185
2186 if (want_garbage_collect)
2187 // If garbage collector is ready, clear count.
2188 made_copy = 0;
2189 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002190 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002191 // We have made a lot of copies, worth 4 Mbyte. This can happen
2192 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002193 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002194 // too much memory.
2195 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002196 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002197 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002198 }
2199}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002200
2201/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002202 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2203 */
2204 static int
2205numbered_function(char_u *name)
2206{
2207 return isdigit(*name)
2208 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2209}
2210
2211/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002212 * There are two kinds of function names:
2213 * 1. ordinary names, function defined with :function or :def
2214 * 2. numbered functions and lambdas
2215 * For the first we only count the name stored in func_hashtab as a reference,
2216 * using function() does not count as a reference, because the function is
2217 * looked up by name.
2218 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002219 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002220func_name_refcount(char_u *name)
2221{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002222 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002223}
2224
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002225/*
2226 * Unreference "fc": decrement the reference count and free it when it
2227 * becomes zero. "fp" is detached from "fc".
2228 * When "force" is TRUE we are exiting.
2229 */
2230 static void
2231funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2232{
2233 funccall_T **pfc;
2234 int i;
2235
2236 if (fc == NULL)
2237 return;
2238
2239 if (--fc->fc_refcount <= 0 && (force || (
2240 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2241 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2242 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2243 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2244 {
2245 if (fc == *pfc)
2246 {
2247 *pfc = fc->caller;
2248 free_funccal_contents(fc);
2249 return;
2250 }
2251 }
2252 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2253 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2254 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2255}
2256
2257/*
2258 * Remove the function from the function hashtable. If the function was
2259 * deleted while it still has references this was already done.
2260 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2261 */
2262 static int
2263func_remove(ufunc_T *fp)
2264{
2265 hashitem_T *hi;
2266
2267 // Return if it was already virtually deleted.
2268 if (fp->uf_flags & FC_DEAD)
2269 return FALSE;
2270
2271 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2272 if (!HASHITEM_EMPTY(hi))
2273 {
2274 // When there is a def-function index do not actually remove the
2275 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002276 // Do remove it when it's a copy.
2277 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002278 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002279 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002280 return FALSE;
2281 }
2282 hash_remove(&func_hashtab, hi);
2283 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002284 return TRUE;
2285 }
2286 return FALSE;
2287}
2288
2289 static void
2290func_clear_items(ufunc_T *fp)
2291{
2292 ga_clear_strings(&(fp->uf_args));
2293 ga_clear_strings(&(fp->uf_def_args));
2294 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002295 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002296 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002297 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002298 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002299
2300 // Increment the refcount of this function to avoid it being freed
2301 // recursively when the partial is freed.
2302 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002303 partial_unref(fp->uf_partial);
2304 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002305 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002306
2307#ifdef FEAT_LUA
2308 if (fp->uf_cb_free != NULL)
2309 {
2310 fp->uf_cb_free(fp->uf_cb_state);
2311 fp->uf_cb_free = NULL;
2312 }
2313
2314 fp->uf_cb_state = NULL;
2315 fp->uf_cb = NULL;
2316#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002317#ifdef FEAT_PROFILE
2318 VIM_CLEAR(fp->uf_tml_count);
2319 VIM_CLEAR(fp->uf_tml_total);
2320 VIM_CLEAR(fp->uf_tml_self);
2321#endif
2322}
2323
2324/*
2325 * Free all things that a function contains. Does not free the function
2326 * itself, use func_free() for that.
2327 * When "force" is TRUE we are exiting.
2328 */
2329 static void
2330func_clear(ufunc_T *fp, int force)
2331{
2332 if (fp->uf_cleared)
2333 return;
2334 fp->uf_cleared = TRUE;
2335
2336 // clear this function
2337 func_clear_items(fp);
2338 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002339 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002340}
2341
2342/*
2343 * Free a function and remove it from the list of functions. Does not free
2344 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002345 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002346 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002347 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002348 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002349func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002350{
2351 // Only remove it when not done already, otherwise we would remove a newer
2352 // version of the function with the same name.
2353 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2354 func_remove(fp);
2355
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002356 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002357 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002358 if (fp->uf_dfunc_idx > 0)
2359 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002360 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002361 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002362 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002363 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002364 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002365}
2366
2367/*
2368 * Free all things that a function contains and free the function itself.
2369 * When "force" is TRUE we are exiting.
2370 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002371 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002372func_clear_free(ufunc_T *fp, int force)
2373{
2374 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002375 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2376 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002377 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002378 else
2379 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002380}
2381
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002382/*
2383 * Copy already defined function "lambda" to a new function with name "global".
2384 * This is for when a compiled function defines a global function.
2385 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002386 int
2387copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002388{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002389 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002390 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002391
2392 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002393 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002394 semsg(_(e_lambda_function_not_found_str), lambda);
2395 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002396 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002397
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002398 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002399 if (fp != NULL)
2400 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002401 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002402 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002403 return FAIL;
2404 }
2405
2406 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2407 if (fp == NULL)
2408 return FAIL;
2409
2410 fp->uf_varargs = ufunc->uf_varargs;
2411 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2412 fp->uf_def_status = ufunc->uf_def_status;
2413 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2414 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2415 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2416 == FAIL
2417 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2418 goto failed;
2419
2420 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2421 : vim_strsave(ufunc->uf_name_exp);
2422 if (ufunc->uf_arg_types != NULL)
2423 {
2424 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2425 if (fp->uf_arg_types == NULL)
2426 goto failed;
2427 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2428 sizeof(type_T *) * fp->uf_args.ga_len);
2429 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002430 if (ufunc->uf_va_name != NULL)
2431 {
2432 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2433 if (fp->uf_va_name == NULL)
2434 goto failed;
2435 }
2436 fp->uf_ret_type = ufunc->uf_ret_type;
2437
2438 fp->uf_refcount = 1;
2439 STRCPY(fp->uf_name, global);
2440 hash_add(&func_hashtab, UF2HIKEY(fp));
2441
2442 // the referenced dfunc_T is now used one more time
2443 link_def_function(fp);
2444
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002445 // Create a partial to store the context of the function where it was
2446 // instantiated. Only needs to be done once. Do this on the original
2447 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002448 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2449 {
2450 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2451
2452 if (pt == NULL)
2453 goto failed;
2454 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002455 {
2456 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002457 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002458 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002459 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002460 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002461 }
2462
2463 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002464
2465failed:
2466 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002467 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002468}
2469
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002470static int funcdepth = 0;
2471
2472/*
2473 * Increment the function call depth count.
2474 * Return FAIL when going over 'maxfuncdepth'.
2475 * Otherwise return OK, must call funcdepth_decrement() later!
2476 */
2477 int
2478funcdepth_increment(void)
2479{
2480 if (funcdepth >= p_mfd)
2481 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002482 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002483 return FAIL;
2484 }
2485 ++funcdepth;
2486 return OK;
2487}
2488
2489 void
2490funcdepth_decrement(void)
2491{
2492 --funcdepth;
2493}
2494
2495/*
2496 * Get the current function call depth.
2497 */
2498 int
2499funcdepth_get(void)
2500{
2501 return funcdepth;
2502}
2503
2504/*
2505 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002506 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002507 * times as funcdepth_increment().
2508 */
2509 void
2510funcdepth_restore(int depth)
2511{
2512 funcdepth = depth;
2513}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002514
2515/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 * Call a user function.
2517 */
2518 static void
2519call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002520 ufunc_T *fp, // pointer to function
2521 int argcount, // nr of args
2522 typval_T *argvars, // arguments
2523 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002524 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002525 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002527 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002528 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002529 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 funccall_T *fc;
2531 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002532 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002534 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 int i;
2536 int ai;
2537 int islambda = FALSE;
2538 char_u numbuf[NUMBUFLEN];
2539 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002540 typval_T *tv_to_free[MAX_FUNC_ARGS];
2541 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002543 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002545 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002546
Bram Moolenaarb2049902021-01-24 12:53:53 +01002547#ifdef FEAT_PROFILE
2548 CLEAR_FIELD(profile_info);
2549#endif
2550
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002551 // If depth of calling is getting too high, don't execute the function.
2552 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002554 rettv->v_type = VAR_NUMBER;
2555 rettv->vval.v_number = -1;
2556 return;
2557 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558
Bram Moolenaare38eab22019-12-05 21:50:01 +01002559 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002560
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002561 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002562 if (fc == NULL)
2563 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002564 fc->caller = current_funccal;
2565 current_funccal = fc;
2566 fc->func = fp;
2567 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002568 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002569 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2571 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002572 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002573 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002574 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002576 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002577 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002578#ifdef FEAT_PROFILE
2579 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2580#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002581 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002582#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002583 if (do_profiling == PROF_YES)
2584 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002585#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002586 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002587 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002588 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002589#ifdef FEAT_PROFILE
2590 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002591 || (caller != NULL && caller->uf_profiling)))
2592 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002593#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002594 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002596 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002597 return;
2598 }
2599
Bram Moolenaar38453522021-11-28 22:00:12 +00002600 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601
2602 /*
2603 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2604 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2605 * each argument variable and saves a lot of time.
2606 */
2607 /*
2608 * Init l: variables.
2609 */
2610 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2611 if (selfdict != NULL)
2612 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002613 // Set l:self to "selfdict". Use "name" to avoid a warning from
2614 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 v = &fc->fixvar[fixvar_idx++].var;
2616 name = v->di_key;
2617 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002618 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002619 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2620 v->di_tv.v_type = VAR_DICT;
2621 v->di_tv.v_lock = 0;
2622 v->di_tv.vval.v_dict = selfdict;
2623 ++selfdict->dv_refcount;
2624 }
2625
2626 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002627 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002628 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002629 * Set a:000 to a list with room for the "..." arguments.
2630 */
2631 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002632 if ((fp->uf_flags & FC_NOARGS) == 0)
2633 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002634 (varnumber_T)(argcount >= fp->uf_args.ga_len
2635 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002636 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002637 if ((fp->uf_flags & FC_NOARGS) == 0)
2638 {
2639 // Use "name" to avoid a warning from some compiler that checks the
2640 // destination size.
2641 v = &fc->fixvar[fixvar_idx++].var;
2642 name = v->di_key;
2643 STRCPY(name, "000");
2644 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2645 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2646 v->di_tv.v_type = VAR_LIST;
2647 v->di_tv.v_lock = VAR_FIXED;
2648 v->di_tv.vval.v_list = &fc->l_varlist;
2649 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002650 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2652 fc->l_varlist.lv_lock = VAR_FIXED;
2653
2654 /*
2655 * Set a:firstline to "firstline" and a:lastline to "lastline".
2656 * Set a:name to named arguments.
2657 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002658 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002660 if ((fp->uf_flags & FC_NOARGS) == 0)
2661 {
2662 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002663 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002664 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002665 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002666 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002667 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 {
2669 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002670 typval_T def_rettv;
2671 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002672
2673 ai = i - fp->uf_args.ga_len;
2674 if (ai < 0)
2675 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002676 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 name = FUNCARG(fp, i);
2678 if (islambda)
2679 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002680
2681 // evaluate named argument default expression
2682 isdefault = ai + fp->uf_def_args.ga_len >= 0
2683 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2684 && argvars[i].vval.v_number == VVAL_NONE));
2685 if (isdefault)
2686 {
2687 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002688
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002689 def_rettv.v_type = VAR_NUMBER;
2690 def_rettv.vval.v_number = -1;
2691
2692 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2693 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002694 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002695 {
2696 default_arg_err = 1;
2697 break;
2698 }
2699 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700 }
2701 else
2702 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002703 if ((fp->uf_flags & FC_NOARGS) != 0)
2704 // Bail out if no a: arguments used (in lambda).
2705 break;
2706
Bram Moolenaare38eab22019-12-05 21:50:01 +01002707 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708 sprintf((char *)numbuf, "%d", ai + 1);
2709 name = numbuf;
2710 }
2711 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2712 {
2713 v = &fc->fixvar[fixvar_idx++].var;
2714 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002715 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 }
2717 else
2718 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002719 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 if (v == NULL)
2721 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002722 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002725 // Note: the values are copied directly to avoid alloc/free.
2726 // "argvars" must have VAR_FIXED for v_lock.
2727 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 v->di_tv.v_lock = VAR_FIXED;
2729
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002730 if (isdefault)
2731 // Need to free this later, no matter where it's stored.
2732 tv_to_free[tv_to_free_len++] = &v->di_tv;
2733
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734 if (addlocal)
2735 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002736 // Named arguments should be accessed without the "a:" prefix in
2737 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002738 copy_tv(&v->di_tv, &v->di_tv);
2739 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002740 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002741 else
2742 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743
2744 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2745 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002746 listitem_T *li = &fc->l_listitems[ai];
2747
2748 li->li_tv = argvars[i];
2749 li->li_tv.v_lock = VAR_FIXED;
2750 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751 }
2752 }
2753
Bram Moolenaare38eab22019-12-05 21:50:01 +01002754 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002755 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002756
2757 if (fp->uf_flags & FC_SANDBOX)
2758 {
2759 using_sandbox = TRUE;
2760 ++sandbox;
2761 }
2762
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002763 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002764 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002765 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002767 ++no_wait_return;
2768 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002770 smsg(_("calling %s"), SOURCING_NAME);
2771 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002773 char_u buf[MSG_BUF_LEN];
2774 char_u numbuf2[NUMBUFLEN];
2775 char_u *tofree;
2776 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002778 msg_puts("(");
2779 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002781 if (i > 0)
2782 msg_puts(", ");
2783 if (argvars[i].v_type == VAR_NUMBER)
2784 msg_outnum((long)argvars[i].vval.v_number);
2785 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002787 // Do not want errors such as E724 here.
2788 ++emsg_off;
2789 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2790 --emsg_off;
2791 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002793 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002795 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2796 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002798 msg_puts((char *)s);
2799 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 }
2801 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002803 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002805 msg_puts("\n"); // don't overwrite this either
2806
2807 verbose_leave_scroll();
2808 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 }
2810#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002811 if (do_profiling == PROF_YES)
2812 profile_may_start_func(&profile_info, fp,
2813 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814#endif
2815
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002816 // "legacy" does not apply to commands in the function
2817 sticky_cmdmod_flags = 0;
2818
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002819 save_current_sctx = current_sctx;
2820 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 save_did_emsg = did_emsg;
2822 did_emsg = FALSE;
2823
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002824 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2825 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002826 else if (islambda)
2827 {
2828 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2829
2830 // A Lambda always has the command "return {expr}". It is much faster
2831 // to evaluate {expr} directly.
2832 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002833 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002834 --ex_nesting_level;
2835 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002836 else
2837 // call do_cmdline() to execute the lines
2838 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2840
2841 --RedrawingDisabled;
2842
Bram Moolenaare38eab22019-12-05 21:50:01 +01002843 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2845 {
2846 clear_tv(rettv);
2847 rettv->v_type = VAR_NUMBER;
2848 rettv->vval.v_number = -1;
2849 }
2850
2851#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002852 if (do_profiling == PROF_YES)
2853 {
2854 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2855
2856 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2857 profile_may_end_func(&profile_info, fp, caller);
2858 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859#endif
2860
Bram Moolenaare38eab22019-12-05 21:50:01 +01002861 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862 if (p_verbose >= 12)
2863 {
2864 ++no_wait_return;
2865 verbose_enter_scroll();
2866
2867 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002868 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002870 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 (long)fc->rettv->vval.v_number);
2872 else
2873 {
2874 char_u buf[MSG_BUF_LEN];
2875 char_u numbuf2[NUMBUFLEN];
2876 char_u *tofree;
2877 char_u *s;
2878
Bram Moolenaare38eab22019-12-05 21:50:01 +01002879 // The value may be very long. Skip the middle part, so that we
2880 // have some idea how it starts and ends. smsg() would always
2881 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002882 ++emsg_off;
2883 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2884 --emsg_off;
2885 if (s != NULL)
2886 {
2887 if (vim_strsize(s) > MSG_BUF_CLEN)
2888 {
2889 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2890 s = buf;
2891 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002892 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 vim_free(tofree);
2894 }
2895 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002896 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897
2898 verbose_leave_scroll();
2899 --no_wait_return;
2900 }
2901
Bram Moolenaare31ee862020-01-07 20:59:34 +01002902 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002903 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002904 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002905#ifdef FEAT_PROFILE
2906 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002907 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002908#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002909 if (using_sandbox)
2910 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002911 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002913 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002914 {
2915 ++no_wait_return;
2916 verbose_enter_scroll();
2917
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002918 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002919 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002920
2921 verbose_leave_scroll();
2922 --no_wait_return;
2923 }
2924
2925 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002926 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002927 for (i = 0; i < tv_to_free_len; ++i)
2928 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002929 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930}
2931
2932/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002933 * Check the argument count for user function "fp".
2934 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2935 */
2936 int
2937check_user_func_argcount(ufunc_T *fp, int argcount)
2938{
2939 int regular_args = fp->uf_args.ga_len;
2940
2941 if (argcount < regular_args - fp->uf_def_args.ga_len)
2942 return FCERR_TOOFEW;
2943 else if (!has_varargs(fp) && argcount > regular_args)
2944 return FCERR_TOOMANY;
2945 return FCERR_UNKNOWN;
2946}
2947
2948/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002949 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002950 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002951 int
2952call_user_func_check(
2953 ufunc_T *fp,
2954 int argcount,
2955 typval_T *argvars,
2956 typval_T *rettv,
2957 funcexe_T *funcexe,
2958 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002959{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002960 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002961
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002962 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2963 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002964 error = check_user_func_argcount(fp, argcount);
2965 if (error != FCERR_UNKNOWN)
2966 return error;
2967 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002968 error = FCERR_DICT;
2969 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002970 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002971 int did_save_redo = FALSE;
2972 save_redo_T save_redo;
2973
2974 /*
2975 * Call the user function.
2976 * Save and restore search patterns, script variables and
2977 * redo buffer.
2978 */
2979 save_search_patterns();
2980 if (!ins_compl_active())
2981 {
2982 saveRedobuff(&save_redo);
2983 did_save_redo = TRUE;
2984 }
2985 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002986 call_user_func(fp, argcount, argvars, rettv, funcexe,
2987 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002988 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2989 // Function was unreferenced while being used, free it now.
2990 func_clear_free(fp, FALSE);
2991 if (did_save_redo)
2992 restoreRedobuff(&save_redo);
2993 restore_search_patterns();
2994 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002995 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002996 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002997}
2998
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002999static funccal_entry_T *funccal_stack = NULL;
3000
3001/*
3002 * Save the current function call pointer, and set it to NULL.
3003 * Used when executing autocommands and for ":source".
3004 */
3005 void
3006save_funccal(funccal_entry_T *entry)
3007{
3008 entry->top_funccal = current_funccal;
3009 entry->next = funccal_stack;
3010 funccal_stack = entry;
3011 current_funccal = NULL;
3012}
3013
3014 void
3015restore_funccal(void)
3016{
3017 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003018 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003019 else
3020 {
3021 current_funccal = funccal_stack->top_funccal;
3022 funccal_stack = funccal_stack->next;
3023 }
3024}
3025
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003026 funccall_T *
3027get_current_funccal(void)
3028{
3029 return current_funccal;
3030}
3031
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003032/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003033 * Return TRUE when currently at the script level:
3034 * - not in a function
3035 * - not executing an autocommand
3036 * Note that when an autocommand sources a script the result is FALSE;
3037 */
3038 int
3039at_script_level(void)
3040{
3041 return current_funccal == NULL && autocmd_match == NULL;
3042}
3043
3044/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003045 * Mark all functions of script "sid" as deleted.
3046 */
3047 void
3048delete_script_functions(int sid)
3049{
3050 hashitem_T *hi;
3051 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003052 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003053 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003054 size_t len;
3055
3056 buf[0] = K_SPECIAL;
3057 buf[1] = KS_EXTRA;
3058 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003059 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003060 len = STRLEN(buf);
3061
Bram Moolenaarce658352020-07-31 23:47:12 +02003062 while (todo > 0)
3063 {
3064 todo = func_hashtab.ht_used;
3065 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3066 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003067 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003068 fp = HI2UF(hi);
3069 if (STRNCMP(fp->uf_name, buf, len) == 0)
3070 {
3071 int changed = func_hashtab.ht_changed;
3072
3073 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003074
3075 if (fp->uf_calls > 0)
3076 {
3077 // Function is executing, don't free it but do remove
3078 // it from the hashtable.
3079 if (func_remove(fp))
3080 fp->uf_refcount--;
3081 }
3082 else
3083 {
3084 func_clear(fp, TRUE);
3085 // When clearing a function another function can be
3086 // cleared as a side effect. When that happens start
3087 // over.
3088 if (changed != func_hashtab.ht_changed)
3089 break;
3090 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003091 }
3092 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003093 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003094 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003095}
3096
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003097#if defined(EXITFREE) || defined(PROTO)
3098 void
3099free_all_functions(void)
3100{
3101 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003102 ufunc_T *fp;
3103 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003104 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003105 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106
Bram Moolenaare38eab22019-12-05 21:50:01 +01003107 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003108 while (current_funccal != NULL)
3109 {
3110 clear_tv(current_funccal->rettv);
3111 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003112 if (current_funccal == NULL && funccal_stack != NULL)
3113 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003114 }
3115
Bram Moolenaare38eab22019-12-05 21:50:01 +01003116 // First clear what the functions contain. Since this may lower the
3117 // reference count of a function, it may also free a function and change
3118 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003119 while (todo > 0)
3120 {
3121 todo = func_hashtab.ht_used;
3122 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3123 if (!HASHITEM_EMPTY(hi))
3124 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003125 // clear the def function index now
3126 fp = HI2UF(hi);
3127 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003128 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003129
Bram Moolenaare38eab22019-12-05 21:50:01 +01003130 // Only free functions that are not refcounted, those are
3131 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003132 if (func_name_refcount(fp->uf_name))
3133 ++skipped;
3134 else
3135 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003136 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003137 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003138 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003139 {
3140 skipped = 0;
3141 break;
3142 }
3143 }
3144 --todo;
3145 }
3146 }
3147
Bram Moolenaare38eab22019-12-05 21:50:01 +01003148 // Now actually free the functions. Need to start all over every time,
3149 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003150 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003151 while (func_hashtab.ht_used > skipped)
3152 {
3153 todo = func_hashtab.ht_used;
3154 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003155 if (!HASHITEM_EMPTY(hi))
3156 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003157 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003158 // Only free functions that are not refcounted, those are
3159 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003160 fp = HI2UF(hi);
3161 if (func_name_refcount(fp->uf_name))
3162 ++skipped;
3163 else
3164 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003165 if (func_free(fp, FALSE) == OK)
3166 {
3167 skipped = 0;
3168 break;
3169 }
3170 // did not actually free it
3171 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003172 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003173 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003174 }
3175 if (skipped == 0)
3176 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003177
3178 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003179}
3180#endif
3181
3182/*
3183 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003184 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3185 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003186 * "len" is the length of "name", or -1 for NUL terminated.
3187 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003188 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003189builtin_function(char_u *name, int len)
3190{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003191 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003192
Bram Moolenaara26b9702020-04-18 19:53:28 +02003193 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003195 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3196 {
3197 if (name[i] == AUTOLOAD_CHAR)
3198 return FALSE;
3199 if (!eval_isnamec(name[i]))
3200 {
3201 // "name.something" is not a builtin function
3202 if (name[i] == '.')
3203 return FALSE;
3204 break;
3205 }
3206 }
3207 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003208}
3209
3210 int
3211func_call(
3212 char_u *name,
3213 typval_T *args,
3214 partial_T *partial,
3215 dict_T *selfdict,
3216 typval_T *rettv)
3217{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003218 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003219 listitem_T *item;
3220 typval_T argv[MAX_FUNC_ARGS + 1];
3221 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003222 int r = 0;
3223
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003224 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003225 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 {
3227 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3228 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003229 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 break;
3231 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003232 // Make a copy of each argument. This is needed to be able to set
3233 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 copy_tv(&item->li_tv, &argv[argc++]);
3235 }
3236
3237 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003238 {
3239 funcexe_T funcexe;
3240
Bram Moolenaara80faa82020-04-12 19:37:17 +02003241 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003242 funcexe.fe_firstline = curwin->w_cursor.lnum;
3243 funcexe.fe_lastline = curwin->w_cursor.lnum;
3244 funcexe.fe_evaluate = TRUE;
3245 funcexe.fe_partial = partial;
3246 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003247 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3248 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249
Bram Moolenaare38eab22019-12-05 21:50:01 +01003250 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003251 while (argc > 0)
3252 clear_tv(&argv[--argc]);
3253
3254 return r;
3255}
3256
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003257static int callback_depth = 0;
3258
3259 int
3260get_callback_depth(void)
3261{
3262 return callback_depth;
3263}
3264
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003266 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003267 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003268 */
3269 int
3270call_callback(
3271 callback_T *callback,
3272 int len, // length of "name" or -1 to use strlen()
3273 typval_T *rettv, // return value goes here
3274 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003275 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003276 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003277{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003278 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003279 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003280
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003281 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3282 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003283 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003284 funcexe.fe_evaluate = TRUE;
3285 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003286 ++callback_depth;
3287 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3288 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003289
3290 // When a :def function was called that uses :try an error would be turned
3291 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003292 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003293 {
3294 need_rethrow = FALSE;
3295 handle_did_throw();
3296 }
3297
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003298 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003299}
3300
3301/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003302 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003303 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003304 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3305 */
3306 varnumber_T
3307call_callback_retnr(
3308 callback_T *callback,
3309 int argcount, // number of "argvars"
3310 typval_T *argvars) // vars for arguments, must have "argcount"
3311 // PLUS ONE elements!
3312{
3313 typval_T rettv;
3314 varnumber_T retval;
3315
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003316 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003317 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003318
3319 retval = tv_get_number_chk(&rettv, NULL);
3320 clear_tv(&rettv);
3321 return retval;
3322}
3323
3324/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003325 * Give an error message for the result of a function.
3326 * Nothing if "error" is FCERR_NONE.
3327 */
3328 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003329user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003330{
3331 switch (error)
3332 {
3333 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003334 if (funcexe->fe_found_var)
3335 semsg(_(e_not_callable_type_str), name);
3336 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003337 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003338 break;
3339 case FCERR_NOTMETHOD:
3340 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003341 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003342 break;
3343 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003344 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003345 break;
3346 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003347 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003348 break;
3349 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003350 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003351 break;
3352 case FCERR_SCRIPT:
3353 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003354 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003355 break;
3356 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003357 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3358 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003359 break;
3360 }
3361}
3362
3363/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003365 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366 * Return FAIL when the function can't be called, OK otherwise.
3367 * Also returns OK when an error was encountered while executing the function.
3368 */
3369 int
3370call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003371 char_u *funcname, // name of the function
3372 int len, // length of "name" or -1 to use strlen()
3373 typval_T *rettv, // return value goes here
3374 int argcount_in, // number of "argvars"
3375 typval_T *argvars_in, // vars for arguments, must have "argcount"
3376 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003377 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378{
3379 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003380 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003382 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003383 char_u fname_buf[FLEN_FIXED + 1];
3384 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003385 char_u *fname = NULL;
3386 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 int argcount = argcount_in;
3388 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003389 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003390 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003391 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003393 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003394 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003395 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003396 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003398 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3399 // even when call_func() returns FAIL.
3400 rettv->v_type = VAR_UNKNOWN;
3401
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003402 if (partial != NULL)
3403 fp = partial->pt_func;
3404 if (fp == NULL)
3405 {
3406 // Make a copy of the name, if it comes from a funcref variable it
3407 // could be changed or deleted in the called function.
3408 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3409 if (name == NULL)
3410 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003412 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3413 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003415 if (funcexe->fe_doesrange != NULL)
3416 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417
3418 if (partial != NULL)
3419 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003420 // When the function has a partial with a dict and there is a dict
3421 // argument, use the dict argument. That is backwards compatible.
3422 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003423 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003425 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426 {
3427 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003428 {
3429 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3430 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003431 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003432 goto theend;
3433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003435 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 for (i = 0; i < argcount_in; ++i)
3437 argv[i + argv_clear] = argvars_in[i];
3438 argvars = argv;
3439 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003440
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003441 if (funcexe->fe_check_type != NULL
3442 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003443 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003444 // Now funcexe->fe_check_type is missing the added arguments,
3445 // make a copy of the type with the correction.
3446 check_type = *funcexe->fe_check_type;
3447 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003448 check_type.tt_args = check_type_args;
3449 CLEAR_FIELD(check_type_args);
3450 for (i = 0; i < check_type.tt_argcount; ++i)
3451 check_type_args[i + partial->pt_argc] =
3452 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003453 check_type.tt_argcount += partial->pt_argc;
3454 check_type.tt_min_argcount += partial->pt_argc;
3455 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003456 }
3457 }
3458
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003459 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3460 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003461 {
3462 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003463 if (check_argument_types(funcexe->fe_check_type,
3464 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003465 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003466 error = FCERR_OTHER;
3467 }
3468
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003469 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470 {
3471 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003472 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473
Bram Moolenaar333894b2020-08-01 18:53:07 +02003474 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003475 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003476 {
3477 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003479 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480
Bram Moolenaare38eab22019-12-05 21:50:01 +01003481 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003483 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003485 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 {
3487 /*
3488 * User defined function.
3489 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003490 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003491 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003492 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003493 if (fp != NULL && !is_global && in_vim9script()
3494 && func_requires_g_prefix(fp))
3495 // In Vim9 script g: is required to find a global
3496 // non-autoload function.
3497 fp = NULL;
3498 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499
Bram Moolenaare38eab22019-12-05 21:50:01 +01003500 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 if (fp == NULL
3502 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003503 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 && !aborting())
3505 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003506 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003507 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003509 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003510 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3511 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003512 // loaded a package, 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 Moolenaara26b9702020-04-18 19:53:28 +02003515 if (fp == NULL)
3516 {
3517 char_u *p = untrans_function_name(rfname);
3518
3519 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003520 // Don't do this if the name starts with "s:".
3521 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003522 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003523 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003524
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003525 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003526 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003527#ifdef FEAT_LUA
3528 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3529 {
3530 cfunc_T cb = fp->uf_cb;
3531
3532 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3533 }
3534#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003535 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003537 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003538 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003539 argcount = funcexe->fe_argv_func(argcount, argvars,
3540 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003541
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003542 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003543 {
3544 // Method call: base->Method()
3545 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003546 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003547 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003548 argvars = argv;
3549 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003550 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003551
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003552 error = call_user_func_check(fp, argcount, argvars, rettv,
3553 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 }
3555 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003556 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003557 {
3558 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003559 * expr->method(): Find the method name in the table, call its
3560 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003561 */
3562 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003563 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003564 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003565 else
3566 {
3567 /*
3568 * Find the function name in the table, call its implementation.
3569 */
3570 error = call_internal_func(fname, argcount, argvars, rettv);
3571 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003572
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 /*
3574 * The function call (or "FuncUndefined" autocommand sequence) might
3575 * have been aborted by an error, an interrupt, or an explicitly thrown
3576 * exception that has not been caught so far. This situation can be
3577 * tested for by calling aborting(). For an error in an internal
3578 * function or for the "E132" error in call_user_func(), however, the
3579 * throw point at which the "force_abort" flag (temporarily reset by
3580 * emsg()) is normally updated has not been reached yet. We need to
3581 * update that flag first to make aborting() reliable.
3582 */
3583 update_force_abort();
3584 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003585 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 ret = OK;
3587
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003588theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 /*
3590 * Report an error unless the argument evaluation or function call has been
3591 * cancelled due to an aborting error, an interrupt, or an exception.
3592 */
3593 if (!aborting())
3594 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003595 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596 }
3597
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003598 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003600 clear_tv(&argv[--argv_clear + argv_base]);
3601
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 vim_free(tofree);
3603 vim_free(name);
3604
3605 return ret;
3606}
3607
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003608 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003609printable_func_name(ufunc_T *fp)
3610{
3611 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3612}
3613
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003615 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 */
3617 static void
3618list_func_head(ufunc_T *fp, int indent)
3619{
3620 int j;
3621
3622 msg_start();
3623 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003624 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003625 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003626 msg_puts("def ");
3627 else
3628 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003629 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 msg_putchar('(');
3631 for (j = 0; j < fp->uf_args.ga_len; ++j)
3632 {
3633 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003634 msg_puts(", ");
3635 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003636 if (fp->uf_arg_types != NULL)
3637 {
3638 char *tofree;
3639
3640 msg_puts(": ");
3641 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3642 vim_free(tofree);
3643 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003644 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3645 {
3646 msg_puts(" = ");
3647 msg_puts(((char **)(fp->uf_def_args.ga_data))
3648 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3649 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 }
3651 if (fp->uf_varargs)
3652 {
3653 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003654 msg_puts(", ");
3655 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003656 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003657 if (fp->uf_va_name != NULL)
3658 {
3659 if (j)
3660 msg_puts(", ");
3661 msg_puts("...");
3662 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003663 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003664 {
3665 char *tofree;
3666
3667 msg_puts(": ");
3668 msg_puts(type_name(fp->uf_va_type, &tofree));
3669 vim_free(tofree);
3670 }
3671 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003673
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003674 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003675 {
3676 if (fp->uf_ret_type != &t_void)
3677 {
3678 char *tofree;
3679
3680 msg_puts(": ");
3681 msg_puts(type_name(fp->uf_ret_type, &tofree));
3682 vim_free(tofree);
3683 }
3684 }
3685 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003686 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003688 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003690 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003691 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003692 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 msg_clr_eos();
3694 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003695 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696}
3697
3698/*
3699 * Get a function name, translating "<SID>" and "<SNR>".
3700 * Also handles a Funcref in a List or Dictionary.
3701 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003702 * Set "*is_global" to TRUE when the function must be global, unless
3703 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 * flags:
3705 * TFN_INT: internal function name OK
3706 * TFN_QUIET: be quiet
3707 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003708 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 * Advances "pp" to just after the function name (if no error).
3710 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003711 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712trans_function_name(
3713 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003714 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003715 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003716 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003717 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003718 partial_T **partial, // return: partial of a FuncRef
3719 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720{
3721 char_u *name = NULL;
3722 char_u *start;
3723 char_u *end;
3724 int lead;
3725 char_u sid_buf[20];
3726 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003727 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003728 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003730 int vim9script = in_vim9script();
3731 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732
3733 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003734 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 start = *pp;
3736
Bram Moolenaare38eab22019-12-05 21:50:01 +01003737 // Check for hard coded <SNR>: already translated function ID (from a user
3738 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3740 && (*pp)[2] == (int)KE_SNR)
3741 {
3742 *pp += 3;
3743 len = get_id_len(pp) + 3;
3744 return vim_strnsave(start, len);
3745 }
3746
Bram Moolenaare38eab22019-12-05 21:50:01 +01003747 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3748 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749 lead = eval_fname_script(start);
3750 if (lead > 2)
3751 start += lead;
3752
Bram Moolenaare38eab22019-12-05 21:50:01 +01003753 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003754 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003756 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003757 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758 {
3759 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003760 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 goto theend;
3762 }
3763 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3764 {
3765 /*
3766 * Report an invalid expression in braces, unless the expression
3767 * evaluation has been cancelled due to an aborting error, an
3768 * interrupt, or an exception.
3769 */
3770 if (!aborting())
3771 {
3772 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003773 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 }
3775 else
3776 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3777 goto theend;
3778 }
3779
3780 if (lv.ll_tv != NULL)
3781 {
3782 if (fdp != NULL)
3783 {
3784 fdp->fd_dict = lv.ll_dict;
3785 fdp->fd_newkey = lv.ll_newkey;
3786 lv.ll_newkey = NULL;
3787 fdp->fd_di = lv.ll_di;
3788 }
3789 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3790 {
3791 name = vim_strsave(lv.ll_tv->vval.v_string);
3792 *pp = end;
3793 }
3794 else if (lv.ll_tv->v_type == VAR_PARTIAL
3795 && lv.ll_tv->vval.v_partial != NULL)
3796 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003797 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 *pp = end;
3799 if (partial != NULL)
3800 *partial = lv.ll_tv->vval.v_partial;
3801 }
3802 else
3803 {
3804 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3805 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003806 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 else
3808 *pp = end;
3809 name = NULL;
3810 }
3811 goto theend;
3812 }
3813
3814 if (lv.ll_name == NULL)
3815 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003816 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 *pp = end;
3818 goto theend;
3819 }
3820
Bram Moolenaare38eab22019-12-05 21:50:01 +01003821 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 if (lv.ll_exp_name != NULL)
3823 {
3824 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003825 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003826 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 if (name == lv.ll_exp_name)
3828 name = NULL;
3829 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003830 else if (lv.ll_sid > 0)
3831 {
3832 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3833 int cc = *lv.ll_name_end;
3834
3835 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3836 *lv.ll_name_end = NUL;
3837 if (si->sn_autoload_prefix != NULL)
3838 {
3839 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3840 }
3841 else
3842 {
3843 sid_buf[0] = K_SPECIAL;
3844 sid_buf[1] = KS_EXTRA;
3845 sid_buf[2] = (int)KE_SNR;
3846 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003847 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003848 name = concat_str(sid_buf, lv.ll_name);
3849 }
3850 *lv.ll_name_end = cc;
3851 *pp = end;
3852 goto theend;
3853 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003854 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 {
3856 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003857 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003858 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859 if (name == *pp)
3860 name = NULL;
3861 }
3862 if (name != NULL)
3863 {
3864 name = vim_strsave(name);
3865 *pp = end;
3866 if (STRNCMP(name, "<SNR>", 5) == 0)
3867 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003868 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 name[0] = K_SPECIAL;
3870 name[1] = KS_EXTRA;
3871 name[2] = (int)KE_SNR;
3872 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3873 }
3874 goto theend;
3875 }
3876
3877 if (lv.ll_exp_name != NULL)
3878 {
3879 len = (int)STRLEN(lv.ll_exp_name);
3880 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3881 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3882 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003883 // When there was "s:" already or the name expanded to get a
3884 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885 lv.ll_name += 2;
3886 len -= 2;
3887 lead = 2;
3888 }
3889 }
3890 else
3891 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003892 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003893 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003894 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003895 if (lv.ll_name[0] == 'g')
3896 {
3897 if (is_global != NULL)
3898 {
3899 *is_global = TRUE;
3900 }
3901 else
3902 {
3903 // dropping "g:" without setting "is_global" won't work in
3904 // Vim9script, put it back later
3905 prefix_g = TRUE;
3906 extra = 2;
3907 }
3908 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003910 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 len = (int)(end - lv.ll_name);
3912 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003913 if (len <= 0)
3914 {
3915 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003916 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003917 goto theend;
3918 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003920 // In Vim9 script a user function is script-local by default, unless it
3921 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003922 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003923
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924 /*
3925 * Copy the function name to allocated memory.
3926 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3927 * Accept <SNR>123_name() outside a script.
3928 */
3929 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003930 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003931 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003932 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003933 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003934 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003935 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
Bram Moolenaar3787f262022-02-07 21:54:01 +00003936 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003937 semsg(_(vim9script
Bram Moolenaar3787f262022-02-07 21:54:01 +00003938 ? e_function_name_must_start_with_capital_str
3939 : e_function_name_must_start_with_capital_or_s_str),
3940 start);
3941 goto theend;
3942 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003943 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00003944 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00003945 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003946 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947 || eval_fname_sid(*pp))
3948 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003949 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003950 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003951 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003952 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953 goto theend;
3954 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003955 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003956 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003957 extra = 3 + (int)STRLEN(sid_buf);
3958 else
3959 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 }
3961 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003962 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00003963 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003965 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00003966 : e_function_name_must_start_with_capital_or_s_str),
3967 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 goto theend;
3969 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003970 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 {
3972 char_u *cp = vim_strchr(lv.ll_name, ':');
3973
3974 if (cp != NULL && cp < end)
3975 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003976 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977 goto theend;
3978 }
3979 }
3980
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003981 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982 if (name != NULL)
3983 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003984 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 {
3986 name[0] = K_SPECIAL;
3987 name[1] = KS_EXTRA;
3988 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003989 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 STRCPY(name + 3, sid_buf);
3991 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003992 else if (prefix_g)
3993 {
3994 name[0] = 'g';
3995 name[1] = ':';
3996 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003997 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3998 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 }
4000 *pp = end;
4001
4002theend:
4003 clear_lval(&lv);
4004 return name;
4005}
4006
4007/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004008 * Assuming "name" is the result of trans_function_name() and it was prefixed
4009 * to use the script-local name, return the unmodified name (points into
4010 * "name"). Otherwise return NULL.
4011 * This can be used to first search for a script-local function and fall back
4012 * to the global function if not found.
4013 */
4014 char_u *
4015untrans_function_name(char_u *name)
4016{
4017 char_u *p;
4018
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004019 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004020 {
4021 p = vim_strchr(name, '_');
4022 if (p != NULL)
4023 return p + 1;
4024 }
4025 return NULL;
4026}
4027
4028/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004029 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4030 * current script ID and returns the expanded function name. The caller should
4031 * free the returned name. If not called from a script context or the function
4032 * name doesn't start with these prefixes, then returns NULL.
4033 * This doesn't check whether the script-local function exists or not.
4034 */
4035 char_u *
4036get_scriptlocal_funcname(char_u *funcname)
4037{
4038 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004039 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004040 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004041 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004042
4043 if (funcname == NULL)
4044 return NULL;
4045
4046 if (STRNCMP(funcname, "s:", 2) != 0
4047 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004048 {
4049 ufunc_T *ufunc;
4050
4051 // The function name does not have a script-local prefix. Try finding
4052 // it when in a Vim9 script and there is no "g:" prefix.
4053 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4054 return NULL;
4055 ufunc = find_func(funcname, FALSE);
4056 if (ufunc == NULL || func_is_global(ufunc)
4057 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4058 return NULL;
4059 ++p;
4060 off = 0;
4061 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004062 else
4063 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004064
4065 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4066 {
4067 emsg(_(e_using_sid_not_in_script_context));
4068 return NULL;
4069 }
4070 // Expand s: prefix into <SNR>nr_<name>
4071 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4072 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004073 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004074 if (newname == NULL)
4075 return NULL;
4076 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004077 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004078
4079 return newname;
4080}
4081
4082/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004083 * Return script-local "fname" with the 3-byte sequence replaced by
4084 * printable <SNR> in allocated memory.
4085 */
4086 char_u *
4087alloc_printable_func_name(char_u *fname)
4088{
4089 char_u *n = alloc(STRLEN(fname + 3) + 6);
4090
4091 if (n != NULL)
4092 {
4093 STRCPY(n, "<SNR>");
4094 STRCPY(n + 5, fname + 3);
4095 }
4096 return n;
4097}
4098
4099/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004100 * Call trans_function_name(), except that a lambda is returned as-is.
4101 * Returns the name in allocated memory.
4102 */
4103 char_u *
4104save_function_name(
4105 char_u **name,
4106 int *is_global,
4107 int skip,
4108 int flags,
4109 funcdict_T *fudi)
4110{
4111 char_u *p = *name;
4112 char_u *saved;
4113
4114 if (STRNCMP(p, "<lambda>", 8) == 0)
4115 {
4116 p += 8;
4117 (void)getdigits(&p);
4118 saved = vim_strnsave(*name, p - *name);
4119 if (fudi != NULL)
4120 CLEAR_POINTER(fudi);
4121 }
4122 else
4123 saved = trans_function_name(&p, is_global, skip,
4124 flags, fudi, NULL, NULL);
4125 *name = p;
4126 return saved;
4127}
4128
4129/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004130 * List functions. When "regmatch" is NULL all of then.
4131 * Otherwise functions matching "regmatch".
4132 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004133 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004134list_functions(regmatch_T *regmatch)
4135{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004136 int changed = func_hashtab.ht_changed;
4137 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004138 hashitem_T *hi;
4139
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004140 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004141 {
4142 if (!HASHITEM_EMPTY(hi))
4143 {
4144 ufunc_T *fp = HI2UF(hi);
4145
4146 --todo;
4147 if ((fp->uf_flags & FC_DEAD) == 0
4148 && (regmatch == NULL
4149 ? !message_filtered(fp->uf_name)
4150 && !func_name_refcount(fp->uf_name)
4151 : !isdigit(*fp->uf_name)
4152 && vim_regexec(regmatch, fp->uf_name, 0)))
4153 {
4154 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004155 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004156 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004157 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004158 return;
4159 }
4160 }
4161 }
4162 }
4163}
4164
4165/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004166 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004167 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4168 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004169 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004170 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004172 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004173define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004174{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 int j;
4176 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004177 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004178 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004179 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004180 char_u *p;
4181 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004182 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183 char_u *line_arg = NULL;
4184 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004185 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004186 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 garray_T newlines;
4188 int varargs = FALSE;
4189 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004190 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004191 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004192 int fp_allocated = FALSE;
4193 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004194 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 dictitem_T *v;
4196 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004197 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004198 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004200 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004201 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004202 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203
4204 /*
4205 * ":function" without argument: list functions.
4206 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004207 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 {
4209 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004210 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004211 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004212 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004213 }
4214
4215 /*
4216 * ":function /pat": list functions matching pattern.
4217 */
4218 if (*eap->arg == '/')
4219 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004220 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 if (!eap->skip)
4222 {
4223 regmatch_T regmatch;
4224
4225 c = *p;
4226 *p = NUL;
4227 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4228 *p = c;
4229 if (regmatch.regprog != NULL)
4230 {
4231 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004232 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004233 vim_regfree(regmatch.regprog);
4234 }
4235 }
4236 if (*p == '/')
4237 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004238 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004239 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240 }
4241
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004242 ga_init(&newargs);
4243 ga_init(&argtypes);
4244 ga_init(&default_args);
4245
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004246 /*
4247 * Get the function name. There are these situations:
4248 * func normal function name
4249 * "name" == func, "fudi.fd_dict" == NULL
4250 * dict.func new dictionary entry
4251 * "name" == NULL, "fudi.fd_dict" set,
4252 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4253 * dict.func existing dict entry with a Funcref
4254 * "name" == func, "fudi.fd_dict" set,
4255 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4256 * dict.func existing dict entry that's not a Funcref
4257 * "name" == NULL, "fudi.fd_dict" set,
4258 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4259 * s:func script-local function name
4260 * g:func global function name, same as "func"
4261 */
4262 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004263 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004265 // nested function, argument is (args).
4266 paren = TRUE;
4267 CLEAR_FIELD(fudi);
4268 }
4269 else
4270 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004271 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004272 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004273 if (p[0] == 's' && p[1] == ':')
4274 {
4275 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4276 return NULL;
4277 }
4278 p = to_name_end(p, TRUE);
4279 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4280 {
4281 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4282 eap->arg);
4283 return NULL;
4284 }
4285 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004286 }
4287
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004288 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004289 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004290 paren = (vim_strchr(p, '(') != NULL);
4291 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004293 /*
4294 * Return on an invalid expression in braces, unless the expression
4295 * evaluation has been cancelled due to an aborting error, an
4296 * interrupt, or an exception.
4297 */
4298 if (!aborting())
4299 {
4300 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004301 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004302 vim_free(fudi.fd_newkey);
4303 return NULL;
4304 }
4305 else
4306 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004308
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004309 // For "export def FuncName()" in an autoload script the function name
4310 // is stored with the legacy autoload name "dir#script#FuncName" so
4311 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004312 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004313 {
4314 char_u *prefixed = may_prefix_autoload(name);
4315
4316 if (prefixed != NULL && prefixed != name)
4317 {
4318 vim_free(name);
4319 name = prefixed;
4320 }
4321 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004322 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004323 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004324 {
4325 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4326 goto ret_free;
4327 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328 }
4329
Bram Moolenaare38eab22019-12-05 21:50:01 +01004330 // An error in a function call during evaluation of an expression in magic
4331 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332 saved_did_emsg = did_emsg;
4333 did_emsg = FALSE;
4334
4335 /*
4336 * ":function func" with only function name: list function.
4337 */
4338 if (!paren)
4339 {
4340 if (!ends_excmd(*skipwhite(p)))
4341 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004342 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343 goto ret_free;
4344 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004345 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 if (eap->nextcmd != NULL)
4347 *p = NUL;
4348 if (!eap->skip && !got_int)
4349 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004350 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004351 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4352 {
4353 char_u *up = untrans_function_name(name);
4354
4355 // With Vim9 script the name was made script-local, if not
4356 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004357 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004358 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004359 }
4360
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 if (fp != NULL)
4362 {
4363 list_func_head(fp, TRUE);
4364 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4365 {
4366 if (FUNCLINE(fp, j) == NULL)
4367 continue;
4368 msg_putchar('\n');
4369 msg_outnum((long)(j + 1));
4370 if (j < 9)
4371 msg_putchar(' ');
4372 if (j < 99)
4373 msg_putchar(' ');
4374 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004375 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376 ui_breakcheck();
4377 }
4378 if (!got_int)
4379 {
4380 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004381 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004382 msg_puts(" enddef");
4383 else
4384 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004385 }
4386 }
4387 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004388 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389 }
4390 goto ret_free;
4391 }
4392
4393 /*
4394 * ":function name(arg1, arg2)" Define function.
4395 */
4396 p = skipwhite(p);
4397 if (*p != '(')
4398 {
4399 if (!eap->skip)
4400 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004401 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 goto ret_free;
4403 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004404 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 if (vim_strchr(p, '(') != NULL)
4406 p = vim_strchr(p, '(');
4407 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004409 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4410 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004411 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004412 goto ret_free;
4413 }
4414
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004415 // In Vim9 script only global functions can be redefined.
4416 if (vim9script && eap->forceit && !is_global)
4417 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004418 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004419 goto ret_free;
4420 }
4421
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004422 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423
Bram Moolenaar04b12692020-05-04 23:24:44 +02004424 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004426 // Check the name of the function. Unless it's a dictionary function
4427 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428 if (name != NULL)
4429 arg = name;
4430 else
4431 arg = fudi.fd_newkey;
4432 if (arg != NULL && (fudi.fd_di == NULL
4433 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4434 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4435 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004436 char_u *name_base = arg;
4437 int i;
4438
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004440 {
4441 name_base = vim_strchr(arg, '_');
4442 if (name_base == NULL)
4443 name_base = arg + 3;
4444 else
4445 ++name_base;
4446 }
4447 for (i = 0; name_base[i] != NUL && (i == 0
4448 ? eval_isnamec1(name_base[i])
4449 : eval_isnamec(name_base[i])); ++i)
4450 ;
4451 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004452 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004453
4454 // In Vim9 script a function cannot have the same name as a
4455 // variable.
4456 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004457 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4458 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004459 + EVAL_VAR_NO_FUNC) == OK)
4460 {
4461 semsg(_(e_redefining_script_item_str), name_base);
4462 goto ret_free;
4463 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004465 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004467 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004468 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004469 goto ret_free;
4470 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 }
4472
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004473 // This may get more lines and make the pointers into the first line
4474 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004475 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004476 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004477 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004478 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004479 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004480 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004481 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004483 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004484 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004485 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004486 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004488 if (*p != ':')
4489 {
4490 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4491 p = skipwhite(p);
4492 }
4493 else if (!IS_WHITE_OR_NUL(p[1]))
4494 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004495 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004496 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004497 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004498 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004499 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004500 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004501 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004502 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004503 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004504 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004505 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004506 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004507 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004509 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004511 else
4512 // find extra arguments "range", "dict", "abort" and "closure"
4513 for (;;)
4514 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004515 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004516 p = skipwhite(p);
4517 if (STRNCMP(p, "range", 5) == 0)
4518 {
4519 flags |= FC_RANGE;
4520 p += 5;
4521 }
4522 else if (STRNCMP(p, "dict", 4) == 0)
4523 {
4524 flags |= FC_DICT;
4525 p += 4;
4526 }
4527 else if (STRNCMP(p, "abort", 5) == 0)
4528 {
4529 flags |= FC_ABORT;
4530 p += 5;
4531 }
4532 else if (STRNCMP(p, "closure", 7) == 0)
4533 {
4534 flags |= FC_CLOSURE;
4535 p += 7;
4536 if (current_funccal == NULL)
4537 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004538 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004539 name == NULL ? (char_u *)"" : name);
4540 goto erret;
4541 }
4542 }
4543 else
4544 break;
4545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546
Bram Moolenaare38eab22019-12-05 21:50:01 +01004547 // When there is a line break use what follows for the function body.
4548 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 if (*p == '\n')
4550 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004551 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004552 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4553 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004554 && !(VIM_ISWHITE(*whitep) && *p == '#'
4555 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004556 && !eap->skip
4557 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004558 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559
4560 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004561 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4562 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563 */
4564 if (KeyTyped)
4565 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004566 // Check if the function already exists, don't let the user type the
4567 // whole function before telling him it doesn't work! For a script we
4568 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 if (!eap->skip && !eap->forceit)
4570 {
4571 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004572 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004573 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004574 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 }
4576
4577 if (!eap->skip && did_emsg)
4578 goto erret;
4579
Bram Moolenaare38eab22019-12-05 21:50:01 +01004580 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 cmdline_row = msg_row;
4582 }
4583
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004584 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004585 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004586
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004587 // Do not define the function when getting the body fails and when
4588 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004589 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004590 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591 goto erret;
4592
4593 /*
4594 * If there are no errors, add the function
4595 */
4596 if (fudi.fd_dict == NULL)
4597 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004598 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004599 char_u *find_name = name;
4600 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004601 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004602
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004603 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004604 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004605 var_conflict = TRUE;
4606
4607 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4608 {
4609 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4610
4611 if (si->sn_autoload_prefix != NULL)
4612 {
4613 if (is_export)
4614 {
4615 find_name = name + STRLEN(si->sn_autoload_prefix);
4616 v = find_var(find_name, &ht, TRUE);
4617 if (v != NULL)
4618 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004619 // Only check if the function already exists in the script,
4620 // global functions can be shadowed.
4621 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004622 }
4623 else
4624 {
4625 char_u *prefixed = may_prefix_autoload(name);
4626
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004627 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004628 {
4629 v = find_var(prefixed, &ht, TRUE);
4630 if (v != NULL)
4631 var_conflict = TRUE;
4632 vim_free(prefixed);
4633 }
4634 }
4635 }
4636 }
4637 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004638 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004639 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004640 goto erret;
4641 }
4642
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004643 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004644 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004646 char_u *uname = untrans_function_name(name);
4647
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004648 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004649 }
4650
4651 if (fp != NULL || import != NULL)
4652 {
4653 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004654
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004655 // Function can be replaced with "function!" and when sourcing the
4656 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004657 // A name that is used by an import can not be overruled.
4658 if (import != NULL
4659 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004660 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004661 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004663 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004664 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004665 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004666 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004667 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668 goto erret;
4669 }
4670 if (fp->uf_calls > 0)
4671 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004672 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004673 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 goto erret;
4675 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004676 if (fp->uf_refcount > 1)
4677 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004678 // This function is referenced somewhere, don't redefine it but
4679 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004680 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004681 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004682 fp = NULL;
4683 overwrite = TRUE;
4684 }
4685 else
4686 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004687 char_u *exp_name = fp->uf_name_exp;
4688
4689 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004690 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004691 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004692 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004693 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004694 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004695#ifdef FEAT_PROFILE
4696 fp->uf_profiling = FALSE;
4697 fp->uf_prof_initialized = FALSE;
4698#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004699 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004700 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004701 }
4702 }
4703 else
4704 {
4705 char numbuf[20];
4706
4707 fp = NULL;
4708 if (fudi.fd_newkey == NULL && !eap->forceit)
4709 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004710 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 goto erret;
4712 }
4713 if (fudi.fd_di == NULL)
4714 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004715 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004716 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717 goto erret;
4718 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004719 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004720 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004721 goto erret;
4722
Bram Moolenaare38eab22019-12-05 21:50:01 +01004723 // Give the function a sequential number. Can only be used with a
4724 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725 vim_free(name);
4726 sprintf(numbuf, "%d", ++func_nr);
4727 name = vim_strsave((char_u *)numbuf);
4728 if (name == NULL)
4729 goto erret;
4730 }
4731
4732 if (fp == NULL)
4733 {
4734 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4735 {
4736 int slen, plen;
4737 char_u *scriptname;
4738
Bram Moolenaare38eab22019-12-05 21:50:01 +01004739 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004740 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004741 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004742 {
4743 scriptname = autoload_name(name);
4744 if (scriptname != NULL)
4745 {
4746 p = vim_strchr(scriptname, '/');
4747 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004748 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004750 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 j = OK;
4752 vim_free(scriptname);
4753 }
4754 }
4755 if (j == FAIL)
4756 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004757 linenr_T save_lnum = SOURCING_LNUM;
4758
4759 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004760 semsg(_(e_function_name_does_not_match_script_file_name_str),
4761 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004762 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004763 goto erret;
4764 }
4765 }
4766
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004767 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 if (fp == NULL)
4769 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004770 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004771
4772 if (fudi.fd_dict != NULL)
4773 {
4774 if (fudi.fd_di == NULL)
4775 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004776 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4778 if (fudi.fd_di == NULL)
4779 {
4780 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004781 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 goto erret;
4783 }
4784 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4785 {
4786 vim_free(fudi.fd_di);
4787 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004788 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789 goto erret;
4790 }
4791 }
4792 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004793 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004794 clear_tv(&fudi.fd_di->di_tv);
4795 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004796 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004797
Bram Moolenaare38eab22019-12-05 21:50:01 +01004798 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004799 flags |= FC_DICT;
4800 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004801 }
4802 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004803 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004804 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004805 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004806
4807 if (eap->cmdidx == CMD_def)
4808 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004809 int lnum_save = SOURCING_LNUM;
4810 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004811
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004812 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004813
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004814 // error messages are for the first function line
4815 SOURCING_LNUM = sourcing_lnum_top;
4816
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004817 // The function may use script variables from the context.
4818 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004819
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004820 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004821 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004822 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004823 free_fp = fp_allocated;
4824 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004825 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004826 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004827
4828 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004829 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004830 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004831 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004832 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004833 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004834 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004835 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004836 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004837 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004838 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004839
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004840 if (fp_allocated)
4841 {
4842 // insert the new function in the function list
4843 set_ufunc_name(fp, name);
4844 if (overwrite)
4845 {
4846 hi = hash_find(&func_hashtab, name);
4847 hi->hi_key = UF2HIKEY(fp);
4848 }
4849 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4850 {
4851 free_fp = TRUE;
4852 goto erret;
4853 }
4854 fp->uf_refcount = 1;
4855 }
4856
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004858 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004859 if ((flags & FC_CLOSURE) != 0)
4860 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004861 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004862 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004863 }
4864 else
4865 fp->uf_scoped = NULL;
4866
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004867#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004868 if (prof_def_func())
4869 func_do_profile(fp);
4870#endif
4871 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004872 if (sandbox)
4873 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004874 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004875 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004876 fp->uf_flags = flags;
4877 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004878 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004879 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004880 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004881 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004882 if (is_export)
4883 {
4884 fp->uf_flags |= FC_EXPORT;
4885 // let ex_export() know the export worked.
4886 is_export = FALSE;
4887 }
4888
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004889 if (eap->cmdidx == CMD_def)
4890 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004891 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4892 // :func does not use Vim9 script syntax, even in a Vim9 script file
4893 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004894
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895 goto ret_free;
4896
4897erret:
4898 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004899 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004900 if (fp != NULL)
4901 {
4902 ga_init(&fp->uf_args);
4903 ga_init(&fp->uf_def_args);
4904 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905errret_2:
4906 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004907 if (fp != NULL)
4908 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004909 if (free_fp)
4910 {
4911 vim_free(fp);
4912 fp = NULL;
4913 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004915 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004917 if (name != name_arg)
4918 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004919 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004920 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004921
4922 return fp;
4923}
4924
4925/*
4926 * ":function"
4927 */
4928 void
4929ex_function(exarg_T *eap)
4930{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004931 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004932
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004933 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4934 (void)define_function(eap, NULL, &lines_to_free);
4935 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004936}
4937
4938/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004939 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004940 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004941 */
4942 void
4943ex_defcompile(exarg_T *eap UNUSED)
4944{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004945 long todo = (long)func_hashtab.ht_used;
4946 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004947 hashitem_T *hi;
4948 ufunc_T *ufunc;
4949
4950 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4951 {
4952 if (!HASHITEM_EMPTY(hi))
4953 {
4954 --todo;
4955 ufunc = HI2UF(hi);
4956 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004957 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4958 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004959 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004960 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004961
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004962 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004963 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004964 // a function has been added or removed, need to start over
4965 todo = (long)func_hashtab.ht_used;
4966 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004967 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004968 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004969 }
4970 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004971 }
4972 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973}
4974
4975/*
4976 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4977 * Return 2 if "p" starts with "s:".
4978 * Return 0 otherwise.
4979 */
4980 int
4981eval_fname_script(char_u *p)
4982{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004983 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4984 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4986 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4987 return 5;
4988 if (p[0] == 's' && p[1] == ':')
4989 return 2;
4990 return 0;
4991}
4992
4993 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004994translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004995{
4996 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004997 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004998 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004999}
5000
5001/*
5002 * Return TRUE when "ufunc" has old-style "..." varargs
5003 * or named varargs "...name: type".
5004 */
5005 int
5006has_varargs(ufunc_T *ufunc)
5007{
5008 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005009}
5010
5011/*
5012 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005013 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005014 */
5015 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005016function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017{
5018 char_u *nm = name;
5019 char_u *p;
5020 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005021 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005022 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005023
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005024 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5025 if (no_deref)
5026 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005027 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 nm = skipwhite(nm);
5029
Bram Moolenaare38eab22019-12-05 21:50:01 +01005030 // Only accept "funcname", "funcname ", "funcname (..." and
5031 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005033 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005034 vim_free(p);
5035 return n;
5036}
5037
Bram Moolenaar113e1072019-01-20 15:30:40 +01005038#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005039 char_u *
5040get_expanded_name(char_u *name, int check)
5041{
5042 char_u *nm = name;
5043 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005044 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005045
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005046 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005047 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005048
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005049 if (p != NULL && *nm == NUL
5050 && (!check || translated_function_exists(p, is_global)))
5051 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052
5053 vim_free(p);
5054 return NULL;
5055}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005056#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005057
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005058/*
5059 * Function given to ExpandGeneric() to obtain the list of user defined
5060 * function names.
5061 */
5062 char_u *
5063get_user_func_name(expand_T *xp, int idx)
5064{
5065 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005066 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067 static hashitem_T *hi;
5068 ufunc_T *fp;
5069
5070 if (idx == 0)
5071 {
5072 done = 0;
5073 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005074 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005075 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005076 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005077 {
5078 if (done++ > 0)
5079 ++hi;
5080 while (HASHITEM_EMPTY(hi))
5081 ++hi;
5082 fp = HI2UF(hi);
5083
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005084 // don't show dead, dict and lambda functions
5085 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005086 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005087 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005088
5089 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005090 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005091
5092 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005093 if (xp->xp_context != EXPAND_USER_FUNC
5094 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005095 {
5096 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005097 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005098 STRCAT(IObuff, ")");
5099 }
5100 return IObuff;
5101 }
5102 return NULL;
5103}
5104
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005105/*
5106 * ":delfunction {name}"
5107 */
5108 void
5109ex_delfunction(exarg_T *eap)
5110{
5111 ufunc_T *fp = NULL;
5112 char_u *p;
5113 char_u *name;
5114 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005115 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005116
5117 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005118 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5119 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005120 vim_free(fudi.fd_newkey);
5121 if (name == NULL)
5122 {
5123 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005124 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005125 return;
5126 }
5127 if (!ends_excmd(*skipwhite(p)))
5128 {
5129 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005130 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005131 return;
5132 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005133 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005134 if (eap->nextcmd != NULL)
5135 *p = NUL;
5136
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005137 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005138 {
5139 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005140 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005141 vim_free(name);
5142 return;
5143 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005144 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005145 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146 vim_free(name);
5147
5148 if (!eap->skip)
5149 {
5150 if (fp == NULL)
5151 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005152 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005153 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005154 return;
5155 }
5156 if (fp->uf_calls > 0)
5157 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005158 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159 return;
5160 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005161 if (fp->uf_flags & FC_VIM9)
5162 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005163 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005164 return;
5165 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005166
5167 if (fudi.fd_dict != NULL)
5168 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005169 // Delete the dict item that refers to the function, it will
5170 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5172 }
5173 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005174 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005175 // A normal function (not a numbered function or lambda) has a
5176 // refcount of 1 for the entry in the hashtable. When deleting
5177 // it and the refcount is more than one, it should be kept.
5178 // A numbered function and lambda should be kept if the refcount is
5179 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005180 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005181 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005182 // Function is still referenced somewhere. Don't free it but
5183 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005184 if (func_remove(fp))
5185 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005186 }
5187 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005188 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005189 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005190 }
5191}
5192
5193/*
5194 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005195 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005196 */
5197 void
5198func_unref(char_u *name)
5199{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005200 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005202 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005204 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005205 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005206 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005208 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005210 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005211 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005212 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005213}
5214
5215/*
5216 * Unreference a Function: decrement the reference count and free it when it
5217 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005218 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005219 */
5220 void
5221func_ptr_unref(ufunc_T *fp)
5222{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005223 if (fp != NULL && (--fp->uf_refcount <= 0
5224 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5225 && fp->uf_partial->pt_refcount <= 1
5226 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005227 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005228 // Only delete it when it's not being used. Otherwise it's done
5229 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005230 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005231 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005232 }
5233}
5234
5235/*
5236 * Count a reference to a Function.
5237 */
5238 void
5239func_ref(char_u *name)
5240{
5241 ufunc_T *fp;
5242
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005243 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005244 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005245 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005246 if (fp != NULL)
5247 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005248 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005249 // Only give an error for a numbered function.
5250 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005251 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005252}
5253
5254/*
5255 * Count a reference to a Function.
5256 */
5257 void
5258func_ptr_ref(ufunc_T *fp)
5259{
5260 if (fp != NULL)
5261 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005262}
5263
5264/*
5265 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5266 * referenced from anywhere that is in use.
5267 */
5268 static int
5269can_free_funccal(funccall_T *fc, int copyID)
5270{
5271 return (fc->l_varlist.lv_copyID != copyID
5272 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005273 && fc->l_avars.dv_copyID != copyID
5274 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005275}
5276
5277/*
5278 * ":return [expr]"
5279 */
5280 void
5281ex_return(exarg_T *eap)
5282{
5283 char_u *arg = eap->arg;
5284 typval_T rettv;
5285 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005286 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005287
5288 if (current_funccal == NULL)
5289 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005290 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005291 return;
5292 }
5293
Bram Moolenaar844fb642021-10-23 13:32:30 +01005294 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005295 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5296
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 if (eap->skip)
5298 ++emsg_skip;
5299
5300 eap->nextcmd = NULL;
5301 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005302 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005303 {
5304 if (!eap->skip)
5305 returning = do_return(eap, FALSE, TRUE, &rettv);
5306 else
5307 clear_tv(&rettv);
5308 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005309 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005310 else if (!eap->skip)
5311 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005312 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005313 update_force_abort();
5314
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005315 /*
5316 * Return unless the expression evaluation has been cancelled due to an
5317 * aborting error, an interrupt, or an exception.
5318 */
5319 if (!aborting())
5320 returning = do_return(eap, FALSE, TRUE, NULL);
5321 }
5322
Bram Moolenaare38eab22019-12-05 21:50:01 +01005323 // When skipping or the return gets pending, advance to the next command
5324 // in this line (!returning). Otherwise, ignore the rest of the line.
5325 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005326 if (returning)
5327 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005328 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005329 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005330
5331 if (eap->skip)
5332 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005333 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005334}
5335
5336/*
5337 * ":1,25call func(arg1, arg2)" function call.
5338 */
5339 void
5340ex_call(exarg_T *eap)
5341{
5342 char_u *arg = eap->arg;
5343 char_u *startarg;
5344 char_u *name;
5345 char_u *tofree;
5346 int len;
5347 typval_T rettv;
5348 linenr_T lnum;
5349 int doesrange;
5350 int failed = FALSE;
5351 funcdict_T fudi;
5352 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005353 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005354 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005355 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005356 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005357
Bram Moolenaare6b53242020-07-01 17:28:33 +02005358 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359 if (eap->skip)
5360 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005361 // trans_function_name() doesn't work well when skipping, use eval0()
5362 // instead to skip to any following command, e.g. for:
5363 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005364 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005365 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005366 clear_tv(&rettv);
5367 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005368 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005369 return;
5370 }
5371
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005372 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005373 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005374 if (fudi.fd_newkey != NULL)
5375 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005376 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005377 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005378 vim_free(fudi.fd_newkey);
5379 }
5380 if (tofree == NULL)
5381 return;
5382
Bram Moolenaare38eab22019-12-05 21:50:01 +01005383 // Increase refcount on dictionary, it could get deleted when evaluating
5384 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385 if (fudi.fd_dict != NULL)
5386 ++fudi.fd_dict->dv_refcount;
5387
Bram Moolenaare38eab22019-12-05 21:50:01 +01005388 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5389 // contents. For VAR_PARTIAL get its partial, unless we already have one
5390 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005391 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005392 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005393 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005394 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005395
Bram Moolenaare38eab22019-12-05 21:50:01 +01005396 // Skip white space to allow ":call func ()". Not good, but required for
5397 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005398 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399 if (*startarg != '(')
5400 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005401 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005402 goto end;
5403 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005404 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005405 {
5406 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5407 goto end;
5408 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005409
5410 /*
5411 * When skipping, evaluate the function once, to find the end of the
5412 * arguments.
5413 * When the function takes a range, this is discovered after the first
5414 * call, and the loop is broken.
5415 */
5416 if (eap->skip)
5417 {
5418 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005419 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005420 }
5421 else
5422 lnum = eap->line1;
5423 for ( ; lnum <= eap->line2; ++lnum)
5424 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005425 funcexe_T funcexe;
5426
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005427 if (!eap->skip && eap->addr_count > 0)
5428 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005429 if (lnum > curbuf->b_ml.ml_line_count)
5430 {
5431 // If the function deleted lines or switched to another buffer
5432 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005433 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005434 break;
5435 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005436 curwin->w_cursor.lnum = lnum;
5437 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005438 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005439 }
5440 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005441
Bram Moolenaara80faa82020-04-12 19:37:17 +02005442 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005443 funcexe.fe_firstline = eap->line1;
5444 funcexe.fe_lastline = eap->line2;
5445 funcexe.fe_doesrange = &doesrange;
5446 funcexe.fe_evaluate = !eap->skip;
5447 funcexe.fe_partial = partial;
5448 funcexe.fe_selfdict = fudi.fd_dict;
5449 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005450 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005451 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005452 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 {
5454 failed = TRUE;
5455 break;
5456 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005457 if (has_watchexpr())
5458 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005459
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005460 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005461 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005462 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005463 {
5464 failed = TRUE;
5465 break;
5466 }
5467
5468 clear_tv(&rettv);
5469 if (doesrange || eap->skip)
5470 break;
5471
Bram Moolenaare38eab22019-12-05 21:50:01 +01005472 // Stop when immediately aborting on error, or when an interrupt
5473 // occurred or an exception was thrown but not caught.
5474 // get_func_tv() returned OK, so that the check for trailing
5475 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476 if (aborting())
5477 break;
5478 }
5479 if (eap->skip)
5480 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005481 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005482
Bram Moolenaar1d341892021-09-18 15:25:52 +02005483 // When inside :try we need to check for following "| catch" or "| endtry".
5484 // Not when there was an error, but do check if an exception was thrown.
5485 if ((!aborting() || did_throw)
5486 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005487 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005488 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005489 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005490 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005491 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005492 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005493 {
5494 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005495 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005496 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005497 }
5498 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005499 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005500 }
5501
5502end:
5503 dict_unref(fudi.fd_dict);
5504 vim_free(tofree);
5505}
5506
5507/*
5508 * Return from a function. Possibly makes the return pending. Also called
5509 * for a pending return at the ":endtry" or after returning from an extra
5510 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5511 * when called due to a ":return" command. "rettv" may point to a typval_T
5512 * with the return rettv. Returns TRUE when the return can be carried out,
5513 * FALSE when the return gets pending.
5514 */
5515 int
5516do_return(
5517 exarg_T *eap,
5518 int reanimate,
5519 int is_cmd,
5520 void *rettv)
5521{
5522 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005523 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005524
5525 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005526 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005527 current_funccal->returned = FALSE;
5528
5529 /*
5530 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5531 * not in its finally clause (which then is to be executed next) is found.
5532 * In this case, make the ":return" pending for execution at the ":endtry".
5533 * Otherwise, return normally.
5534 */
5535 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5536 if (idx >= 0)
5537 {
5538 cstack->cs_pending[idx] = CSTP_RETURN;
5539
5540 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005541 // A pending return again gets pending. "rettv" points to an
5542 // allocated variable with the rettv of the original ":return"'s
5543 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005544 cstack->cs_rettv[idx] = rettv;
5545 else
5546 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005547 // When undoing a return in order to make it pending, get the stored
5548 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005549 if (reanimate)
5550 rettv = current_funccal->rettv;
5551
5552 if (rettv != NULL)
5553 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005554 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005555 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5556 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5557 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005558 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005559 }
5560 else
5561 cstack->cs_rettv[idx] = NULL;
5562
5563 if (reanimate)
5564 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005565 // The pending return value could be overwritten by a ":return"
5566 // without argument in a finally clause; reset the default
5567 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005568 current_funccal->rettv->v_type = VAR_NUMBER;
5569 current_funccal->rettv->vval.v_number = 0;
5570 }
5571 }
5572 report_make_pending(CSTP_RETURN, rettv);
5573 }
5574 else
5575 {
5576 current_funccal->returned = TRUE;
5577
Bram Moolenaare38eab22019-12-05 21:50:01 +01005578 // If the return is carried out now, store the return value. For
5579 // a return immediately after reanimation, the value is already
5580 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005581 if (!reanimate && rettv != NULL)
5582 {
5583 clear_tv(current_funccal->rettv);
5584 *current_funccal->rettv = *(typval_T *)rettv;
5585 if (!is_cmd)
5586 vim_free(rettv);
5587 }
5588 }
5589
5590 return idx < 0;
5591}
5592
5593/*
5594 * Free the variable with a pending return value.
5595 */
5596 void
5597discard_pending_return(void *rettv)
5598{
5599 free_tv((typval_T *)rettv);
5600}
5601
5602/*
5603 * Generate a return command for producing the value of "rettv". The result
5604 * is an allocated string. Used by report_pending() for verbose messages.
5605 */
5606 char_u *
5607get_return_cmd(void *rettv)
5608{
5609 char_u *s = NULL;
5610 char_u *tofree = NULL;
5611 char_u numbuf[NUMBUFLEN];
5612
5613 if (rettv != NULL)
5614 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5615 if (s == NULL)
5616 s = (char_u *)"";
5617
5618 STRCPY(IObuff, ":return ");
5619 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5620 if (STRLEN(s) + 8 >= IOSIZE)
5621 STRCPY(IObuff + IOSIZE - 4, "...");
5622 vim_free(tofree);
5623 return vim_strsave(IObuff);
5624}
5625
5626/*
5627 * Get next function line.
5628 * Called by do_cmdline() to get the next line.
5629 * Returns allocated string, or NULL for end of function.
5630 */
5631 char_u *
5632get_func_line(
5633 int c UNUSED,
5634 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005635 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005636 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005637{
5638 funccall_T *fcp = (funccall_T *)cookie;
5639 ufunc_T *fp = fcp->func;
5640 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005641 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005642
Bram Moolenaare38eab22019-12-05 21:50:01 +01005643 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005644 if (fcp->dbg_tick != debug_tick)
5645 {
5646 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005647 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005648 fcp->dbg_tick = debug_tick;
5649 }
5650#ifdef FEAT_PROFILE
5651 if (do_profiling == PROF_YES)
5652 func_line_end(cookie);
5653#endif
5654
5655 gap = &fp->uf_lines;
5656 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5657 || fcp->returned)
5658 retval = NULL;
5659 else
5660 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005661 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005662 while (fcp->linenr < gap->ga_len
5663 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5664 ++fcp->linenr;
5665 if (fcp->linenr >= gap->ga_len)
5666 retval = NULL;
5667 else
5668 {
5669 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005670 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005671#ifdef FEAT_PROFILE
5672 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005673 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005674#endif
5675 }
5676 }
5677
Bram Moolenaare38eab22019-12-05 21:50:01 +01005678 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005679 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005680 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005681 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005682 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005683 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005684 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005685 fcp->dbg_tick = debug_tick;
5686 }
5687
5688 return retval;
5689}
5690
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005691/*
5692 * Return TRUE if the currently active function should be ended, because a
5693 * return was encountered or an error occurred. Used inside a ":while".
5694 */
5695 int
5696func_has_ended(void *cookie)
5697{
5698 funccall_T *fcp = (funccall_T *)cookie;
5699
Bram Moolenaare38eab22019-12-05 21:50:01 +01005700 // Ignore the "abort" flag if the abortion behavior has been changed due to
5701 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005702 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5703 || fcp->returned);
5704}
5705
5706/*
5707 * return TRUE if cookie indicates a function which "abort"s on errors.
5708 */
5709 int
5710func_has_abort(
5711 void *cookie)
5712{
5713 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5714}
5715
5716
5717/*
5718 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5719 * Don't do this when "Func" is already a partial that was bound
5720 * explicitly (pt_auto is FALSE).
5721 * Changes "rettv" in-place.
5722 * Returns the updated "selfdict_in".
5723 */
5724 dict_T *
5725make_partial(dict_T *selfdict_in, typval_T *rettv)
5726{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005727 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005728 char_u *tofree = NULL;
5729 ufunc_T *fp;
5730 char_u fname_buf[FLEN_FIXED + 1];
5731 int error;
5732 dict_T *selfdict = selfdict_in;
5733
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005734 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5735 fp = rettv->vval.v_partial->pt_func;
5736 else
5737 {
5738 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5739 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005740 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005741 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005742 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005743 vim_free(tofree);
5744 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005745
5746 if (fp != NULL && (fp->uf_flags & FC_DICT))
5747 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005748 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005749
5750 if (pt != NULL)
5751 {
5752 pt->pt_refcount = 1;
5753 pt->pt_dict = selfdict;
5754 pt->pt_auto = TRUE;
5755 selfdict = NULL;
5756 if (rettv->v_type == VAR_FUNC)
5757 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005758 // Just a function: Take over the function name and use
5759 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005760 pt->pt_name = rettv->vval.v_string;
5761 }
5762 else
5763 {
5764 partial_T *ret_pt = rettv->vval.v_partial;
5765 int i;
5766
Bram Moolenaare38eab22019-12-05 21:50:01 +01005767 // Partial: copy the function name, use selfdict and copy
5768 // args. Can't take over name or args, the partial might
5769 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005770 if (ret_pt->pt_name != NULL)
5771 {
5772 pt->pt_name = vim_strsave(ret_pt->pt_name);
5773 func_ref(pt->pt_name);
5774 }
5775 else
5776 {
5777 pt->pt_func = ret_pt->pt_func;
5778 func_ptr_ref(pt->pt_func);
5779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005780 if (ret_pt->pt_argc > 0)
5781 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005782 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005783 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005784 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005785 pt->pt_argc = 0;
5786 else
5787 {
5788 pt->pt_argc = ret_pt->pt_argc;
5789 for (i = 0; i < pt->pt_argc; i++)
5790 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5791 }
5792 }
5793 partial_unref(ret_pt);
5794 }
5795 rettv->v_type = VAR_PARTIAL;
5796 rettv->vval.v_partial = pt;
5797 }
5798 }
5799 return selfdict;
5800}
5801
5802/*
5803 * Return the name of the executed function.
5804 */
5805 char_u *
5806func_name(void *cookie)
5807{
5808 return ((funccall_T *)cookie)->func->uf_name;
5809}
5810
5811/*
5812 * Return the address holding the next breakpoint line for a funccall cookie.
5813 */
5814 linenr_T *
5815func_breakpoint(void *cookie)
5816{
5817 return &((funccall_T *)cookie)->breakpoint;
5818}
5819
5820/*
5821 * Return the address holding the debug tick for a funccall cookie.
5822 */
5823 int *
5824func_dbg_tick(void *cookie)
5825{
5826 return &((funccall_T *)cookie)->dbg_tick;
5827}
5828
5829/*
5830 * Return the nesting level for a funccall cookie.
5831 */
5832 int
5833func_level(void *cookie)
5834{
5835 return ((funccall_T *)cookie)->level;
5836}
5837
5838/*
5839 * Return TRUE when a function was ended by a ":return" command.
5840 */
5841 int
5842current_func_returned(void)
5843{
5844 return current_funccal->returned;
5845}
5846
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005847 int
5848free_unref_funccal(int copyID, int testing)
5849{
5850 int did_free = FALSE;
5851 int did_free_funccal = FALSE;
5852 funccall_T *fc, **pfc;
5853
5854 for (pfc = &previous_funccal; *pfc != NULL; )
5855 {
5856 if (can_free_funccal(*pfc, copyID))
5857 {
5858 fc = *pfc;
5859 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005860 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005861 did_free = TRUE;
5862 did_free_funccal = TRUE;
5863 }
5864 else
5865 pfc = &(*pfc)->caller;
5866 }
5867 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005868 // When a funccal was freed some more items might be garbage
5869 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005870 (void)garbage_collect(testing);
5871
5872 return did_free;
5873}
5874
5875/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005876 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005877 */
5878 static funccall_T *
5879get_funccal(void)
5880{
5881 int i;
5882 funccall_T *funccal;
5883 funccall_T *temp_funccal;
5884
5885 funccal = current_funccal;
5886 if (debug_backtrace_level > 0)
5887 {
5888 for (i = 0; i < debug_backtrace_level; i++)
5889 {
5890 temp_funccal = funccal->caller;
5891 if (temp_funccal)
5892 funccal = temp_funccal;
5893 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005894 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005895 debug_backtrace_level = i;
5896 }
5897 }
5898 return funccal;
5899}
5900
5901/*
5902 * Return the hashtable used for local variables in the current funccal.
5903 * Return NULL if there is no current funccal.
5904 */
5905 hashtab_T *
5906get_funccal_local_ht()
5907{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005908 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005909 return NULL;
5910 return &get_funccal()->l_vars.dv_hashtab;
5911}
5912
5913/*
5914 * Return the l: scope variable.
5915 * Return NULL if there is no current funccal.
5916 */
5917 dictitem_T *
5918get_funccal_local_var()
5919{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005920 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005921 return NULL;
5922 return &get_funccal()->l_vars_var;
5923}
5924
5925/*
5926 * Return the hashtable used for argument in the current funccal.
5927 * Return NULL if there is no current funccal.
5928 */
5929 hashtab_T *
5930get_funccal_args_ht()
5931{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005932 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005933 return NULL;
5934 return &get_funccal()->l_avars.dv_hashtab;
5935}
5936
5937/*
5938 * Return the a: scope variable.
5939 * Return NULL if there is no current funccal.
5940 */
5941 dictitem_T *
5942get_funccal_args_var()
5943{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005944 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005945 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005946 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005947}
5948
5949/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005950 * List function variables, if there is a function.
5951 */
5952 void
5953list_func_vars(int *first)
5954{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005955 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005956 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005957 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005958}
5959
5960/*
5961 * If "ht" is the hashtable for local variables in the current funccal, return
5962 * the dict that contains it.
5963 * Otherwise return NULL.
5964 */
5965 dict_T *
5966get_current_funccal_dict(hashtab_T *ht)
5967{
5968 if (current_funccal != NULL
5969 && ht == &current_funccal->l_vars.dv_hashtab)
5970 return &current_funccal->l_vars;
5971 return NULL;
5972}
5973
5974/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005975 * Search hashitem in parent scope.
5976 */
5977 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005978find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005979{
5980 funccall_T *old_current_funccal = current_funccal;
5981 hashtab_T *ht;
5982 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005983 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005984
5985 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5986 return NULL;
5987
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005988 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005989 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005990 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005991 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005992 ht = find_var_ht(name, &varname);
5993 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005994 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005995 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005996 if (!HASHITEM_EMPTY(hi))
5997 {
5998 *pht = ht;
5999 break;
6000 }
6001 }
6002 if (current_funccal == current_funccal->func->uf_scoped)
6003 break;
6004 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006005 }
6006 current_funccal = old_current_funccal;
6007
6008 return hi;
6009}
6010
6011/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006012 * Search variable in parent scope.
6013 */
6014 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006015find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006016{
6017 dictitem_T *v = NULL;
6018 funccall_T *old_current_funccal = current_funccal;
6019 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006020 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006021
6022 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6023 return NULL;
6024
Bram Moolenaare38eab22019-12-05 21:50:01 +01006025 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006026 current_funccal = current_funccal->func->uf_scoped;
6027 while (current_funccal)
6028 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006029 ht = find_var_ht(name, &varname);
6030 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006031 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006032 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006033 if (v != NULL)
6034 break;
6035 }
6036 if (current_funccal == current_funccal->func->uf_scoped)
6037 break;
6038 current_funccal = current_funccal->func->uf_scoped;
6039 }
6040 current_funccal = old_current_funccal;
6041
6042 return v;
6043}
6044
6045/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006046 * Set "copyID + 1" in previous_funccal and callers.
6047 */
6048 int
6049set_ref_in_previous_funccal(int copyID)
6050{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006051 funccall_T *fc;
6052
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006053 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006054 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006055 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006056 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6057 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6058 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6059 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006060 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006061 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006062}
6063
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006064 static int
6065set_ref_in_funccal(funccall_T *fc, int copyID)
6066{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006067 if (fc->fc_copyID != copyID)
6068 {
6069 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006070 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6071 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6072 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6073 || set_ref_in_func(NULL, fc->func, copyID))
6074 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006075 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006076 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006077}
6078
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006079/*
6080 * Set "copyID" in all local vars and arguments in the call stack.
6081 */
6082 int
6083set_ref_in_call_stack(int copyID)
6084{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006085 funccall_T *fc;
6086 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006087
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006088 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6089 if (set_ref_in_funccal(fc, copyID))
6090 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006091
6092 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006093 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6094 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6095 if (set_ref_in_funccal(fc, copyID))
6096 return TRUE;
6097 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006098}
6099
6100/*
6101 * Set "copyID" in all functions available by name.
6102 */
6103 int
6104set_ref_in_functions(int copyID)
6105{
6106 int todo;
6107 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006108 ufunc_T *fp;
6109
6110 todo = (int)func_hashtab.ht_used;
6111 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006112 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006113 if (!HASHITEM_EMPTY(hi))
6114 {
6115 --todo;
6116 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006117 if (!func_name_refcount(fp->uf_name)
6118 && set_ref_in_func(NULL, fp, copyID))
6119 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006120 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006121 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006122 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006123}
6124
6125/*
6126 * Set "copyID" in all function arguments.
6127 */
6128 int
6129set_ref_in_func_args(int copyID)
6130{
6131 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006132
6133 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006134 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6135 copyID, NULL, NULL))
6136 return TRUE;
6137 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006138}
6139
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006140/*
6141 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006142 * Returns TRUE if setting references failed somehow.
6143 */
6144 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006145set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006146{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006147 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006148 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006149 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006150 char_u fname_buf[FLEN_FIXED + 1];
6151 char_u *tofree = NULL;
6152 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006153 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006154
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006155 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006156 return FALSE;
6157
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006158 if (fp_in == NULL)
6159 {
6160 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006161 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006162 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006163 if (fp != NULL)
6164 {
6165 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006166 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006167 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006168
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006169 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006170 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006171}
6172
Bram Moolenaare38eab22019-12-05 21:50:01 +01006173#endif // FEAT_EVAL