blob: 59415dbd731ebda2cc1cf2b0fd8a61693c56c510 [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 Moolenaar65c44152020-12-24 15:14:01 +01001331
1332 if (equal_arrow && !in_vim9script())
1333 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001334
1335 ga_init(&newargs);
1336 ga_init(&newlines);
1337
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001338 // First, check if this is really a lambda expression. "->" or "=>" must
1339 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001340 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001341 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001342 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001343 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001344 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001345 {
1346 if (types_optional)
1347 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001348 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001349 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001350
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001351 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001352 if (evaluate)
1353 pnewargs = &newargs;
1354 else
1355 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001356 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001357 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001358 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001359 &varargs, &default_args,
1360 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001361 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001362 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001363 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001364 {
1365 if (types_optional)
1366 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001367 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001368 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001369 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001370 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001371
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001372 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1373 if (ret_type != NULL)
1374 {
1375 ret_type = vim_strsave(ret_type);
1376 tofree2 = ret_type;
1377 }
1378
Bram Moolenaare38eab22019-12-05 21:50:01 +01001379 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001380 if (evaluate)
1381 eval_lavars_used = &eval_lavars;
1382
Bram Moolenaar65c44152020-12-24 15:14:01 +01001383 *arg = skipwhite_and_linebreak(*arg, evalarg);
1384
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001385 // Recognize "{" as the start of a function body.
1386 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001387 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001388 if (evalarg == NULL)
1389 // cannot happen?
1390 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001391 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1392 types_optional ? &argtypes : NULL, varargs,
1393 &default_args, ret_type) == FAIL)
1394 goto errret;
1395 goto theend;
1396 }
1397 if (default_args.ga_len > 0)
1398 {
1399 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001400 goto errret;
1401 }
1402
Bram Moolenaare38eab22019-12-05 21:50:01 +01001403 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001404 start = *arg;
1405 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001406 if (ret == FAIL)
1407 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001408 if (evalarg != NULL)
1409 {
1410 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001411 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001412 evalarg->eval_tofree = NULL;
1413 }
1414
Bram Moolenaar65c44152020-12-24 15:14:01 +01001415 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001416 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001417 *arg = skipwhite_and_linebreak(*arg, evalarg);
1418 if (**arg != '}')
1419 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001420 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001421 goto errret;
1422 }
1423 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001424 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001425
1426 if (evaluate)
1427 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001428 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001429 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001430 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001431 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001432 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001433
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001434 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435 if (fp == NULL)
1436 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001437 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001438 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001439 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001440 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001441
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001442 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001443 if (ga_grow(&newlines, 1) == FAIL)
1444 goto errret;
1445
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001446 // If there are line breaks, we need to split up the string.
1447 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001448 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001449 line_end = end;
1450
1451 // Add "return " before the expression (or the first line).
1452 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001453 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454 if (p == NULL)
1455 goto errret;
1456 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1457 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001458 vim_strncpy(p + 7, start, line_end - start);
1459
1460 if (line_end != end)
1461 {
1462 // Add more lines, split by line breaks. Thus is used when a
1463 // lambda with { cmds } is encountered.
1464 while (*line_end == '\n')
1465 {
1466 if (ga_grow(&newlines, 1) == FAIL)
1467 goto errret;
1468 start = line_end + 1;
1469 line_end = vim_strchr(start, '\n');
1470 if (line_end == NULL)
1471 line_end = end;
1472 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1473 vim_strnsave(start, line_end - start);
1474 }
1475 }
1476
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001477 if (strstr((char *)p + 7, "a:") == NULL)
1478 // No a: variables are used for sure.
1479 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480
1481 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001482 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001484 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001485 if (types_optional)
1486 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001487 if (parse_argument_types(fp, &argtypes,
1488 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001489 goto errret;
1490 if (ret_type != NULL)
1491 {
1492 fp->uf_ret_type = parse_type(&ret_type,
1493 &fp->uf_type_list, TRUE);
1494 if (fp->uf_ret_type == NULL)
1495 goto errret;
1496 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001497 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001498 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001499 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001500
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001501 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001502 if (current_funccal != NULL && eval_lavars)
1503 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001504 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001505 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001506 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001507 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508
1509#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001510 if (prof_def_func())
1511 func_do_profile(fp);
1512#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001513 if (sandbox)
1514 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001515 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001516 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1517 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001518 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001520 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001521 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001523 function_using_block_scopes(fp, evalarg->eval_cstack);
1524
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001525 pt->pt_func = fp;
1526 pt->pt_refcount = 1;
1527 rettv->vval.v_partial = pt;
1528 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001529
1530 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001533theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001534 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001535 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001536 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001537 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001538 vim_free(tofree1);
1539 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001540 if (types_optional)
1541 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001542
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543 return OK;
1544
1545errret:
1546 ga_clear_strings(&newargs);
1547 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001548 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001549 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001550 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001551 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001552 if (fp != NULL)
1553 vim_free(fp->uf_arg_types);
1554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001556 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001557 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001558 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001559 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001560 vim_free(tofree1);
1561 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001562 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563 return FAIL;
1564}
1565
1566/*
1567 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1568 * name it contains, otherwise return "name".
1569 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1570 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001571 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1572 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001573 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001574 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575 */
1576 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001577deref_func_name(
1578 char_u *name,
1579 int *lenp,
1580 partial_T **partialp,
1581 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001582 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001583 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001584 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001585{
1586 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001587 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001588 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001589 char_u *s = NULL;
1590 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001591 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001592
1593 if (partialp != NULL)
1594 *partialp = NULL;
1595
1596 cc = name[*lenp];
1597 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001598
Bram Moolenaar71f21932022-01-07 18:20:55 +00001599 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001601 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001602 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001603 tv = &v->di_tv;
1604 }
1605 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1606 {
1607 imported_T *import;
1608 char_u *p = name;
1609 int len = *lenp;
1610
1611 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001613 p = name + 2;
1614 len -= 2;
1615 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001616 import = find_imported(p, len, FALSE, NULL);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001617
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001618 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001619 if (import != NULL)
1620 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001621 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001622 if (new_function)
1623 semsg(_(e_redefining_imported_item_str), name);
1624 else
1625 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001626 name[len] = cc;
1627 *lenp = 0;
1628 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001629 }
1630 }
1631
1632 if (tv != NULL)
1633 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001634 if (found_var != NULL)
1635 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001636 if (tv->v_type == VAR_FUNC)
1637 {
1638 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001639 {
1640 *lenp = 0;
1641 return (char_u *)""; // just in case
1642 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001643 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001644 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001646
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001647 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001648 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001649 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001650
1651 if (pt == NULL)
1652 {
1653 *lenp = 0;
1654 return (char_u *)""; // just in case
1655 }
1656 if (partialp != NULL)
1657 *partialp = pt;
1658 s = partial_name(pt);
1659 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001661
1662 if (s != NULL)
1663 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001664 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001665 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001666 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001667
1668 if (sv != NULL)
1669 *type = sv->sv_type;
1670 }
1671 return s;
1672 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001673 }
1674
1675 return name;
1676}
1677
1678/*
1679 * Give an error message with a function name. Handle <SNR> things.
1680 * "ermsg" is to be passed without translation, use N_() instead of _().
1681 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001682 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683emsg_funcname(char *ermsg, char_u *name)
1684{
Bram Moolenaar54598062022-01-13 12:05:09 +00001685 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001686
Bram Moolenaar54598062022-01-13 12:05:09 +00001687 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001689 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001690 if (p != name)
1691 vim_free(p);
1692}
1693
1694/*
1695 * Allocate a variable for the result of a function.
1696 * Return OK or FAIL.
1697 */
1698 int
1699get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001700 char_u *name, // name of the function
1701 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001702 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001703 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001704 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001705 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001706{
1707 char_u *argp;
1708 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001709 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1710 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001711 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001712 int evaluate = evalarg == NULL
1713 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714
1715 /*
1716 * Get the arguments.
1717 */
1718 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001719 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1720 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001722 // skip the '(' or ',' and possibly line breaks
1723 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1724
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 if (*argp == ')' || *argp == ',' || *argp == NUL)
1726 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001727 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001728 {
1729 ret = FAIL;
1730 break;
1731 }
1732 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001733 // The comma should come right after the argument, but this wasn't
1734 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001735 if (vim9script)
1736 {
1737 if (*argp != ',' && *skipwhite(argp) == ',')
1738 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001739 if (evaluate)
1740 semsg(_(e_no_white_space_allowed_before_str_str),
1741 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001742 ret = FAIL;
1743 break;
1744 }
1745 }
1746 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001747 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001748 if (*argp != ',')
1749 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001750 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1751 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001752 if (evaluate)
1753 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001754 ret = FAIL;
1755 break;
1756 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001757 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001758 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759 if (*argp == ')')
1760 ++argp;
1761 else
1762 ret = FAIL;
1763
1764 if (ret == OK)
1765 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001766 int i = 0;
1767 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001768
1769 if (get_vim_var_nr(VV_TESTING))
1770 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001771 // Prepare for calling test_garbagecollect_now(), need to know
1772 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001774 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001775 for (i = 0; i < argcount; ++i)
1776 if (ga_grow(&funcargs, 1) == OK)
1777 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1778 &argvars[i];
1779 }
1780
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001781 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001782 if (in_vim9script() && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001783 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001784 // An error in a builtin function does not return FAIL, but we do
1785 // want to abort further processing if an error was given.
1786 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001787 clear_tv(rettv);
1788 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789
1790 funcargs.ga_len -= i;
1791 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001792 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 {
1794 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001795 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001797 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001798 }
1799
1800 while (--argcount >= 0)
1801 clear_tv(&argvars[argcount]);
1802
Bram Moolenaar8294d492020-08-10 22:40:56 +02001803 if (in_vim9script())
1804 *arg = argp;
1805 else
1806 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807 return ret;
1808}
1809
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001810/*
1811 * Return TRUE if "p" starts with "<SID>" or "s:".
1812 * Only works if eval_fname_script() returned non-zero for "p"!
1813 */
1814 static int
1815eval_fname_sid(char_u *p)
1816{
1817 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1818}
1819
1820/*
1821 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1822 * Change <SNR>123_name() to K_SNR 123_name().
1823 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1824 * (slow).
1825 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001826 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1828{
1829 int llen;
1830 char_u *fname;
1831 int i;
1832
1833 llen = eval_fname_script(name);
1834 if (llen > 0)
1835 {
1836 fname_buf[0] = K_SPECIAL;
1837 fname_buf[1] = KS_EXTRA;
1838 fname_buf[2] = (int)KE_SNR;
1839 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001840 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001842 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001843 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001844 else
1845 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001846 sprintf((char *)fname_buf + 3, "%ld_",
1847 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848 i = (int)STRLEN(fname_buf);
1849 }
1850 }
1851 if (i + STRLEN(name + llen) < FLEN_FIXED)
1852 {
1853 STRCPY(fname_buf + i, name + llen);
1854 fname = fname_buf;
1855 }
1856 else
1857 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001858 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001859 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001860 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001861 else
1862 {
1863 *tofree = fname;
1864 mch_memmove(fname, fname_buf, (size_t)i);
1865 STRCPY(fname + i, name + llen);
1866 }
1867 }
1868 }
1869 else
1870 fname = name;
1871 return fname;
1872}
1873
1874/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001875 * Find a function "name" in script "sid".
1876 */
1877 static ufunc_T *
1878find_func_with_sid(char_u *name, int sid)
1879{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001880 hashitem_T *hi;
1881 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001882
Bram Moolenaarb8822442022-01-11 15:24:05 +00001883 if (!SCRIPT_ID_VALID(sid))
1884 return NULL; // not in a script
1885
1886 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001887 buffer[0] = K_SPECIAL;
1888 buffer[1] = KS_EXTRA;
1889 buffer[2] = (int)KE_SNR;
1890 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1891 (long)sid, name);
1892 hi = hash_find(&func_hashtab, buffer);
1893 if (!HASHITEM_EMPTY(hi))
1894 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001895 return NULL;
1896}
1897
1898/*
1899 * Find a function "name" in script "sid" prefixing the autoload prefix.
1900 */
1901 static ufunc_T *
1902find_func_with_prefix(char_u *name, int sid)
1903{
1904 hashitem_T *hi;
1905 char_u buffer[200];
1906 scriptitem_T *si;
1907
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001908 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001909 return NULL; // already has the prefix
1910 if (!SCRIPT_ID_VALID(sid))
1911 return NULL; // not in a script
1912 si = SCRIPT_ITEM(sid);
1913 if (si->sn_autoload_prefix != NULL)
1914 {
1915 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1916 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001917 char_u *namep;
1918
1919 // skip a "<SNR>99_" prefix
1920 namep = untrans_function_name(name);
1921 if (namep == NULL)
1922 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001923
1924 // An exported function in an autoload script is stored as
1925 // "dir#path#name".
1926 if (len < sizeof(buffer))
1927 auto_name = buffer;
1928 else
1929 auto_name = alloc(len);
1930 if (auto_name != NULL)
1931 {
1932 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001933 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001934 hi = hash_find(&func_hashtab, auto_name);
1935 if (auto_name != buffer)
1936 vim_free(auto_name);
1937 if (!HASHITEM_EMPTY(hi))
1938 return HI2UF(hi);
1939 }
1940 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001941
1942 return NULL;
1943}
1944
1945/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001946 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001947 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1948 * functions.
1949 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001950 * Return NULL for unknown function.
1951 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001952 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001953find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001954{
1955 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001956 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001958 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001959 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001960 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1961 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001962
Bram Moolenaar95006e32020-08-29 17:47:08 +02001963 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001964 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001965 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001966 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1967 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001968 if (func != NULL)
1969 return func;
1970 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001971 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001972
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001973 if ((flags & FFED_NO_GLOBAL) == 0)
1974 {
1975 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02001976 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001977 if (!HASHITEM_EMPTY(hi))
1978 return HI2UF(hi);
1979 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001980
Bram Moolenaarb8822442022-01-11 15:24:05 +00001981 // Find autoload function if this is an autoload script.
1982 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1983 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001984}
1985
1986/*
1987 * Find a function by name, return pointer to it in ufuncs.
1988 * "cctx" is passed in a :def function to find imported functions.
1989 * Return NULL for unknown or dead function.
1990 */
1991 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001992find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001993{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001994 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001995
1996 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1997 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001998 return NULL;
1999}
2000
2001/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002002 * Return TRUE if "ufunc" is a global function.
2003 */
2004 int
2005func_is_global(ufunc_T *ufunc)
2006{
2007 return ufunc->uf_name[0] != K_SPECIAL;
2008}
2009
2010/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002011 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2012 */
2013 int
2014func_requires_g_prefix(ufunc_T *ufunc)
2015{
2016 return ufunc->uf_name[0] != K_SPECIAL
2017 && (ufunc->uf_flags & FC_LAMBDA) == 0
2018 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2019}
2020
2021/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002022 * Copy the function name of "fp" to buffer "buf".
2023 * "buf" must be able to hold the function name plus three bytes.
2024 * Takes care of script-local function names.
2025 */
2026 static void
2027cat_func_name(char_u *buf, ufunc_T *fp)
2028{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002029 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002030 {
2031 STRCPY(buf, "<SNR>");
2032 STRCAT(buf, fp->uf_name + 3);
2033 }
2034 else
2035 STRCPY(buf, fp->uf_name);
2036}
2037
2038/*
2039 * Add a number variable "name" to dict "dp" with value "nr".
2040 */
2041 static void
2042add_nr_var(
2043 dict_T *dp,
2044 dictitem_T *v,
2045 char *name,
2046 varnumber_T nr)
2047{
2048 STRCPY(v->di_key, name);
2049 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2050 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2051 v->di_tv.v_type = VAR_NUMBER;
2052 v->di_tv.v_lock = VAR_FIXED;
2053 v->di_tv.vval.v_number = nr;
2054}
2055
2056/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002057 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002058 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002059 static void
2060free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002061{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002062 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002063
2064 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2065 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002066 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002067
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002068 // When garbage collecting a funccall_T may be freed before the
2069 // function that references it, clear its uf_scoped field.
2070 // The function may have been redefined and point to another
2071 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002072 if (fp != NULL && fp->uf_scoped == fc)
2073 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002074 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002075 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002076
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002077 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 vim_free(fc);
2079}
2080
2081/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002082 * Free "fc" and what it contains.
2083 * Can be called only when "fc" is kept beyond the period of it called,
2084 * i.e. after cleanup_function_call(fc).
2085 */
2086 static void
2087free_funccal_contents(funccall_T *fc)
2088{
2089 listitem_T *li;
2090
2091 // Free all l: variables.
2092 vars_clear(&fc->l_vars.dv_hashtab);
2093
2094 // Free all a: variables.
2095 vars_clear(&fc->l_avars.dv_hashtab);
2096
2097 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002098 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002099 clear_tv(&li->li_tv);
2100
2101 free_funccal(fc);
2102}
2103
2104/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002105 * Handle the last part of returning from a function: free the local hashtable.
2106 * Unless it is still in use by a closure.
2107 */
2108 static void
2109cleanup_function_call(funccall_T *fc)
2110{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002111 int may_free_fc = fc->fc_refcount <= 0;
2112 int free_fc = TRUE;
2113
Bram Moolenaar6914c642017-04-01 21:21:30 +02002114 current_funccal = fc->caller;
2115
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002116 // Free all l: variables if not referred.
2117 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2118 vars_clear(&fc->l_vars.dv_hashtab);
2119 else
2120 free_fc = FALSE;
2121
2122 // If the a:000 list and the l: and a: dicts are not referenced and
2123 // there is no closure using it, we can free the funccall_T and what's
2124 // in it.
2125 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2126 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002127 else
2128 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002129 int todo;
2130 hashitem_T *hi;
2131 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002132
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002133 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002134
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002135 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002136 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2137 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2138 {
2139 if (!HASHITEM_EMPTY(hi))
2140 {
2141 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 di = HI2DI(hi);
2143 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002144 }
2145 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002146 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002147
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002148 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2149 fc->l_varlist.lv_first = NULL;
2150 else
2151 {
2152 listitem_T *li;
2153
2154 free_fc = FALSE;
2155
2156 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002157 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002158 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002159 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002160
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002161 if (free_fc)
2162 free_funccal(fc);
2163 else
2164 {
2165 static int made_copy = 0;
2166
2167 // "fc" is still in use. This can happen when returning "a:000",
2168 // assigning "l:" to a global variable or defining a closure.
2169 // Link "fc" in the list for garbage collection later.
2170 fc->caller = previous_funccal;
2171 previous_funccal = fc;
2172
2173 if (want_garbage_collect)
2174 // If garbage collector is ready, clear count.
2175 made_copy = 0;
2176 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002177 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002178 // We have made a lot of copies, worth 4 Mbyte. This can happen
2179 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002180 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002181 // too much memory.
2182 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002183 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002184 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002185 }
2186}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002187
2188/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002189 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2190 */
2191 static int
2192numbered_function(char_u *name)
2193{
2194 return isdigit(*name)
2195 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2196}
2197
2198/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002199 * There are two kinds of function names:
2200 * 1. ordinary names, function defined with :function or :def
2201 * 2. numbered functions and lambdas
2202 * For the first we only count the name stored in func_hashtab as a reference,
2203 * using function() does not count as a reference, because the function is
2204 * looked up by name.
2205 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002206 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002207func_name_refcount(char_u *name)
2208{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002209 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002210}
2211
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002212/*
2213 * Unreference "fc": decrement the reference count and free it when it
2214 * becomes zero. "fp" is detached from "fc".
2215 * When "force" is TRUE we are exiting.
2216 */
2217 static void
2218funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2219{
2220 funccall_T **pfc;
2221 int i;
2222
2223 if (fc == NULL)
2224 return;
2225
2226 if (--fc->fc_refcount <= 0 && (force || (
2227 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2228 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2229 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2230 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2231 {
2232 if (fc == *pfc)
2233 {
2234 *pfc = fc->caller;
2235 free_funccal_contents(fc);
2236 return;
2237 }
2238 }
2239 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2240 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2241 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2242}
2243
2244/*
2245 * Remove the function from the function hashtable. If the function was
2246 * deleted while it still has references this was already done.
2247 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2248 */
2249 static int
2250func_remove(ufunc_T *fp)
2251{
2252 hashitem_T *hi;
2253
2254 // Return if it was already virtually deleted.
2255 if (fp->uf_flags & FC_DEAD)
2256 return FALSE;
2257
2258 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2259 if (!HASHITEM_EMPTY(hi))
2260 {
2261 // When there is a def-function index do not actually remove the
2262 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002263 // Do remove it when it's a copy.
2264 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002265 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002266 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002267 return FALSE;
2268 }
2269 hash_remove(&func_hashtab, hi);
2270 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002271 return TRUE;
2272 }
2273 return FALSE;
2274}
2275
2276 static void
2277func_clear_items(ufunc_T *fp)
2278{
2279 ga_clear_strings(&(fp->uf_args));
2280 ga_clear_strings(&(fp->uf_def_args));
2281 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002282 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002283 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002284 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002285 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002286
2287 // Increment the refcount of this function to avoid it being freed
2288 // recursively when the partial is freed.
2289 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002290 partial_unref(fp->uf_partial);
2291 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002292 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002293
2294#ifdef FEAT_LUA
2295 if (fp->uf_cb_free != NULL)
2296 {
2297 fp->uf_cb_free(fp->uf_cb_state);
2298 fp->uf_cb_free = NULL;
2299 }
2300
2301 fp->uf_cb_state = NULL;
2302 fp->uf_cb = NULL;
2303#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002304#ifdef FEAT_PROFILE
2305 VIM_CLEAR(fp->uf_tml_count);
2306 VIM_CLEAR(fp->uf_tml_total);
2307 VIM_CLEAR(fp->uf_tml_self);
2308#endif
2309}
2310
2311/*
2312 * Free all things that a function contains. Does not free the function
2313 * itself, use func_free() for that.
2314 * When "force" is TRUE we are exiting.
2315 */
2316 static void
2317func_clear(ufunc_T *fp, int force)
2318{
2319 if (fp->uf_cleared)
2320 return;
2321 fp->uf_cleared = TRUE;
2322
2323 // clear this function
2324 func_clear_items(fp);
2325 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002326 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002327}
2328
2329/*
2330 * Free a function and remove it from the list of functions. Does not free
2331 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002332 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002333 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002334 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002335 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002336func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002337{
2338 // Only remove it when not done already, otherwise we would remove a newer
2339 // version of the function with the same name.
2340 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2341 func_remove(fp);
2342
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002343 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002344 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002345 if (fp->uf_dfunc_idx > 0)
2346 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002347 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002348 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002349 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002350 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002351 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002352}
2353
2354/*
2355 * Free all things that a function contains and free the function itself.
2356 * When "force" is TRUE we are exiting.
2357 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002358 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002359func_clear_free(ufunc_T *fp, int force)
2360{
2361 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002362 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2363 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002364 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002365 else
2366 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002367}
2368
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002369/*
2370 * Copy already defined function "lambda" to a new function with name "global".
2371 * This is for when a compiled function defines a global function.
2372 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002373 int
2374copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002375{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002376 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002377 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002378
2379 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002380 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002381 semsg(_(e_lambda_function_not_found_str), lambda);
2382 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002383 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002384
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002385 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002386 if (fp != NULL)
2387 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002388 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002389 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002390 return FAIL;
2391 }
2392
2393 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2394 if (fp == NULL)
2395 return FAIL;
2396
2397 fp->uf_varargs = ufunc->uf_varargs;
2398 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2399 fp->uf_def_status = ufunc->uf_def_status;
2400 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2401 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2402 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2403 == FAIL
2404 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2405 goto failed;
2406
2407 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2408 : vim_strsave(ufunc->uf_name_exp);
2409 if (ufunc->uf_arg_types != NULL)
2410 {
2411 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2412 if (fp->uf_arg_types == NULL)
2413 goto failed;
2414 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2415 sizeof(type_T *) * fp->uf_args.ga_len);
2416 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002417 if (ufunc->uf_va_name != NULL)
2418 {
2419 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2420 if (fp->uf_va_name == NULL)
2421 goto failed;
2422 }
2423 fp->uf_ret_type = ufunc->uf_ret_type;
2424
2425 fp->uf_refcount = 1;
2426 STRCPY(fp->uf_name, global);
2427 hash_add(&func_hashtab, UF2HIKEY(fp));
2428
2429 // the referenced dfunc_T is now used one more time
2430 link_def_function(fp);
2431
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002432 // Create a partial to store the context of the function where it was
2433 // instantiated. Only needs to be done once. Do this on the original
2434 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002435 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2436 {
2437 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2438
2439 if (pt == NULL)
2440 goto failed;
2441 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002442 {
2443 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002444 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002445 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002446 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002447 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002448 }
2449
2450 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002451
2452failed:
2453 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002454 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002455}
2456
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002457static int funcdepth = 0;
2458
2459/*
2460 * Increment the function call depth count.
2461 * Return FAIL when going over 'maxfuncdepth'.
2462 * Otherwise return OK, must call funcdepth_decrement() later!
2463 */
2464 int
2465funcdepth_increment(void)
2466{
2467 if (funcdepth >= p_mfd)
2468 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002469 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002470 return FAIL;
2471 }
2472 ++funcdepth;
2473 return OK;
2474}
2475
2476 void
2477funcdepth_decrement(void)
2478{
2479 --funcdepth;
2480}
2481
2482/*
2483 * Get the current function call depth.
2484 */
2485 int
2486funcdepth_get(void)
2487{
2488 return funcdepth;
2489}
2490
2491/*
2492 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002493 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002494 * times as funcdepth_increment().
2495 */
2496 void
2497funcdepth_restore(int depth)
2498{
2499 funcdepth = depth;
2500}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002501
2502/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503 * Call a user function.
2504 */
2505 static void
2506call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002507 ufunc_T *fp, // pointer to function
2508 int argcount, // nr of args
2509 typval_T *argvars, // arguments
2510 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002511 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002512 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002514 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002515 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 funccall_T *fc;
2517 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002518 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002519 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002520 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521 int i;
2522 int ai;
2523 int islambda = FALSE;
2524 char_u numbuf[NUMBUFLEN];
2525 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002526 typval_T *tv_to_free[MAX_FUNC_ARGS];
2527 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002529 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002531 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532
Bram Moolenaarb2049902021-01-24 12:53:53 +01002533#ifdef FEAT_PROFILE
2534 CLEAR_FIELD(profile_info);
2535#endif
2536
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002537 // If depth of calling is getting too high, don't execute the function.
2538 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002539 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540 rettv->v_type = VAR_NUMBER;
2541 rettv->vval.v_number = -1;
2542 return;
2543 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544
Bram Moolenaare38eab22019-12-05 21:50:01 +01002545 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002546
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002547 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002548 if (fc == NULL)
2549 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002550 fc->caller = current_funccal;
2551 current_funccal = fc;
2552 fc->func = fp;
2553 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002554 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002555 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2557 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002558 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002559 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002560 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002562 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002563 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002564#ifdef FEAT_PROFILE
2565 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2566#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002567 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002568#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002569 if (do_profiling == PROF_YES)
2570 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002571#endif
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002572 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002573 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002574#ifdef FEAT_PROFILE
2575 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002576 || (caller != NULL && caller->uf_profiling)))
2577 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002578#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002579 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002580 free_funccal(fc);
2581 return;
2582 }
2583
Bram Moolenaar38453522021-11-28 22:00:12 +00002584 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585
2586 /*
2587 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2588 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2589 * each argument variable and saves a lot of time.
2590 */
2591 /*
2592 * Init l: variables.
2593 */
2594 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2595 if (selfdict != NULL)
2596 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002597 // Set l:self to "selfdict". Use "name" to avoid a warning from
2598 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002599 v = &fc->fixvar[fixvar_idx++].var;
2600 name = v->di_key;
2601 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002602 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2604 v->di_tv.v_type = VAR_DICT;
2605 v->di_tv.v_lock = 0;
2606 v->di_tv.vval.v_dict = selfdict;
2607 ++selfdict->dv_refcount;
2608 }
2609
2610 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002611 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002612 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 * Set a:000 to a list with room for the "..." arguments.
2614 */
2615 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002616 if ((fp->uf_flags & FC_NOARGS) == 0)
2617 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002618 (varnumber_T)(argcount >= fp->uf_args.ga_len
2619 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002620 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002621 if ((fp->uf_flags & FC_NOARGS) == 0)
2622 {
2623 // Use "name" to avoid a warning from some compiler that checks the
2624 // destination size.
2625 v = &fc->fixvar[fixvar_idx++].var;
2626 name = v->di_key;
2627 STRCPY(name, "000");
2628 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2629 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2630 v->di_tv.v_type = VAR_LIST;
2631 v->di_tv.v_lock = VAR_FIXED;
2632 v->di_tv.vval.v_list = &fc->l_varlist;
2633 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002634 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002635 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2636 fc->l_varlist.lv_lock = VAR_FIXED;
2637
2638 /*
2639 * Set a:firstline to "firstline" and a:lastline to "lastline".
2640 * Set a:name to named arguments.
2641 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002642 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002644 if ((fp->uf_flags & FC_NOARGS) == 0)
2645 {
2646 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002647 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002648 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002649 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002650 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002651 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 {
2653 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002654 typval_T def_rettv;
2655 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656
2657 ai = i - fp->uf_args.ga_len;
2658 if (ai < 0)
2659 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002660 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 name = FUNCARG(fp, i);
2662 if (islambda)
2663 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002664
2665 // evaluate named argument default expression
2666 isdefault = ai + fp->uf_def_args.ga_len >= 0
2667 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2668 && argvars[i].vval.v_number == VVAL_NONE));
2669 if (isdefault)
2670 {
2671 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002672
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002673 def_rettv.v_type = VAR_NUMBER;
2674 def_rettv.vval.v_number = -1;
2675
2676 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2677 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002678 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002679 {
2680 default_arg_err = 1;
2681 break;
2682 }
2683 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002684 }
2685 else
2686 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002687 if ((fp->uf_flags & FC_NOARGS) != 0)
2688 // Bail out if no a: arguments used (in lambda).
2689 break;
2690
Bram Moolenaare38eab22019-12-05 21:50:01 +01002691 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002692 sprintf((char *)numbuf, "%d", ai + 1);
2693 name = numbuf;
2694 }
2695 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2696 {
2697 v = &fc->fixvar[fixvar_idx++].var;
2698 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002699 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700 }
2701 else
2702 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002703 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 if (v == NULL)
2705 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002706 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002709 // Note: the values are copied directly to avoid alloc/free.
2710 // "argvars" must have VAR_FIXED for v_lock.
2711 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 v->di_tv.v_lock = VAR_FIXED;
2713
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002714 if (isdefault)
2715 // Need to free this later, no matter where it's stored.
2716 tv_to_free[tv_to_free_len++] = &v->di_tv;
2717
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 if (addlocal)
2719 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002720 // Named arguments should be accessed without the "a:" prefix in
2721 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002722 copy_tv(&v->di_tv, &v->di_tv);
2723 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002725 else
2726 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002727
2728 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2729 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002730 listitem_T *li = &fc->l_listitems[ai];
2731
2732 li->li_tv = argvars[i];
2733 li->li_tv.v_lock = VAR_FIXED;
2734 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002735 }
2736 }
2737
Bram Moolenaare38eab22019-12-05 21:50:01 +01002738 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002740
2741 if (fp->uf_flags & FC_SANDBOX)
2742 {
2743 using_sandbox = TRUE;
2744 ++sandbox;
2745 }
2746
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002747 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002748 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002749 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002751 ++no_wait_return;
2752 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002754 smsg(_("calling %s"), SOURCING_NAME);
2755 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002757 char_u buf[MSG_BUF_LEN];
2758 char_u numbuf2[NUMBUFLEN];
2759 char_u *tofree;
2760 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002762 msg_puts("(");
2763 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002765 if (i > 0)
2766 msg_puts(", ");
2767 if (argvars[i].v_type == VAR_NUMBER)
2768 msg_outnum((long)argvars[i].vval.v_number);
2769 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002771 // Do not want errors such as E724 here.
2772 ++emsg_off;
2773 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2774 --emsg_off;
2775 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002777 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002779 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2780 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002782 msg_puts((char *)s);
2783 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002784 }
2785 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002787 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002789 msg_puts("\n"); // don't overwrite this either
2790
2791 verbose_leave_scroll();
2792 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002793 }
2794#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002795 if (do_profiling == PROF_YES)
2796 profile_may_start_func(&profile_info, fp,
2797 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798#endif
2799
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002800 save_current_sctx = current_sctx;
2801 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 save_did_emsg = did_emsg;
2803 did_emsg = FALSE;
2804
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002805 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2806 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002807 else if (islambda)
2808 {
2809 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2810
2811 // A Lambda always has the command "return {expr}". It is much faster
2812 // to evaluate {expr} directly.
2813 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002814 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002815 --ex_nesting_level;
2816 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002817 else
2818 // call do_cmdline() to execute the lines
2819 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2821
2822 --RedrawingDisabled;
2823
Bram Moolenaare38eab22019-12-05 21:50:01 +01002824 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2826 {
2827 clear_tv(rettv);
2828 rettv->v_type = VAR_NUMBER;
2829 rettv->vval.v_number = -1;
2830 }
2831
2832#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002833 if (do_profiling == PROF_YES)
2834 {
2835 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2836
2837 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2838 profile_may_end_func(&profile_info, fp, caller);
2839 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840#endif
2841
Bram Moolenaare38eab22019-12-05 21:50:01 +01002842 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 if (p_verbose >= 12)
2844 {
2845 ++no_wait_return;
2846 verbose_enter_scroll();
2847
2848 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002849 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002851 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 (long)fc->rettv->vval.v_number);
2853 else
2854 {
2855 char_u buf[MSG_BUF_LEN];
2856 char_u numbuf2[NUMBUFLEN];
2857 char_u *tofree;
2858 char_u *s;
2859
Bram Moolenaare38eab22019-12-05 21:50:01 +01002860 // The value may be very long. Skip the middle part, so that we
2861 // have some idea how it starts and ends. smsg() would always
2862 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002863 ++emsg_off;
2864 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2865 --emsg_off;
2866 if (s != NULL)
2867 {
2868 if (vim_strsize(s) > MSG_BUF_CLEN)
2869 {
2870 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2871 s = buf;
2872 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002873 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 vim_free(tofree);
2875 }
2876 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002877 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878
2879 verbose_leave_scroll();
2880 --no_wait_return;
2881 }
2882
Bram Moolenaare31ee862020-01-07 20:59:34 +01002883 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002884 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002885 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002886#ifdef FEAT_PROFILE
2887 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002888 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002890 if (using_sandbox)
2891 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002893 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002894 {
2895 ++no_wait_return;
2896 verbose_enter_scroll();
2897
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002898 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002899 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002900
2901 verbose_leave_scroll();
2902 --no_wait_return;
2903 }
2904
2905 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002906 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002907 for (i = 0; i < tv_to_free_len; ++i)
2908 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002909 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002910}
2911
2912/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002913 * Check the argument count for user function "fp".
2914 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2915 */
2916 int
2917check_user_func_argcount(ufunc_T *fp, int argcount)
2918{
2919 int regular_args = fp->uf_args.ga_len;
2920
2921 if (argcount < regular_args - fp->uf_def_args.ga_len)
2922 return FCERR_TOOFEW;
2923 else if (!has_varargs(fp) && argcount > regular_args)
2924 return FCERR_TOOMANY;
2925 return FCERR_UNKNOWN;
2926}
2927
2928/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002929 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002930 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002931 int
2932call_user_func_check(
2933 ufunc_T *fp,
2934 int argcount,
2935 typval_T *argvars,
2936 typval_T *rettv,
2937 funcexe_T *funcexe,
2938 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002939{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002940 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002941
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002942 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2943 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002944 error = check_user_func_argcount(fp, argcount);
2945 if (error != FCERR_UNKNOWN)
2946 return error;
2947 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002948 error = FCERR_DICT;
2949 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002950 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002951 int did_save_redo = FALSE;
2952 save_redo_T save_redo;
2953
2954 /*
2955 * Call the user function.
2956 * Save and restore search patterns, script variables and
2957 * redo buffer.
2958 */
2959 save_search_patterns();
2960 if (!ins_compl_active())
2961 {
2962 saveRedobuff(&save_redo);
2963 did_save_redo = TRUE;
2964 }
2965 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002966 call_user_func(fp, argcount, argvars, rettv, funcexe,
2967 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002968 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2969 // Function was unreferenced while being used, free it now.
2970 func_clear_free(fp, FALSE);
2971 if (did_save_redo)
2972 restoreRedobuff(&save_redo);
2973 restore_search_patterns();
2974 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002975 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002976 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002977}
2978
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002979static funccal_entry_T *funccal_stack = NULL;
2980
2981/*
2982 * Save the current function call pointer, and set it to NULL.
2983 * Used when executing autocommands and for ":source".
2984 */
2985 void
2986save_funccal(funccal_entry_T *entry)
2987{
2988 entry->top_funccal = current_funccal;
2989 entry->next = funccal_stack;
2990 funccal_stack = entry;
2991 current_funccal = NULL;
2992}
2993
2994 void
2995restore_funccal(void)
2996{
2997 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002998 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002999 else
3000 {
3001 current_funccal = funccal_stack->top_funccal;
3002 funccal_stack = funccal_stack->next;
3003 }
3004}
3005
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003006 funccall_T *
3007get_current_funccal(void)
3008{
3009 return current_funccal;
3010}
3011
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003012/*
3013 * Mark all functions of script "sid" as deleted.
3014 */
3015 void
3016delete_script_functions(int sid)
3017{
3018 hashitem_T *hi;
3019 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003020 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003021 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003022 size_t len;
3023
3024 buf[0] = K_SPECIAL;
3025 buf[1] = KS_EXTRA;
3026 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003027 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003028 len = STRLEN(buf);
3029
Bram Moolenaarce658352020-07-31 23:47:12 +02003030 while (todo > 0)
3031 {
3032 todo = func_hashtab.ht_used;
3033 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3034 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003035 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003036 fp = HI2UF(hi);
3037 if (STRNCMP(fp->uf_name, buf, len) == 0)
3038 {
3039 int changed = func_hashtab.ht_changed;
3040
3041 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003042
3043 if (fp->uf_calls > 0)
3044 {
3045 // Function is executing, don't free it but do remove
3046 // it from the hashtable.
3047 if (func_remove(fp))
3048 fp->uf_refcount--;
3049 }
3050 else
3051 {
3052 func_clear(fp, TRUE);
3053 // When clearing a function another function can be
3054 // cleared as a side effect. When that happens start
3055 // over.
3056 if (changed != func_hashtab.ht_changed)
3057 break;
3058 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003059 }
3060 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003061 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003062 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003063}
3064
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003065#if defined(EXITFREE) || defined(PROTO)
3066 void
3067free_all_functions(void)
3068{
3069 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003070 ufunc_T *fp;
3071 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003072 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003073 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003074
Bram Moolenaare38eab22019-12-05 21:50:01 +01003075 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003076 while (current_funccal != NULL)
3077 {
3078 clear_tv(current_funccal->rettv);
3079 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003080 if (current_funccal == NULL && funccal_stack != NULL)
3081 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003082 }
3083
Bram Moolenaare38eab22019-12-05 21:50:01 +01003084 // First clear what the functions contain. Since this may lower the
3085 // reference count of a function, it may also free a function and change
3086 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003087 while (todo > 0)
3088 {
3089 todo = func_hashtab.ht_used;
3090 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3091 if (!HASHITEM_EMPTY(hi))
3092 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003093 // clear the def function index now
3094 fp = HI2UF(hi);
3095 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003096 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003097
Bram Moolenaare38eab22019-12-05 21:50:01 +01003098 // Only free functions that are not refcounted, those are
3099 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003100 if (func_name_refcount(fp->uf_name))
3101 ++skipped;
3102 else
3103 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003104 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003105 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003106 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003107 {
3108 skipped = 0;
3109 break;
3110 }
3111 }
3112 --todo;
3113 }
3114 }
3115
Bram Moolenaare38eab22019-12-05 21:50:01 +01003116 // Now actually free the functions. Need to start all over every time,
3117 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003118 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003119 while (func_hashtab.ht_used > skipped)
3120 {
3121 todo = func_hashtab.ht_used;
3122 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 if (!HASHITEM_EMPTY(hi))
3124 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003125 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003126 // Only free functions that are not refcounted, those are
3127 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003128 fp = HI2UF(hi);
3129 if (func_name_refcount(fp->uf_name))
3130 ++skipped;
3131 else
3132 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003133 if (func_free(fp, FALSE) == OK)
3134 {
3135 skipped = 0;
3136 break;
3137 }
3138 // did not actually free it
3139 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003140 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003142 }
3143 if (skipped == 0)
3144 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003145
3146 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147}
3148#endif
3149
3150/*
3151 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003152 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3153 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003154 * "len" is the length of "name", or -1 for NUL terminated.
3155 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003156 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157builtin_function(char_u *name, int len)
3158{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003159 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160
Bram Moolenaara26b9702020-04-18 19:53:28 +02003161 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003163 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3164 {
3165 if (name[i] == AUTOLOAD_CHAR)
3166 return FALSE;
3167 if (!eval_isnamec(name[i]))
3168 {
3169 // "name.something" is not a builtin function
3170 if (name[i] == '.')
3171 return FALSE;
3172 break;
3173 }
3174 }
3175 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003176}
3177
3178 int
3179func_call(
3180 char_u *name,
3181 typval_T *args,
3182 partial_T *partial,
3183 dict_T *selfdict,
3184 typval_T *rettv)
3185{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003186 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003187 listitem_T *item;
3188 typval_T argv[MAX_FUNC_ARGS + 1];
3189 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003190 int r = 0;
3191
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003192 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003193 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 {
3195 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3196 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003197 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003198 break;
3199 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003200 // Make a copy of each argument. This is needed to be able to set
3201 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003202 copy_tv(&item->li_tv, &argv[argc++]);
3203 }
3204
3205 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003206 {
3207 funcexe_T funcexe;
3208
Bram Moolenaara80faa82020-04-12 19:37:17 +02003209 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003210 funcexe.fe_firstline = curwin->w_cursor.lnum;
3211 funcexe.fe_lastline = curwin->w_cursor.lnum;
3212 funcexe.fe_evaluate = TRUE;
3213 funcexe.fe_partial = partial;
3214 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003215 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3216 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217
Bram Moolenaare38eab22019-12-05 21:50:01 +01003218 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003219 while (argc > 0)
3220 clear_tv(&argv[--argc]);
3221
3222 return r;
3223}
3224
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003225static int callback_depth = 0;
3226
3227 int
3228get_callback_depth(void)
3229{
3230 return callback_depth;
3231}
3232
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003234 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003235 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003236 */
3237 int
3238call_callback(
3239 callback_T *callback,
3240 int len, // length of "name" or -1 to use strlen()
3241 typval_T *rettv, // return value goes here
3242 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003243 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003244 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003245{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003246 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003247 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003248
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003249 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3250 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003251 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003252 funcexe.fe_evaluate = TRUE;
3253 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003254 ++callback_depth;
3255 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3256 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003257
3258 // When a :def function was called that uses :try an error would be turned
3259 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003260 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003261 {
3262 need_rethrow = FALSE;
3263 handle_did_throw();
3264 }
3265
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003266 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003267}
3268
3269/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003270 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003271 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003272 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3273 */
3274 varnumber_T
3275call_callback_retnr(
3276 callback_T *callback,
3277 int argcount, // number of "argvars"
3278 typval_T *argvars) // vars for arguments, must have "argcount"
3279 // PLUS ONE elements!
3280{
3281 typval_T rettv;
3282 varnumber_T retval;
3283
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003284 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003285 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003286
3287 retval = tv_get_number_chk(&rettv, NULL);
3288 clear_tv(&rettv);
3289 return retval;
3290}
3291
3292/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003293 * Give an error message for the result of a function.
3294 * Nothing if "error" is FCERR_NONE.
3295 */
3296 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003297user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003298{
3299 switch (error)
3300 {
3301 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003302 if (funcexe->fe_found_var)
3303 semsg(_(e_not_callable_type_str), name);
3304 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003305 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003306 break;
3307 case FCERR_NOTMETHOD:
3308 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003309 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 break;
3311 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003312 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003313 break;
3314 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003315 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003316 break;
3317 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003318 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003319 break;
3320 case FCERR_SCRIPT:
3321 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003322 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003323 break;
3324 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003325 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3326 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003327 break;
3328 }
3329}
3330
3331/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003333 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334 * Return FAIL when the function can't be called, OK otherwise.
3335 * Also returns OK when an error was encountered while executing the function.
3336 */
3337 int
3338call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003339 char_u *funcname, // name of the function
3340 int len, // length of "name" or -1 to use strlen()
3341 typval_T *rettv, // return value goes here
3342 int argcount_in, // number of "argvars"
3343 typval_T *argvars_in, // vars for arguments, must have "argcount"
3344 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003345 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346{
3347 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003348 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003350 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 char_u fname_buf[FLEN_FIXED + 1];
3352 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003353 char_u *fname = NULL;
3354 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355 int argcount = argcount_in;
3356 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003357 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003358 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003359 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003361 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003362 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003363 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003364 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003366 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3367 // even when call_func() returns FAIL.
3368 rettv->v_type = VAR_UNKNOWN;
3369
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003370 if (partial != NULL)
3371 fp = partial->pt_func;
3372 if (fp == NULL)
3373 {
3374 // Make a copy of the name, if it comes from a funcref variable it
3375 // could be changed or deleted in the called function.
3376 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3377 if (name == NULL)
3378 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003379
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003380 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3381 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003383 if (funcexe->fe_doesrange != NULL)
3384 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385
3386 if (partial != NULL)
3387 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003388 // When the function has a partial with a dict and there is a dict
3389 // argument, use the dict argument. That is backwards compatible.
3390 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003391 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003393 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003394 {
3395 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003396 {
3397 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3398 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003399 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003400 goto theend;
3401 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003403 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 for (i = 0; i < argcount_in; ++i)
3405 argv[i + argv_clear] = argvars_in[i];
3406 argvars = argv;
3407 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003408
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003409 if (funcexe->fe_check_type != NULL
3410 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003411 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003412 // Now funcexe->fe_check_type is missing the added arguments,
3413 // make a copy of the type with the correction.
3414 check_type = *funcexe->fe_check_type;
3415 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003416 check_type.tt_args = check_type_args;
3417 CLEAR_FIELD(check_type_args);
3418 for (i = 0; i < check_type.tt_argcount; ++i)
3419 check_type_args[i + partial->pt_argc] =
3420 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003421 check_type.tt_argcount += partial->pt_argc;
3422 check_type.tt_min_argcount += partial->pt_argc;
3423 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 }
3425 }
3426
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003427 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3428 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003429 {
3430 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003431 if (check_argument_types(funcexe->fe_check_type,
3432 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003433 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003434 error = FCERR_OTHER;
3435 }
3436
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003437 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438 {
3439 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003440 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003441
Bram Moolenaar333894b2020-08-01 18:53:07 +02003442 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003443 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003444 {
3445 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003446 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003447 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448
Bram Moolenaare38eab22019-12-05 21:50:01 +01003449 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003451 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003453 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 {
3455 /*
3456 * User defined function.
3457 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003458 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003459 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003460 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003461 if (fp != NULL && !is_global && in_vim9script()
3462 && func_requires_g_prefix(fp))
3463 // In Vim9 script g: is required to find a global
3464 // non-autoload function.
3465 fp = NULL;
3466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467
Bram Moolenaare38eab22019-12-05 21:50:01 +01003468 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003469 if (fp == NULL
3470 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003471 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 && !aborting())
3473 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003474 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003475 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003477 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003478 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3479 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003480 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003481 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003483 if (fp == NULL)
3484 {
3485 char_u *p = untrans_function_name(rfname);
3486
3487 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003488 // Don't do this if the name starts with "s:".
3489 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003490 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003491 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003493 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003494 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003495#ifdef FEAT_LUA
3496 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3497 {
3498 cfunc_T cb = fp->uf_cb;
3499
3500 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3501 }
3502#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003503 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003505 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003506 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003507 argcount = funcexe->fe_argv_func(argcount, argvars,
3508 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003509
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003510 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003511 {
3512 // Method call: base->Method()
3513 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003514 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003515 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003516 argvars = argv;
3517 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003518 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003519
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003520 error = call_user_func_check(fp, argcount, argvars, rettv,
3521 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003522 }
3523 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003524 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003525 {
3526 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003527 * expr->method(): Find the method name in the table, call its
3528 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003529 */
3530 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003531 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 else
3534 {
3535 /*
3536 * Find the function name in the table, call its implementation.
3537 */
3538 error = call_internal_func(fname, argcount, argvars, rettv);
3539 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003540
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 /*
3542 * The function call (or "FuncUndefined" autocommand sequence) might
3543 * have been aborted by an error, an interrupt, or an explicitly thrown
3544 * exception that has not been caught so far. This situation can be
3545 * tested for by calling aborting(). For an error in an internal
3546 * function or for the "E132" error in call_user_func(), however, the
3547 * throw point at which the "force_abort" flag (temporarily reset by
3548 * emsg()) is normally updated has not been reached yet. We need to
3549 * update that flag first to make aborting() reliable.
3550 */
3551 update_force_abort();
3552 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003553 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 ret = OK;
3555
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003556theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 /*
3558 * Report an error unless the argument evaluation or function call has been
3559 * cancelled due to an aborting error, an interrupt, or an exception.
3560 */
3561 if (!aborting())
3562 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003563 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 }
3565
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003566 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003568 clear_tv(&argv[--argv_clear + argv_base]);
3569
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 vim_free(tofree);
3571 vim_free(name);
3572
3573 return ret;
3574}
3575
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003576 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003577printable_func_name(ufunc_T *fp)
3578{
3579 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3580}
3581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003582/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003583 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584 */
3585 static void
3586list_func_head(ufunc_T *fp, int indent)
3587{
3588 int j;
3589
3590 msg_start();
3591 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003592 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003593 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003594 msg_puts("def ");
3595 else
3596 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003597 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 msg_putchar('(');
3599 for (j = 0; j < fp->uf_args.ga_len; ++j)
3600 {
3601 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003602 msg_puts(", ");
3603 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003604 if (fp->uf_arg_types != NULL)
3605 {
3606 char *tofree;
3607
3608 msg_puts(": ");
3609 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3610 vim_free(tofree);
3611 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003612 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3613 {
3614 msg_puts(" = ");
3615 msg_puts(((char **)(fp->uf_def_args.ga_data))
3616 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3617 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 }
3619 if (fp->uf_varargs)
3620 {
3621 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003622 msg_puts(", ");
3623 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003625 if (fp->uf_va_name != NULL)
3626 {
3627 if (j)
3628 msg_puts(", ");
3629 msg_puts("...");
3630 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003631 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003632 {
3633 char *tofree;
3634
3635 msg_puts(": ");
3636 msg_puts(type_name(fp->uf_va_type, &tofree));
3637 vim_free(tofree);
3638 }
3639 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003641
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003642 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003643 {
3644 if (fp->uf_ret_type != &t_void)
3645 {
3646 char *tofree;
3647
3648 msg_puts(": ");
3649 msg_puts(type_name(fp->uf_ret_type, &tofree));
3650 vim_free(tofree);
3651 }
3652 }
3653 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003654 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003656 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003658 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003659 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003660 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 msg_clr_eos();
3662 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003663 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664}
3665
3666/*
3667 * Get a function name, translating "<SID>" and "<SNR>".
3668 * Also handles a Funcref in a List or Dictionary.
3669 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003670 * Set "*is_global" to TRUE when the function must be global, unless
3671 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 * flags:
3673 * TFN_INT: internal function name OK
3674 * TFN_QUIET: be quiet
3675 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003676 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 * Advances "pp" to just after the function name (if no error).
3678 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003679 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680trans_function_name(
3681 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003682 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003683 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003685 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003686 partial_T **partial, // return: partial of a FuncRef
3687 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688{
3689 char_u *name = NULL;
3690 char_u *start;
3691 char_u *end;
3692 int lead;
3693 char_u sid_buf[20];
3694 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003695 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003696 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003698 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699
3700 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003701 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702 start = *pp;
3703
Bram Moolenaare38eab22019-12-05 21:50:01 +01003704 // Check for hard coded <SNR>: already translated function ID (from a user
3705 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003706 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3707 && (*pp)[2] == (int)KE_SNR)
3708 {
3709 *pp += 3;
3710 len = get_id_len(pp) + 3;
3711 return vim_strnsave(start, len);
3712 }
3713
Bram Moolenaare38eab22019-12-05 21:50:01 +01003714 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3715 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003716 lead = eval_fname_script(start);
3717 if (lead > 2)
3718 start += lead;
3719
Bram Moolenaare38eab22019-12-05 21:50:01 +01003720 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003721 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaare6a42002022-01-21 10:32:58 +00003723 if (end == start || (in_vim9script() && end != NULL
3724 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 {
3726 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003727 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003728 goto theend;
3729 }
3730 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3731 {
3732 /*
3733 * Report an invalid expression in braces, unless the expression
3734 * evaluation has been cancelled due to an aborting error, an
3735 * interrupt, or an exception.
3736 */
3737 if (!aborting())
3738 {
3739 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003740 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 }
3742 else
3743 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3744 goto theend;
3745 }
3746
3747 if (lv.ll_tv != NULL)
3748 {
3749 if (fdp != NULL)
3750 {
3751 fdp->fd_dict = lv.ll_dict;
3752 fdp->fd_newkey = lv.ll_newkey;
3753 lv.ll_newkey = NULL;
3754 fdp->fd_di = lv.ll_di;
3755 }
3756 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3757 {
3758 name = vim_strsave(lv.ll_tv->vval.v_string);
3759 *pp = end;
3760 }
3761 else if (lv.ll_tv->v_type == VAR_PARTIAL
3762 && lv.ll_tv->vval.v_partial != NULL)
3763 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003764 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 *pp = end;
3766 if (partial != NULL)
3767 *partial = lv.ll_tv->vval.v_partial;
3768 }
3769 else
3770 {
3771 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3772 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003773 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 else
3775 *pp = end;
3776 name = NULL;
3777 }
3778 goto theend;
3779 }
3780
3781 if (lv.ll_name == NULL)
3782 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003783 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003784 *pp = end;
3785 goto theend;
3786 }
3787
Bram Moolenaare38eab22019-12-05 21:50:01 +01003788 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003789 if (lv.ll_exp_name != NULL)
3790 {
3791 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003792 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003793 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 if (name == lv.ll_exp_name)
3795 name = NULL;
3796 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003797 else if (lv.ll_sid > 0)
3798 {
3799 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3800 int cc = *lv.ll_name_end;
3801
3802 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3803 *lv.ll_name_end = NUL;
3804 if (si->sn_autoload_prefix != NULL)
3805 {
3806 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3807 }
3808 else
3809 {
3810 sid_buf[0] = K_SPECIAL;
3811 sid_buf[1] = KS_EXTRA;
3812 sid_buf[2] = (int)KE_SNR;
3813 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003814 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003815 name = concat_str(sid_buf, lv.ll_name);
3816 }
3817 *lv.ll_name_end = cc;
3818 *pp = end;
3819 goto theend;
3820 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003821 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 {
3823 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003824 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003825 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826 if (name == *pp)
3827 name = NULL;
3828 }
3829 if (name != NULL)
3830 {
3831 name = vim_strsave(name);
3832 *pp = end;
3833 if (STRNCMP(name, "<SNR>", 5) == 0)
3834 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003835 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003836 name[0] = K_SPECIAL;
3837 name[1] = KS_EXTRA;
3838 name[2] = (int)KE_SNR;
3839 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3840 }
3841 goto theend;
3842 }
3843
3844 if (lv.ll_exp_name != NULL)
3845 {
3846 len = (int)STRLEN(lv.ll_exp_name);
3847 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3848 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3849 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003850 // When there was "s:" already or the name expanded to get a
3851 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852 lv.ll_name += 2;
3853 len -= 2;
3854 lead = 2;
3855 }
3856 }
3857 else
3858 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003859 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003860 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003861 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003862 if (lv.ll_name[0] == 'g')
3863 {
3864 if (is_global != NULL)
3865 {
3866 *is_global = TRUE;
3867 }
3868 else
3869 {
3870 // dropping "g:" without setting "is_global" won't work in
3871 // Vim9script, put it back later
3872 prefix_g = TRUE;
3873 extra = 2;
3874 }
3875 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003876 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003877 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878 len = (int)(end - lv.ll_name);
3879 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003880 if (len <= 0)
3881 {
3882 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003883 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003884 goto theend;
3885 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003886
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003887 // In Vim9 script a user function is script-local by default, unless it
3888 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003889 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003890
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003891 /*
3892 * Copy the function name to allocated memory.
3893 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3894 * Accept <SNR>123_name() outside a script.
3895 */
3896 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003897 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003898 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003900 if (!vim9script)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003901 {
3902 if (in_vim9script() && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
3903 {
3904 semsg(_(in_vim9script()
3905 ? e_function_name_must_start_with_capital_str
3906 : e_function_name_must_start_with_capital_or_s_str),
3907 start);
3908 goto theend;
3909 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003910 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00003911 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003912 if (vim9script || (lv.ll_exp_name != NULL
3913 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914 || eval_fname_sid(*pp))
3915 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003916 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003917 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003919 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 goto theend;
3921 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003922 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003923 if (vim9script)
3924 extra = 3 + (int)STRLEN(sid_buf);
3925 else
3926 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 }
3928 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003929 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3930 || (in_vim9script() && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 {
Bram Moolenaar3787f262022-02-07 21:54:01 +00003932 semsg(_(in_vim9script()
3933 ? e_function_name_must_start_with_capital_str
3934 : e_function_name_must_start_with_capital_or_s_str),
3935 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 goto theend;
3937 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003938 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 {
3940 char_u *cp = vim_strchr(lv.ll_name, ':');
3941
3942 if (cp != NULL && cp < end)
3943 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003944 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 goto theend;
3946 }
3947 }
3948
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003949 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950 if (name != NULL)
3951 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003952 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953 {
3954 name[0] = K_SPECIAL;
3955 name[1] = KS_EXTRA;
3956 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003957 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958 STRCPY(name + 3, sid_buf);
3959 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003960 else if (prefix_g)
3961 {
3962 name[0] = 'g';
3963 name[1] = ':';
3964 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003965 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3966 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003967 }
3968 *pp = end;
3969
3970theend:
3971 clear_lval(&lv);
3972 return name;
3973}
3974
3975/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003976 * Assuming "name" is the result of trans_function_name() and it was prefixed
3977 * to use the script-local name, return the unmodified name (points into
3978 * "name"). Otherwise return NULL.
3979 * This can be used to first search for a script-local function and fall back
3980 * to the global function if not found.
3981 */
3982 char_u *
3983untrans_function_name(char_u *name)
3984{
3985 char_u *p;
3986
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003987 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003988 {
3989 p = vim_strchr(name, '_');
3990 if (p != NULL)
3991 return p + 1;
3992 }
3993 return NULL;
3994}
3995
3996/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00003997 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
3998 * current script ID and returns the expanded function name. The caller should
3999 * free the returned name. If not called from a script context or the function
4000 * name doesn't start with these prefixes, then returns NULL.
4001 * This doesn't check whether the script-local function exists or not.
4002 */
4003 char_u *
4004get_scriptlocal_funcname(char_u *funcname)
4005{
4006 char sid_buf[25];
4007 int off;
4008 char_u *newname;
4009
4010 if (funcname == NULL)
4011 return NULL;
4012
4013 if (STRNCMP(funcname, "s:", 2) != 0
4014 && STRNCMP(funcname, "<SID>", 5) != 0)
4015 // The function name is not a script-local function name
4016 return NULL;
4017
4018 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4019 {
4020 emsg(_(e_using_sid_not_in_script_context));
4021 return NULL;
4022 }
4023 // Expand s: prefix into <SNR>nr_<name>
4024 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4025 (long)current_sctx.sc_sid);
4026 off = *funcname == 's' ? 2 : 5;
4027 newname = alloc(STRLEN(sid_buf) + STRLEN(funcname + off) + 1);
4028 if (newname == NULL)
4029 return NULL;
4030 STRCPY(newname, sid_buf);
4031 STRCAT(newname, funcname + off);
4032
4033 return newname;
4034}
4035
4036/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004037 * Call trans_function_name(), except that a lambda is returned as-is.
4038 * Returns the name in allocated memory.
4039 */
4040 char_u *
4041save_function_name(
4042 char_u **name,
4043 int *is_global,
4044 int skip,
4045 int flags,
4046 funcdict_T *fudi)
4047{
4048 char_u *p = *name;
4049 char_u *saved;
4050
4051 if (STRNCMP(p, "<lambda>", 8) == 0)
4052 {
4053 p += 8;
4054 (void)getdigits(&p);
4055 saved = vim_strnsave(*name, p - *name);
4056 if (fudi != NULL)
4057 CLEAR_POINTER(fudi);
4058 }
4059 else
4060 saved = trans_function_name(&p, is_global, skip,
4061 flags, fudi, NULL, NULL);
4062 *name = p;
4063 return saved;
4064}
4065
4066/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004067 * List functions. When "regmatch" is NULL all of then.
4068 * Otherwise functions matching "regmatch".
4069 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004070 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004071list_functions(regmatch_T *regmatch)
4072{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004073 int changed = func_hashtab.ht_changed;
4074 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004075 hashitem_T *hi;
4076
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004077 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004078 {
4079 if (!HASHITEM_EMPTY(hi))
4080 {
4081 ufunc_T *fp = HI2UF(hi);
4082
4083 --todo;
4084 if ((fp->uf_flags & FC_DEAD) == 0
4085 && (regmatch == NULL
4086 ? !message_filtered(fp->uf_name)
4087 && !func_name_refcount(fp->uf_name)
4088 : !isdigit(*fp->uf_name)
4089 && vim_regexec(regmatch, fp->uf_name, 0)))
4090 {
4091 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004092 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004093 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004094 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004095 return;
4096 }
4097 }
4098 }
4099 }
4100}
4101
4102/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004103 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004104 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4105 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004106 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004107 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004109 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004110define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 int j;
4113 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004114 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004115 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004116 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 char_u *p;
4118 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004119 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004120 char_u *line_arg = NULL;
4121 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004122 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004123 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 garray_T newlines;
4125 int varargs = FALSE;
4126 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004127 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004128 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004129 int fp_allocated = FALSE;
4130 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004131 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004132 dictitem_T *v;
4133 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004134 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004135 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004137 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004138 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004139 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004140
4141 /*
4142 * ":function" without argument: list functions.
4143 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004144 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 {
4146 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004147 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004148 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004149 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150 }
4151
4152 /*
4153 * ":function /pat": list functions matching pattern.
4154 */
4155 if (*eap->arg == '/')
4156 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004157 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 if (!eap->skip)
4159 {
4160 regmatch_T regmatch;
4161
4162 c = *p;
4163 *p = NUL;
4164 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4165 *p = c;
4166 if (regmatch.regprog != NULL)
4167 {
4168 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004169 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 vim_regfree(regmatch.regprog);
4171 }
4172 }
4173 if (*p == '/')
4174 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004175 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004176 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 }
4178
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004179 ga_init(&newargs);
4180 ga_init(&argtypes);
4181 ga_init(&default_args);
4182
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183 /*
4184 * Get the function name. There are these situations:
4185 * func normal function name
4186 * "name" == func, "fudi.fd_dict" == NULL
4187 * dict.func new dictionary entry
4188 * "name" == NULL, "fudi.fd_dict" set,
4189 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4190 * dict.func existing dict entry with a Funcref
4191 * "name" == func, "fudi.fd_dict" set,
4192 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4193 * dict.func existing dict entry that's not a Funcref
4194 * "name" == NULL, "fudi.fd_dict" set,
4195 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4196 * s:func script-local function name
4197 * g:func global function name, same as "func"
4198 */
4199 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004200 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004202 // nested function, argument is (args).
4203 paren = TRUE;
4204 CLEAR_FIELD(fudi);
4205 }
4206 else
4207 {
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004208 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004209 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004210 paren = (vim_strchr(p, '(') != NULL);
4211 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004212 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004213 /*
4214 * Return on an invalid expression in braces, unless the expression
4215 * evaluation has been cancelled due to an aborting error, an
4216 * interrupt, or an exception.
4217 */
4218 if (!aborting())
4219 {
4220 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004221 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004222 vim_free(fudi.fd_newkey);
4223 return NULL;
4224 }
4225 else
4226 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004228
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004229 // For "export def FuncName()" in an autoload script the function name
4230 // is stored with the legacy autoload name "dir#script#FuncName" so
4231 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004232 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004233 {
4234 char_u *prefixed = may_prefix_autoload(name);
4235
4236 if (prefixed != NULL && prefixed != name)
4237 {
4238 vim_free(name);
4239 name = prefixed;
4240 }
4241 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004242 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004243 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004244 {
4245 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4246 goto ret_free;
4247 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004248 }
4249
Bram Moolenaare38eab22019-12-05 21:50:01 +01004250 // An error in a function call during evaluation of an expression in magic
4251 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 saved_did_emsg = did_emsg;
4253 did_emsg = FALSE;
4254
4255 /*
4256 * ":function func" with only function name: list function.
4257 */
4258 if (!paren)
4259 {
4260 if (!ends_excmd(*skipwhite(p)))
4261 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004262 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263 goto ret_free;
4264 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004265 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266 if (eap->nextcmd != NULL)
4267 *p = NUL;
4268 if (!eap->skip && !got_int)
4269 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004270 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004271 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4272 {
4273 char_u *up = untrans_function_name(name);
4274
4275 // With Vim9 script the name was made script-local, if not
4276 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004277 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004278 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004279 }
4280
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281 if (fp != NULL)
4282 {
4283 list_func_head(fp, TRUE);
4284 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4285 {
4286 if (FUNCLINE(fp, j) == NULL)
4287 continue;
4288 msg_putchar('\n');
4289 msg_outnum((long)(j + 1));
4290 if (j < 9)
4291 msg_putchar(' ');
4292 if (j < 99)
4293 msg_putchar(' ');
4294 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004295 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296 ui_breakcheck();
4297 }
4298 if (!got_int)
4299 {
4300 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004301 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004302 msg_puts(" enddef");
4303 else
4304 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004305 }
4306 }
4307 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004308 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 }
4310 goto ret_free;
4311 }
4312
4313 /*
4314 * ":function name(arg1, arg2)" Define function.
4315 */
4316 p = skipwhite(p);
4317 if (*p != '(')
4318 {
4319 if (!eap->skip)
4320 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004321 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 goto ret_free;
4323 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004324 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 if (vim_strchr(p, '(') != NULL)
4326 p = vim_strchr(p, '(');
4327 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004329 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4330 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004331 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004332 goto ret_free;
4333 }
4334
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004335 // In Vim9 script only global functions can be redefined.
4336 if (vim9script && eap->forceit && !is_global)
4337 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004338 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004339 goto ret_free;
4340 }
4341
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004342 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343
Bram Moolenaar04b12692020-05-04 23:24:44 +02004344 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004346 // Check the name of the function. Unless it's a dictionary function
4347 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004348 if (name != NULL)
4349 arg = name;
4350 else
4351 arg = fudi.fd_newkey;
4352 if (arg != NULL && (fudi.fd_di == NULL
4353 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4354 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4355 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004356 char_u *name_base = arg;
4357 int i;
4358
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004360 {
4361 name_base = vim_strchr(arg, '_');
4362 if (name_base == NULL)
4363 name_base = arg + 3;
4364 else
4365 ++name_base;
4366 }
4367 for (i = 0; name_base[i] != NUL && (i == 0
4368 ? eval_isnamec1(name_base[i])
4369 : eval_isnamec(name_base[i])); ++i)
4370 ;
4371 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004372 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004373
4374 // In Vim9 script a function cannot have the same name as a
4375 // variable.
4376 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004377 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4378 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004379 + EVAL_VAR_NO_FUNC) == OK)
4380 {
4381 semsg(_(e_redefining_script_item_str), name_base);
4382 goto ret_free;
4383 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004385 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004387 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004388 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004389 goto ret_free;
4390 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391 }
4392
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004393 // This may get more lines and make the pointers into the first line
4394 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004395 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004396 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004397 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004398 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004399 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004401 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004403 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004404 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004405 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004406 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004408 if (*p != ':')
4409 {
4410 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4411 p = skipwhite(p);
4412 }
4413 else if (!IS_WHITE_OR_NUL(p[1]))
4414 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004415 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004416 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004417 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004418 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004419 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004420 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004421 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004422 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004423 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004424 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004425 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004426 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004427 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004429 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004430 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004431 else
4432 // find extra arguments "range", "dict", "abort" and "closure"
4433 for (;;)
4434 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004435 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004436 p = skipwhite(p);
4437 if (STRNCMP(p, "range", 5) == 0)
4438 {
4439 flags |= FC_RANGE;
4440 p += 5;
4441 }
4442 else if (STRNCMP(p, "dict", 4) == 0)
4443 {
4444 flags |= FC_DICT;
4445 p += 4;
4446 }
4447 else if (STRNCMP(p, "abort", 5) == 0)
4448 {
4449 flags |= FC_ABORT;
4450 p += 5;
4451 }
4452 else if (STRNCMP(p, "closure", 7) == 0)
4453 {
4454 flags |= FC_CLOSURE;
4455 p += 7;
4456 if (current_funccal == NULL)
4457 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004458 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004459 name == NULL ? (char_u *)"" : name);
4460 goto erret;
4461 }
4462 }
4463 else
4464 break;
4465 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466
Bram Moolenaare38eab22019-12-05 21:50:01 +01004467 // When there is a line break use what follows for the function body.
4468 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 if (*p == '\n')
4470 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004471 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004472 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4473 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004474 && !(VIM_ISWHITE(*whitep) && *p == '#'
4475 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004476 && !eap->skip
4477 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004478 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479
4480 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004481 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4482 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483 */
4484 if (KeyTyped)
4485 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004486 // Check if the function already exists, don't let the user type the
4487 // whole function before telling him it doesn't work! For a script we
4488 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 if (!eap->skip && !eap->forceit)
4490 {
4491 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004492 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004493 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004494 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495 }
4496
4497 if (!eap->skip && did_emsg)
4498 goto erret;
4499
Bram Moolenaare38eab22019-12-05 21:50:01 +01004500 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501 cmdline_row = msg_row;
4502 }
4503
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004504 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004505 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004506
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004507 // Do not define the function when getting the body fails and when
4508 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004509 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004510 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 goto erret;
4512
4513 /*
4514 * If there are no errors, add the function
4515 */
4516 if (fudi.fd_dict == NULL)
4517 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004518 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004519 char_u *find_name = name;
4520 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004521 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004522
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004523 v = find_var(name, &ht, TRUE);
Bram Moolenaar6f0ddbf2022-01-20 19:56:49 +00004524 if (v != NULL && (in_vim9script() || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004525 var_conflict = TRUE;
4526
4527 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4528 {
4529 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4530
4531 if (si->sn_autoload_prefix != NULL)
4532 {
4533 if (is_export)
4534 {
4535 find_name = name + STRLEN(si->sn_autoload_prefix);
4536 v = find_var(find_name, &ht, TRUE);
4537 if (v != NULL)
4538 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004539 // Only check if the function already exists in the script,
4540 // global functions can be shadowed.
4541 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004542 }
4543 else
4544 {
4545 char_u *prefixed = may_prefix_autoload(name);
4546
4547 if (prefixed != NULL)
4548 {
4549 v = find_var(prefixed, &ht, TRUE);
4550 if (v != NULL)
4551 var_conflict = TRUE;
4552 vim_free(prefixed);
4553 }
4554 }
4555 }
4556 }
4557 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004559 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004560 goto erret;
4561 }
4562
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004563 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004564 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004566 char_u *uname = untrans_function_name(name);
4567
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004568 import = find_imported(uname == NULL ? name : uname, 0,
4569 FALSE, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02004570 }
4571
4572 if (fp != NULL || import != NULL)
4573 {
4574 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004575
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004576 // Function can be replaced with "function!" and when sourcing the
4577 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004578 // A name that is used by an import can not be overruled.
4579 if (import != NULL
4580 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004581 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004582 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004584 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004585 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004586 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004587 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004588 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004589 goto erret;
4590 }
4591 if (fp->uf_calls > 0)
4592 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004593 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004594 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595 goto erret;
4596 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004597 if (fp->uf_refcount > 1)
4598 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004599 // This function is referenced somewhere, don't redefine it but
4600 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004601 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004602 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004603 fp = NULL;
4604 overwrite = TRUE;
4605 }
4606 else
4607 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004608 char_u *exp_name = fp->uf_name_exp;
4609
4610 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004611 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004612 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004613 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004614 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004615 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004616#ifdef FEAT_PROFILE
4617 fp->uf_profiling = FALSE;
4618 fp->uf_prof_initialized = FALSE;
4619#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004620 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004621 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622 }
4623 }
4624 else
4625 {
4626 char numbuf[20];
4627
4628 fp = NULL;
4629 if (fudi.fd_newkey == NULL && !eap->forceit)
4630 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004631 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632 goto erret;
4633 }
4634 if (fudi.fd_di == NULL)
4635 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004636 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004637 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004638 goto erret;
4639 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004640 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004641 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 goto erret;
4643
Bram Moolenaare38eab22019-12-05 21:50:01 +01004644 // Give the function a sequential number. Can only be used with a
4645 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004646 vim_free(name);
4647 sprintf(numbuf, "%d", ++func_nr);
4648 name = vim_strsave((char_u *)numbuf);
4649 if (name == NULL)
4650 goto erret;
4651 }
4652
4653 if (fp == NULL)
4654 {
4655 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4656 {
4657 int slen, plen;
4658 char_u *scriptname;
4659
Bram Moolenaare38eab22019-12-05 21:50:01 +01004660 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004662 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004663 {
4664 scriptname = autoload_name(name);
4665 if (scriptname != NULL)
4666 {
4667 p = vim_strchr(scriptname, '/');
4668 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004669 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004671 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 j = OK;
4673 vim_free(scriptname);
4674 }
4675 }
4676 if (j == FAIL)
4677 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004678 linenr_T save_lnum = SOURCING_LNUM;
4679
4680 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004681 semsg(_(e_function_name_does_not_match_script_file_name_str),
4682 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004683 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 goto erret;
4685 }
4686 }
4687
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004688 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 if (fp == NULL)
4690 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004691 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692
4693 if (fudi.fd_dict != NULL)
4694 {
4695 if (fudi.fd_di == NULL)
4696 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004697 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4699 if (fudi.fd_di == NULL)
4700 {
4701 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004702 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004703 goto erret;
4704 }
4705 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4706 {
4707 vim_free(fudi.fd_di);
4708 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004709 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004710 goto erret;
4711 }
4712 }
4713 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004714 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715 clear_tv(&fudi.fd_di->di_tv);
4716 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718
Bram Moolenaare38eab22019-12-05 21:50:01 +01004719 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004720 flags |= FC_DICT;
4721 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004722 }
4723 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004724 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004725 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004726 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004727
4728 if (eap->cmdidx == CMD_def)
4729 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004730 int lnum_save = SOURCING_LNUM;
4731 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004732
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004733 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004734
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004735 // error messages are for the first function line
4736 SOURCING_LNUM = sourcing_lnum_top;
4737
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004738 // The function may use script variables from the context.
4739 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004740
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004741 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004742 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004743 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004744 free_fp = fp_allocated;
4745 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004746 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004747 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004748
4749 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004750 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004751 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004752 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004753 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004754 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004755 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004756 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004757 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004758 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004759 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004760
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004761 if (fp_allocated)
4762 {
4763 // insert the new function in the function list
4764 set_ufunc_name(fp, name);
4765 if (overwrite)
4766 {
4767 hi = hash_find(&func_hashtab, name);
4768 hi->hi_key = UF2HIKEY(fp);
4769 }
4770 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4771 {
4772 free_fp = TRUE;
4773 goto erret;
4774 }
4775 fp->uf_refcount = 1;
4776 }
4777
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004779 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004780 if ((flags & FC_CLOSURE) != 0)
4781 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004782 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004783 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004784 }
4785 else
4786 fp->uf_scoped = NULL;
4787
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789 if (prof_def_func())
4790 func_do_profile(fp);
4791#endif
4792 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004793 if (sandbox)
4794 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004795 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004796 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004797 fp->uf_flags = flags;
4798 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004799 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004800 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004801 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004802 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004803 if (is_export)
4804 {
4805 fp->uf_flags |= FC_EXPORT;
4806 // let ex_export() know the export worked.
4807 is_export = FALSE;
4808 }
4809
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004810 if (eap->cmdidx == CMD_def)
4811 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004812 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4813 // :func does not use Vim9 script syntax, even in a Vim9 script file
4814 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004815
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004816 goto ret_free;
4817
4818erret:
4819 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004820 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004821 if (fp != NULL)
4822 {
4823 ga_init(&fp->uf_args);
4824 ga_init(&fp->uf_def_args);
4825 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826errret_2:
4827 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004828 if (fp != NULL)
4829 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004830 if (free_fp)
4831 {
4832 vim_free(fp);
4833 fp = NULL;
4834 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004835ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004836 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004837 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004838 if (name != name_arg)
4839 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004840 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004841 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004842
4843 return fp;
4844}
4845
4846/*
4847 * ":function"
4848 */
4849 void
4850ex_function(exarg_T *eap)
4851{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004852 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004853
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004854 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4855 (void)define_function(eap, NULL, &lines_to_free);
4856 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004857}
4858
4859/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004860 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004861 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004862 */
4863 void
4864ex_defcompile(exarg_T *eap UNUSED)
4865{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004866 long todo = (long)func_hashtab.ht_used;
4867 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004868 hashitem_T *hi;
4869 ufunc_T *ufunc;
4870
4871 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4872 {
4873 if (!HASHITEM_EMPTY(hi))
4874 {
4875 --todo;
4876 ufunc = HI2UF(hi);
4877 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004878 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4879 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004880 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004881 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004882
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004883 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004884 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004885 // a function has been added or removed, need to start over
4886 todo = (long)func_hashtab.ht_used;
4887 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004888 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004889 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004890 }
4891 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004892 }
4893 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894}
4895
4896/*
4897 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4898 * Return 2 if "p" starts with "s:".
4899 * Return 0 otherwise.
4900 */
4901 int
4902eval_fname_script(char_u *p)
4903{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004904 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4905 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4907 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4908 return 5;
4909 if (p[0] == 's' && p[1] == ':')
4910 return 2;
4911 return 0;
4912}
4913
4914 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004915translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004916{
4917 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004918 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004919 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004920}
4921
4922/*
4923 * Return TRUE when "ufunc" has old-style "..." varargs
4924 * or named varargs "...name: type".
4925 */
4926 int
4927has_varargs(ufunc_T *ufunc)
4928{
4929 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930}
4931
4932/*
4933 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004934 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 */
4936 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004937function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938{
4939 char_u *nm = name;
4940 char_u *p;
4941 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004942 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004943 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004944
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004945 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4946 if (no_deref)
4947 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004948 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004949 nm = skipwhite(nm);
4950
Bram Moolenaare38eab22019-12-05 21:50:01 +01004951 // Only accept "funcname", "funcname ", "funcname (..." and
4952 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004954 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955 vim_free(p);
4956 return n;
4957}
4958
Bram Moolenaar113e1072019-01-20 15:30:40 +01004959#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004960 char_u *
4961get_expanded_name(char_u *name, int check)
4962{
4963 char_u *nm = name;
4964 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004965 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004967 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004968 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004970 if (p != NULL && *nm == NUL
4971 && (!check || translated_function_exists(p, is_global)))
4972 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973
4974 vim_free(p);
4975 return NULL;
4976}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004977#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979/*
4980 * Function given to ExpandGeneric() to obtain the list of user defined
4981 * function names.
4982 */
4983 char_u *
4984get_user_func_name(expand_T *xp, int idx)
4985{
4986 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004987 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988 static hashitem_T *hi;
4989 ufunc_T *fp;
4990
4991 if (idx == 0)
4992 {
4993 done = 0;
4994 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004995 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004996 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004997 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004998 {
4999 if (done++ > 0)
5000 ++hi;
5001 while (HASHITEM_EMPTY(hi))
5002 ++hi;
5003 fp = HI2UF(hi);
5004
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005005 // don't show dead, dict and lambda functions
5006 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005007 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005008 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005009
5010 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005011 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005012
5013 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005014 if (xp->xp_context != EXPAND_USER_FUNC
5015 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016 {
5017 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005018 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005019 STRCAT(IObuff, ")");
5020 }
5021 return IObuff;
5022 }
5023 return NULL;
5024}
5025
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026/*
5027 * ":delfunction {name}"
5028 */
5029 void
5030ex_delfunction(exarg_T *eap)
5031{
5032 ufunc_T *fp = NULL;
5033 char_u *p;
5034 char_u *name;
5035 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005036 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037
5038 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005039 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5040 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 vim_free(fudi.fd_newkey);
5042 if (name == NULL)
5043 {
5044 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005045 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005046 return;
5047 }
5048 if (!ends_excmd(*skipwhite(p)))
5049 {
5050 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005051 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005052 return;
5053 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005054 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005055 if (eap->nextcmd != NULL)
5056 *p = NUL;
5057
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005058 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005059 {
5060 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005061 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005062 vim_free(name);
5063 return;
5064 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005066 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005067 vim_free(name);
5068
5069 if (!eap->skip)
5070 {
5071 if (fp == NULL)
5072 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005073 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005074 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005075 return;
5076 }
5077 if (fp->uf_calls > 0)
5078 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005079 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080 return;
5081 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005082 if (fp->uf_flags & FC_VIM9)
5083 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005084 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005085 return;
5086 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005087
5088 if (fudi.fd_dict != NULL)
5089 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005090 // Delete the dict item that refers to the function, it will
5091 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005092 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5093 }
5094 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005095 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005096 // A normal function (not a numbered function or lambda) has a
5097 // refcount of 1 for the entry in the hashtable. When deleting
5098 // it and the refcount is more than one, it should be kept.
5099 // A numbered function and lambda should be kept if the refcount is
5100 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005101 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005102 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005103 // Function is still referenced somewhere. Don't free it but
5104 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005105 if (func_remove(fp))
5106 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005107 }
5108 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005109 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005110 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005111 }
5112}
5113
5114/*
5115 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005116 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005117 */
5118 void
5119func_unref(char_u *name)
5120{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005121 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005123 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005125 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005126 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005129 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005131 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005132 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005133 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005134}
5135
5136/*
5137 * Unreference a Function: decrement the reference count and free it when it
5138 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005139 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005140 */
5141 void
5142func_ptr_unref(ufunc_T *fp)
5143{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005144 if (fp != NULL && (--fp->uf_refcount <= 0
5145 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5146 && fp->uf_partial->pt_refcount <= 1
5147 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005148 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005149 // Only delete it when it's not being used. Otherwise it's done
5150 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005151 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005152 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153 }
5154}
5155
5156/*
5157 * Count a reference to a Function.
5158 */
5159 void
5160func_ref(char_u *name)
5161{
5162 ufunc_T *fp;
5163
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005164 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005166 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005167 if (fp != NULL)
5168 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005169 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005170 // Only give an error for a numbered function.
5171 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005172 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005173}
5174
5175/*
5176 * Count a reference to a Function.
5177 */
5178 void
5179func_ptr_ref(ufunc_T *fp)
5180{
5181 if (fp != NULL)
5182 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005183}
5184
5185/*
5186 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5187 * referenced from anywhere that is in use.
5188 */
5189 static int
5190can_free_funccal(funccall_T *fc, int copyID)
5191{
5192 return (fc->l_varlist.lv_copyID != copyID
5193 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005194 && fc->l_avars.dv_copyID != copyID
5195 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005196}
5197
5198/*
5199 * ":return [expr]"
5200 */
5201 void
5202ex_return(exarg_T *eap)
5203{
5204 char_u *arg = eap->arg;
5205 typval_T rettv;
5206 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005207 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208
5209 if (current_funccal == NULL)
5210 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005211 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212 return;
5213 }
5214
Bram Moolenaar844fb642021-10-23 13:32:30 +01005215 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005216 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5217
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218 if (eap->skip)
5219 ++emsg_skip;
5220
5221 eap->nextcmd = NULL;
5222 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005223 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224 {
5225 if (!eap->skip)
5226 returning = do_return(eap, FALSE, TRUE, &rettv);
5227 else
5228 clear_tv(&rettv);
5229 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005230 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005231 else if (!eap->skip)
5232 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005233 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005234 update_force_abort();
5235
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 /*
5237 * Return unless the expression evaluation has been cancelled due to an
5238 * aborting error, an interrupt, or an exception.
5239 */
5240 if (!aborting())
5241 returning = do_return(eap, FALSE, TRUE, NULL);
5242 }
5243
Bram Moolenaare38eab22019-12-05 21:50:01 +01005244 // When skipping or the return gets pending, advance to the next command
5245 // in this line (!returning). Otherwise, ignore the rest of the line.
5246 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247 if (returning)
5248 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005249 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005250 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005251
5252 if (eap->skip)
5253 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005254 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005255}
5256
5257/*
5258 * ":1,25call func(arg1, arg2)" function call.
5259 */
5260 void
5261ex_call(exarg_T *eap)
5262{
5263 char_u *arg = eap->arg;
5264 char_u *startarg;
5265 char_u *name;
5266 char_u *tofree;
5267 int len;
5268 typval_T rettv;
5269 linenr_T lnum;
5270 int doesrange;
5271 int failed = FALSE;
5272 funcdict_T fudi;
5273 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005274 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005275 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005276 int found_var = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005277
Bram Moolenaare6b53242020-07-01 17:28:33 +02005278 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005279 if (eap->skip)
5280 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005281 // trans_function_name() doesn't work well when skipping, use eval0()
5282 // instead to skip to any following command, e.g. for:
5283 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005284 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005285 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005286 clear_tv(&rettv);
5287 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005288 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005289 return;
5290 }
5291
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005292 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
5293 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005294 if (fudi.fd_newkey != NULL)
5295 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005296 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005297 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005298 vim_free(fudi.fd_newkey);
5299 }
5300 if (tofree == NULL)
5301 return;
5302
Bram Moolenaare38eab22019-12-05 21:50:01 +01005303 // Increase refcount on dictionary, it could get deleted when evaluating
5304 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005305 if (fudi.fd_dict != NULL)
5306 ++fudi.fd_dict->dv_refcount;
5307
Bram Moolenaare38eab22019-12-05 21:50:01 +01005308 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5309 // contents. For VAR_PARTIAL get its partial, unless we already have one
5310 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005311 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005312 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005313 in_vim9script() && type == NULL ? &type : NULL,
5314 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005315
Bram Moolenaare38eab22019-12-05 21:50:01 +01005316 // Skip white space to allow ":call func ()". Not good, but required for
5317 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005318 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319 if (*startarg != '(')
5320 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005321 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005322 goto end;
5323 }
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005324 if (in_vim9script() && startarg > arg)
5325 {
5326 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5327 goto end;
5328 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329
5330 /*
5331 * When skipping, evaluate the function once, to find the end of the
5332 * arguments.
5333 * When the function takes a range, this is discovered after the first
5334 * call, and the loop is broken.
5335 */
5336 if (eap->skip)
5337 {
5338 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005339 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005340 }
5341 else
5342 lnum = eap->line1;
5343 for ( ; lnum <= eap->line2; ++lnum)
5344 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005345 funcexe_T funcexe;
5346
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005347 if (!eap->skip && eap->addr_count > 0)
5348 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005349 if (lnum > curbuf->b_ml.ml_line_count)
5350 {
5351 // If the function deleted lines or switched to another buffer
5352 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005353 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005354 break;
5355 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005356 curwin->w_cursor.lnum = lnum;
5357 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005358 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359 }
5360 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005361
Bram Moolenaara80faa82020-04-12 19:37:17 +02005362 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005363 funcexe.fe_firstline = eap->line1;
5364 funcexe.fe_lastline = eap->line2;
5365 funcexe.fe_doesrange = &doesrange;
5366 funcexe.fe_evaluate = !eap->skip;
5367 funcexe.fe_partial = partial;
5368 funcexe.fe_selfdict = fudi.fd_dict;
5369 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005370 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005371 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005372 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005373 {
5374 failed = TRUE;
5375 break;
5376 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005377 if (has_watchexpr())
5378 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005379
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005380 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005381 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005382 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005383 {
5384 failed = TRUE;
5385 break;
5386 }
5387
5388 clear_tv(&rettv);
5389 if (doesrange || eap->skip)
5390 break;
5391
Bram Moolenaare38eab22019-12-05 21:50:01 +01005392 // Stop when immediately aborting on error, or when an interrupt
5393 // occurred or an exception was thrown but not caught.
5394 // get_func_tv() returned OK, so that the check for trailing
5395 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005396 if (aborting())
5397 break;
5398 }
5399 if (eap->skip)
5400 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005401 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005402
Bram Moolenaar1d341892021-09-18 15:25:52 +02005403 // When inside :try we need to check for following "| catch" or "| endtry".
5404 // Not when there was an error, but do check if an exception was thrown.
5405 if ((!aborting() || did_throw)
5406 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005407 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005408 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005409 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005410 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005411 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005412 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005413 {
5414 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005415 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005416 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005417 }
5418 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005419 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005420 }
5421
5422end:
5423 dict_unref(fudi.fd_dict);
5424 vim_free(tofree);
5425}
5426
5427/*
5428 * Return from a function. Possibly makes the return pending. Also called
5429 * for a pending return at the ":endtry" or after returning from an extra
5430 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5431 * when called due to a ":return" command. "rettv" may point to a typval_T
5432 * with the return rettv. Returns TRUE when the return can be carried out,
5433 * FALSE when the return gets pending.
5434 */
5435 int
5436do_return(
5437 exarg_T *eap,
5438 int reanimate,
5439 int is_cmd,
5440 void *rettv)
5441{
5442 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005443 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005444
5445 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005446 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005447 current_funccal->returned = FALSE;
5448
5449 /*
5450 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5451 * not in its finally clause (which then is to be executed next) is found.
5452 * In this case, make the ":return" pending for execution at the ":endtry".
5453 * Otherwise, return normally.
5454 */
5455 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5456 if (idx >= 0)
5457 {
5458 cstack->cs_pending[idx] = CSTP_RETURN;
5459
5460 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005461 // A pending return again gets pending. "rettv" points to an
5462 // allocated variable with the rettv of the original ":return"'s
5463 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005464 cstack->cs_rettv[idx] = rettv;
5465 else
5466 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005467 // When undoing a return in order to make it pending, get the stored
5468 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005469 if (reanimate)
5470 rettv = current_funccal->rettv;
5471
5472 if (rettv != NULL)
5473 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005474 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005475 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5476 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5477 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005478 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005479 }
5480 else
5481 cstack->cs_rettv[idx] = NULL;
5482
5483 if (reanimate)
5484 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005485 // The pending return value could be overwritten by a ":return"
5486 // without argument in a finally clause; reset the default
5487 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005488 current_funccal->rettv->v_type = VAR_NUMBER;
5489 current_funccal->rettv->vval.v_number = 0;
5490 }
5491 }
5492 report_make_pending(CSTP_RETURN, rettv);
5493 }
5494 else
5495 {
5496 current_funccal->returned = TRUE;
5497
Bram Moolenaare38eab22019-12-05 21:50:01 +01005498 // If the return is carried out now, store the return value. For
5499 // a return immediately after reanimation, the value is already
5500 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005501 if (!reanimate && rettv != NULL)
5502 {
5503 clear_tv(current_funccal->rettv);
5504 *current_funccal->rettv = *(typval_T *)rettv;
5505 if (!is_cmd)
5506 vim_free(rettv);
5507 }
5508 }
5509
5510 return idx < 0;
5511}
5512
5513/*
5514 * Free the variable with a pending return value.
5515 */
5516 void
5517discard_pending_return(void *rettv)
5518{
5519 free_tv((typval_T *)rettv);
5520}
5521
5522/*
5523 * Generate a return command for producing the value of "rettv". The result
5524 * is an allocated string. Used by report_pending() for verbose messages.
5525 */
5526 char_u *
5527get_return_cmd(void *rettv)
5528{
5529 char_u *s = NULL;
5530 char_u *tofree = NULL;
5531 char_u numbuf[NUMBUFLEN];
5532
5533 if (rettv != NULL)
5534 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5535 if (s == NULL)
5536 s = (char_u *)"";
5537
5538 STRCPY(IObuff, ":return ");
5539 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5540 if (STRLEN(s) + 8 >= IOSIZE)
5541 STRCPY(IObuff + IOSIZE - 4, "...");
5542 vim_free(tofree);
5543 return vim_strsave(IObuff);
5544}
5545
5546/*
5547 * Get next function line.
5548 * Called by do_cmdline() to get the next line.
5549 * Returns allocated string, or NULL for end of function.
5550 */
5551 char_u *
5552get_func_line(
5553 int c UNUSED,
5554 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005555 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005556 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005557{
5558 funccall_T *fcp = (funccall_T *)cookie;
5559 ufunc_T *fp = fcp->func;
5560 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005561 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005562
Bram Moolenaare38eab22019-12-05 21:50:01 +01005563 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005564 if (fcp->dbg_tick != debug_tick)
5565 {
5566 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005567 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005568 fcp->dbg_tick = debug_tick;
5569 }
5570#ifdef FEAT_PROFILE
5571 if (do_profiling == PROF_YES)
5572 func_line_end(cookie);
5573#endif
5574
5575 gap = &fp->uf_lines;
5576 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5577 || fcp->returned)
5578 retval = NULL;
5579 else
5580 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005581 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005582 while (fcp->linenr < gap->ga_len
5583 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5584 ++fcp->linenr;
5585 if (fcp->linenr >= gap->ga_len)
5586 retval = NULL;
5587 else
5588 {
5589 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005590 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005591#ifdef FEAT_PROFILE
5592 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005593 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005594#endif
5595 }
5596 }
5597
Bram Moolenaare38eab22019-12-05 21:50:01 +01005598 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005599 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005600 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005601 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005602 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005603 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005604 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005605 fcp->dbg_tick = debug_tick;
5606 }
5607
5608 return retval;
5609}
5610
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005611/*
5612 * Return TRUE if the currently active function should be ended, because a
5613 * return was encountered or an error occurred. Used inside a ":while".
5614 */
5615 int
5616func_has_ended(void *cookie)
5617{
5618 funccall_T *fcp = (funccall_T *)cookie;
5619
Bram Moolenaare38eab22019-12-05 21:50:01 +01005620 // Ignore the "abort" flag if the abortion behavior has been changed due to
5621 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005622 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5623 || fcp->returned);
5624}
5625
5626/*
5627 * return TRUE if cookie indicates a function which "abort"s on errors.
5628 */
5629 int
5630func_has_abort(
5631 void *cookie)
5632{
5633 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5634}
5635
5636
5637/*
5638 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5639 * Don't do this when "Func" is already a partial that was bound
5640 * explicitly (pt_auto is FALSE).
5641 * Changes "rettv" in-place.
5642 * Returns the updated "selfdict_in".
5643 */
5644 dict_T *
5645make_partial(dict_T *selfdict_in, typval_T *rettv)
5646{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005647 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005648 char_u *tofree = NULL;
5649 ufunc_T *fp;
5650 char_u fname_buf[FLEN_FIXED + 1];
5651 int error;
5652 dict_T *selfdict = selfdict_in;
5653
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005654 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5655 fp = rettv->vval.v_partial->pt_func;
5656 else
5657 {
5658 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5659 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005660 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005661 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005662 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005663 vim_free(tofree);
5664 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005665
5666 if (fp != NULL && (fp->uf_flags & FC_DICT))
5667 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005668 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005669
5670 if (pt != NULL)
5671 {
5672 pt->pt_refcount = 1;
5673 pt->pt_dict = selfdict;
5674 pt->pt_auto = TRUE;
5675 selfdict = NULL;
5676 if (rettv->v_type == VAR_FUNC)
5677 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005678 // Just a function: Take over the function name and use
5679 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005680 pt->pt_name = rettv->vval.v_string;
5681 }
5682 else
5683 {
5684 partial_T *ret_pt = rettv->vval.v_partial;
5685 int i;
5686
Bram Moolenaare38eab22019-12-05 21:50:01 +01005687 // Partial: copy the function name, use selfdict and copy
5688 // args. Can't take over name or args, the partial might
5689 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005690 if (ret_pt->pt_name != NULL)
5691 {
5692 pt->pt_name = vim_strsave(ret_pt->pt_name);
5693 func_ref(pt->pt_name);
5694 }
5695 else
5696 {
5697 pt->pt_func = ret_pt->pt_func;
5698 func_ptr_ref(pt->pt_func);
5699 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005700 if (ret_pt->pt_argc > 0)
5701 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005702 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005703 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005704 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005705 pt->pt_argc = 0;
5706 else
5707 {
5708 pt->pt_argc = ret_pt->pt_argc;
5709 for (i = 0; i < pt->pt_argc; i++)
5710 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5711 }
5712 }
5713 partial_unref(ret_pt);
5714 }
5715 rettv->v_type = VAR_PARTIAL;
5716 rettv->vval.v_partial = pt;
5717 }
5718 }
5719 return selfdict;
5720}
5721
5722/*
5723 * Return the name of the executed function.
5724 */
5725 char_u *
5726func_name(void *cookie)
5727{
5728 return ((funccall_T *)cookie)->func->uf_name;
5729}
5730
5731/*
5732 * Return the address holding the next breakpoint line for a funccall cookie.
5733 */
5734 linenr_T *
5735func_breakpoint(void *cookie)
5736{
5737 return &((funccall_T *)cookie)->breakpoint;
5738}
5739
5740/*
5741 * Return the address holding the debug tick for a funccall cookie.
5742 */
5743 int *
5744func_dbg_tick(void *cookie)
5745{
5746 return &((funccall_T *)cookie)->dbg_tick;
5747}
5748
5749/*
5750 * Return the nesting level for a funccall cookie.
5751 */
5752 int
5753func_level(void *cookie)
5754{
5755 return ((funccall_T *)cookie)->level;
5756}
5757
5758/*
5759 * Return TRUE when a function was ended by a ":return" command.
5760 */
5761 int
5762current_func_returned(void)
5763{
5764 return current_funccal->returned;
5765}
5766
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005767 int
5768free_unref_funccal(int copyID, int testing)
5769{
5770 int did_free = FALSE;
5771 int did_free_funccal = FALSE;
5772 funccall_T *fc, **pfc;
5773
5774 for (pfc = &previous_funccal; *pfc != NULL; )
5775 {
5776 if (can_free_funccal(*pfc, copyID))
5777 {
5778 fc = *pfc;
5779 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005780 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005781 did_free = TRUE;
5782 did_free_funccal = TRUE;
5783 }
5784 else
5785 pfc = &(*pfc)->caller;
5786 }
5787 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005788 // When a funccal was freed some more items might be garbage
5789 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005790 (void)garbage_collect(testing);
5791
5792 return did_free;
5793}
5794
5795/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005796 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005797 */
5798 static funccall_T *
5799get_funccal(void)
5800{
5801 int i;
5802 funccall_T *funccal;
5803 funccall_T *temp_funccal;
5804
5805 funccal = current_funccal;
5806 if (debug_backtrace_level > 0)
5807 {
5808 for (i = 0; i < debug_backtrace_level; i++)
5809 {
5810 temp_funccal = funccal->caller;
5811 if (temp_funccal)
5812 funccal = temp_funccal;
5813 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005814 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005815 debug_backtrace_level = i;
5816 }
5817 }
5818 return funccal;
5819}
5820
5821/*
5822 * Return the hashtable used for local variables in the current funccal.
5823 * Return NULL if there is no current funccal.
5824 */
5825 hashtab_T *
5826get_funccal_local_ht()
5827{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005828 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005829 return NULL;
5830 return &get_funccal()->l_vars.dv_hashtab;
5831}
5832
5833/*
5834 * Return the l: scope variable.
5835 * Return NULL if there is no current funccal.
5836 */
5837 dictitem_T *
5838get_funccal_local_var()
5839{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005840 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005841 return NULL;
5842 return &get_funccal()->l_vars_var;
5843}
5844
5845/*
5846 * Return the hashtable used for argument in the current funccal.
5847 * Return NULL if there is no current funccal.
5848 */
5849 hashtab_T *
5850get_funccal_args_ht()
5851{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005852 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005853 return NULL;
5854 return &get_funccal()->l_avars.dv_hashtab;
5855}
5856
5857/*
5858 * Return the a: scope variable.
5859 * Return NULL if there is no current funccal.
5860 */
5861 dictitem_T *
5862get_funccal_args_var()
5863{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005864 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005865 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005866 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005867}
5868
5869/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005870 * List function variables, if there is a function.
5871 */
5872 void
5873list_func_vars(int *first)
5874{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005875 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005876 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005877 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005878}
5879
5880/*
5881 * If "ht" is the hashtable for local variables in the current funccal, return
5882 * the dict that contains it.
5883 * Otherwise return NULL.
5884 */
5885 dict_T *
5886get_current_funccal_dict(hashtab_T *ht)
5887{
5888 if (current_funccal != NULL
5889 && ht == &current_funccal->l_vars.dv_hashtab)
5890 return &current_funccal->l_vars;
5891 return NULL;
5892}
5893
5894/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005895 * Search hashitem in parent scope.
5896 */
5897 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005898find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005899{
5900 funccall_T *old_current_funccal = current_funccal;
5901 hashtab_T *ht;
5902 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005903 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005904
5905 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5906 return NULL;
5907
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005908 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005909 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005910 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005911 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005912 ht = find_var_ht(name, &varname);
5913 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005914 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005915 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005916 if (!HASHITEM_EMPTY(hi))
5917 {
5918 *pht = ht;
5919 break;
5920 }
5921 }
5922 if (current_funccal == current_funccal->func->uf_scoped)
5923 break;
5924 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005925 }
5926 current_funccal = old_current_funccal;
5927
5928 return hi;
5929}
5930
5931/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005932 * Search variable in parent scope.
5933 */
5934 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005935find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005936{
5937 dictitem_T *v = NULL;
5938 funccall_T *old_current_funccal = current_funccal;
5939 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005940 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005941
5942 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5943 return NULL;
5944
Bram Moolenaare38eab22019-12-05 21:50:01 +01005945 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005946 current_funccal = current_funccal->func->uf_scoped;
5947 while (current_funccal)
5948 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005949 ht = find_var_ht(name, &varname);
5950 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005951 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005952 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005953 if (v != NULL)
5954 break;
5955 }
5956 if (current_funccal == current_funccal->func->uf_scoped)
5957 break;
5958 current_funccal = current_funccal->func->uf_scoped;
5959 }
5960 current_funccal = old_current_funccal;
5961
5962 return v;
5963}
5964
5965/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005966 * Set "copyID + 1" in previous_funccal and callers.
5967 */
5968 int
5969set_ref_in_previous_funccal(int copyID)
5970{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005971 funccall_T *fc;
5972
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005973 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005974 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005975 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005976 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5977 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5978 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5979 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005980 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005981 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005982}
5983
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005984 static int
5985set_ref_in_funccal(funccall_T *fc, int copyID)
5986{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005987 if (fc->fc_copyID != copyID)
5988 {
5989 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005990 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5991 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5992 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5993 || set_ref_in_func(NULL, fc->func, copyID))
5994 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005995 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02005996 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005997}
5998
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005999/*
6000 * Set "copyID" in all local vars and arguments in the call stack.
6001 */
6002 int
6003set_ref_in_call_stack(int copyID)
6004{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006005 funccall_T *fc;
6006 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006007
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006008 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6009 if (set_ref_in_funccal(fc, copyID))
6010 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006011
6012 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006013 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6014 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6015 if (set_ref_in_funccal(fc, copyID))
6016 return TRUE;
6017 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006018}
6019
6020/*
6021 * Set "copyID" in all functions available by name.
6022 */
6023 int
6024set_ref_in_functions(int copyID)
6025{
6026 int todo;
6027 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006028 ufunc_T *fp;
6029
6030 todo = (int)func_hashtab.ht_used;
6031 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006032 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006033 if (!HASHITEM_EMPTY(hi))
6034 {
6035 --todo;
6036 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006037 if (!func_name_refcount(fp->uf_name)
6038 && set_ref_in_func(NULL, fp, copyID))
6039 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006040 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006041 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006042 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006043}
6044
6045/*
6046 * Set "copyID" in all function arguments.
6047 */
6048 int
6049set_ref_in_func_args(int copyID)
6050{
6051 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006052
6053 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006054 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6055 copyID, NULL, NULL))
6056 return TRUE;
6057 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006058}
6059
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006060/*
6061 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006062 * Returns TRUE if setting references failed somehow.
6063 */
6064 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006065set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006066{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006067 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006068 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006069 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006070 char_u fname_buf[FLEN_FIXED + 1];
6071 char_u *tofree = NULL;
6072 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006073 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006074
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006075 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006076 return FALSE;
6077
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006078 if (fp_in == NULL)
6079 {
6080 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006081 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006082 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006083 if (fp != NULL)
6084 {
6085 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006086 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006087 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006088
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006089 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006090 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006091}
6092
Bram Moolenaare38eab22019-12-05 21:50:01 +01006093#endif // FEAT_EVAL