blob: f3ba7719ce8d0d0c103c2e0208ca59ff97303c6c [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020035
36 void
37func_init()
38{
39 hash_init(&func_hashtab);
40}
41
Dominique Pelle748b3082022-01-08 12:41:16 +000042#if defined(FEAT_PROFILE) || defined(PROTO)
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020043/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020044 * Return the function hash table
45 */
46 hashtab_T *
47func_tbl_get(void)
48{
49 return &func_hashtab;
50}
Dominique Pelle748b3082022-01-08 12:41:16 +000051#endif
Bram Moolenaar660a10a2019-07-14 15:48:38 +020052
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaardce24412022-02-08 20:35:30 +000058 * If "eap" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaardce24412022-02-08 20:35:30 +000069 exarg_T *eap,
Bram Moolenaar2a389082021-04-09 20:24:31 +020070 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010071 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072{
Bram Moolenaar6e949782020-04-13 17:21:00 +020073 char_u *p = arg;
74 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020075 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010076
77 while (ASCII_ISALNUM(*p) || *p == '_')
78 ++p;
79 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020080 || (argtypes == NULL
81 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
82 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010083 {
84 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000085 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 return arg;
87 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010088
Bram Moolenaar057e84a2021-02-28 16:55:11 +010089 // Vim9 script: cannot use script var name for argument. In function: also
90 // check local vars and arguments.
91 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
Bram Moolenaardce24412022-02-08 20:35:30 +000092 evalarg == NULL ? NULL : evalarg->eval_cctx,
93 eap == NULL ? NULL : eap->cstack, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000117 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000172 * Get a next line, store it in "eap" if appropriate and put the line in
173 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000174 */
175 static char_u *
176get_function_line(
177 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000178 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000179 int indent,
180 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000181{
182 char_u *theline;
183
184 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000185 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000186 else
187 theline = eap->getline(':', eap->cookie, indent, getline_options);
188 if (theline != NULL)
189 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000190 if (lines_to_free->ga_len > 0
191 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
192 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000193 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000194 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000195 }
196
197 return theline;
198}
199
200/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100203 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200204 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100205 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206get_function_args(
207 char_u **argp,
208 char_u endchar,
209 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100210 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100211 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100212 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200213 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200214 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200215 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000216 exarg_T *eap, // can be NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000217 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200218{
219 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100220 char_u *arg;
221 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200223 int any_default = FALSE;
224 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100225 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200226
227 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000228 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100229 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000230 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200231 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000232 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200233
234 if (varargs != NULL)
235 *varargs = FALSE;
236
237 /*
238 * Isolate the arguments: "arg1, arg2, ...)"
239 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100240 arg = skipwhite(*argp);
241 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200242 while (*p != endchar)
243 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200244 while (eap != NULL && eap->getline != NULL
245 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200246 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200247 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000248 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000249 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000250
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 if (theline == NULL)
252 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200253 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200254 p = skipwhite(theline);
255 }
256
257 if (mustend && *p != endchar)
258 {
259 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000260 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100261 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200262 }
263 if (*p == endchar)
264 break;
265
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
267 {
268 if (varargs != NULL)
269 *varargs = TRUE;
270 p += 3;
271 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272
273 if (argtypes != NULL)
274 {
275 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200276 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100278 if (!skip)
279 emsg(_(e_missing_name_after_dots));
280 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100281 }
282
283 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100284 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000285 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100286 if (p == arg)
287 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100288 if (*skipwhite(p) == '=')
289 {
290 emsg(_(e_cannot_use_default_for_variable_arguments));
291 break;
292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 }
295 else
296 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200297 char_u *np;
298
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200299 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100300 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000301 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200303 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304
Bram Moolenaar015cf102021-06-26 21:52:02 +0200305 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200306 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200307 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200308 if (*np == '=' && np[1] != '=' && np[1] != '~'
309 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 {
311 typval_T rettv;
312
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100313 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 any_default = TRUE;
315 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200316 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 p = skipwhite(p);
318 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200319 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200320 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200321 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200323 if (ga_grow(default_args, 1) == FAIL)
324 goto err_ret;
325
326 // trim trailing whitespace
327 while (p > expr && VIM_ISWHITE(p[-1]))
328 p--;
329 c = *p;
330 *p = NUL;
331 expr = vim_strsave(expr);
332 if (expr == NULL)
333 {
334 *p = c;
335 goto err_ret;
336 }
337 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200338 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200339 default_args->ga_len++;
340 *p = c;
341 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200342 }
343 else
344 mustend = TRUE;
345 }
346 else if (any_default)
347 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000348 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200349 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200350 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200351
352 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
353 {
354 // Be tolerant when skipping
355 if (!skip)
356 {
357 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
358 goto err_ret;
359 }
360 p = skipwhite(p);
361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200363 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200364 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200365 // Don't give this error when skipping, it makes the "->" not
366 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100367 // Allow missing space after comma in legacy functions.
368 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
370 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100371 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200372 goto err_ret;
373 }
374 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200375 else
376 mustend = TRUE;
377 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200378 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200379 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200380 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200381
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200382 if (*p != endchar)
383 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100384 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200385
386 *argp = p;
387 return OK;
388
389err_ret:
390 if (newargs != NULL)
391 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200392 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200393 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200394 return FAIL;
395}
396
397/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100398 * Parse the argument types, filling "fp->uf_arg_types".
399 * Return OK or FAIL.
400 */
401 static int
402parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
403{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200404 int len = 0;
405
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
407 if (argtypes->ga_len > 0)
408 {
409 // When "varargs" is set the last name/type goes into uf_va_name
410 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200411 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100412
413 if (len > 0)
414 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
415 if (fp->uf_arg_types != NULL)
416 {
417 int i;
418 type_T *type;
419
420 for (i = 0; i < len; ++ i)
421 {
422 char_u *p = ((char_u **)argtypes->ga_data)[i];
423
424 if (p == NULL)
425 // will get the type from the default value
426 type = &t_unknown;
427 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100428 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100429 if (type == NULL)
430 return FAIL;
431 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000432 if (i < fp->uf_args.ga_len
433 && (type->tt_type == VAR_FUNC
434 || type->tt_type == VAR_PARTIAL)
435 && var_wrong_func_name(
436 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
437 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100438 }
439 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100440 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200441
442 if (varargs)
443 {
444 char_u *p;
445
446 // Move the last argument "...name: type" to uf_va_name and
447 // uf_va_type.
448 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
449 [fp->uf_args.ga_len - 1];
450 --fp->uf_args.ga_len;
451 p = ((char_u **)argtypes->ga_data)[len];
452 if (p == NULL)
453 // TODO: get type from default value
454 fp->uf_va_type = &t_list_any;
455 else
456 {
457 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
458 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
459 {
460 semsg(_(e_variable_arguments_type_must_be_list_str),
461 ((char_u **)argtypes->ga_data)[len]);
462 return FAIL;
463 }
464 }
465 if (fp->uf_va_type == NULL)
466 return FAIL;
467 }
468
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100469 return OK;
470}
471
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100472 static int
473parse_return_type(ufunc_T *fp, char_u *ret_type)
474{
475 if (ret_type == NULL)
476 fp->uf_ret_type = &t_void;
477 else
478 {
479 char_u *p = ret_type;
480
481 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
482 if (fp->uf_ret_type == NULL)
483 {
484 fp->uf_ret_type = &t_void;
485 return FAIL;
486 }
487 }
488 return OK;
489}
490
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100491/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200492 * Register function "fp" as using "current_funccal" as its scope.
493 */
494 static int
495register_closure(ufunc_T *fp)
496{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100498 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200499 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200500 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200501 fp->uf_scoped = current_funccal;
502 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200503
Bram Moolenaar58016442016-07-31 18:30:22 +0200504 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
505 return FAIL;
506 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
507 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200508 return OK;
509}
510
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100511 static void
512set_ufunc_name(ufunc_T *fp, char_u *name)
513{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100514 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
515 // actually extends beyond the struct.
516 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100517
518 if (name[0] == K_SPECIAL)
519 {
520 fp->uf_name_exp = alloc(STRLEN(name) + 3);
521 if (fp->uf_name_exp != NULL)
522 {
523 STRCPY(fp->uf_name_exp, "<SNR>");
524 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
525 }
526 }
527}
528
Bram Moolenaar58016442016-07-31 18:30:22 +0200529/*
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100530 * If "name" starts with K_SPECIAL and "buf[bufsize]" is big enough
531 * return "buf" filled with a readable function name.
532 * Otherwise just return "name", thus the return value can always be used.
533 * "name" and "buf" may be equal.
534 */
535 char_u *
536make_ufunc_name_readable(char_u *name, char_u *buf, size_t bufsize)
537{
538 size_t len;
539
540 if (name[0] != K_SPECIAL)
541 return name;
542 len = STRLEN(name);
543 if (len + 3 > bufsize)
544 return name;
545
Bram Moolenaar96e08e02022-03-31 21:40:33 +0100546 mch_memmove(buf + 5, name + 3, len - 2); // Include trailing NUL
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100547 mch_memmove(buf, "<SNR>", 5);
548 return buf;
549}
550
551/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200552 * Get a name for a lambda. Returned in static memory.
553 */
554 char_u *
555get_lambda_name(void)
556{
557 static char_u name[30];
558 static int lambda_no = 0;
559
560 sprintf((char*)name, "<lambda>%d", ++lambda_no);
561 return name;
562}
563
Bram Moolenaar801ab062020-06-25 19:27:56 +0200564#if defined(FEAT_LUA) || defined(PROTO)
565/*
566 * Registers a native C callback which can be called from Vim script.
567 * Returns the name of the Vim script function.
568 */
569 char_u *
570register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
571{
572 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200573 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200574
575 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
576 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200577 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200578
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200579 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200580 fp->uf_refcount = 1;
581 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000582 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200583 fp->uf_calls = 0;
584 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200585 fp->uf_cb = cb;
586 fp->uf_cb_free = cb_free;
587 fp->uf_cb_state = state;
588
589 set_ufunc_name(fp, name);
590 hash_add(&func_hashtab, UF2HIKEY(fp));
591
592 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200593}
594#endif
595
Bram Moolenaar04b12692020-05-04 23:24:44 +0200596/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100597 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100598 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100599 * If "white_error" is not NULL check for correct use of white space and set
600 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100601 * Return NULL if no valid arrow found.
602 */
603 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100604skip_arrow(
605 char_u *start,
606 int equal_arrow,
607 char_u **ret_type,
608 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100609{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100610 char_u *s = start;
611 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100612
613 if (equal_arrow)
614 {
615 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100616 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100617 if (white_error != NULL && !VIM_ISWHITE(s[1]))
618 {
619 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100620 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100621 return NULL;
622 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100623 s = skipwhite(s + 1);
624 *ret_type = s;
625 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100626 if (s == *ret_type)
627 {
628 emsg(_(e_missing_return_type));
629 return NULL;
630 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100631 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100632 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100633 s = skipwhite(s);
634 if (*s != '=')
635 return NULL;
636 ++s;
637 }
638 if (*s != '>')
639 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100640 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
641 || !IS_WHITE_OR_NUL(s[1])))
642 {
643 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100644 semsg(_(e_white_space_required_before_and_after_str_at_str),
645 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100646 return NULL;
647 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100648 return skipwhite(s + 1);
649}
650
651/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100652 * Check if "*cmd" points to a function command and if so advance "*cmd" and
653 * return TRUE.
654 * Otherwise return FALSE;
655 * Do not consider "function(" to be a command.
656 */
657 static int
658is_function_cmd(char_u **cmd)
659{
660 char_u *p = *cmd;
661
662 if (checkforcmd(&p, "function", 2))
663 {
664 if (*p == '(')
665 return FALSE;
666 *cmd = p;
667 return TRUE;
668 }
669 return FALSE;
670}
671
672/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200673 * Called when defining a function: The context may be needed for script
674 * variables declared in a block that is visible now but not when the function
675 * is compiled or called later.
676 */
677 static void
678function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
679{
680 if (cstack != NULL && cstack->cs_idx >= 0)
681 {
682 int count = cstack->cs_idx + 1;
683 int i;
684
685 fp->uf_block_ids = ALLOC_MULT(int, count);
686 if (fp->uf_block_ids != NULL)
687 {
688 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
689 sizeof(int) * count);
690 fp->uf_block_depth = count;
691 }
692
693 // Set flag in each block to indicate a function was defined. This
694 // is used to keep the variable when leaving the block, see
695 // hide_script_var().
696 for (i = 0; i <= cstack->cs_idx; ++i)
697 cstack->cs_flags[i] |= CSF_FUNC_DEF;
698 }
699}
700
701/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100702 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200703 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100704 * "newlines" must already have been initialized.
705 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
706 */
707 static int
708get_function_body(
709 exarg_T *eap,
710 garray_T *newlines,
711 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000712 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100713{
714 linenr_T sourcing_lnum_top = SOURCING_LNUM;
715 linenr_T sourcing_lnum_off;
716 int saved_wait_return = need_wait_return;
717 char_u *line_arg = line_arg_in;
718 int vim9_function = eap->cmdidx == CMD_def
719 || eap->cmdidx == CMD_block;
720#define MAX_FUNC_NESTING 50
721 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200722 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100723 int nesting = 0;
724 getline_opt_T getline_options;
725 int indent = 2;
726 char_u *skip_until = NULL;
727 int ret = FAIL;
728 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200729 int heredoc_concat_len = 0;
730 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100731 char_u *heredoc_trimmed = NULL;
732
Bram Moolenaar20677332021-06-06 17:02:53 +0200733 ga_init2(&heredoc_ga, 1, 500);
734
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100735 // Detect having skipped over comment lines to find the return
736 // type. Add NULL lines to keep the line count correct.
737 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
738 if (SOURCING_LNUM < sourcing_lnum_off)
739 {
740 sourcing_lnum_off -= SOURCING_LNUM;
741 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
742 goto theend;
743 while (sourcing_lnum_off-- > 0)
744 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
745 }
746
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200747 nesting_def[0] = vim9_function;
748 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100749 getline_options = vim9_function
750 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
751 for (;;)
752 {
753 char_u *theline;
754 char_u *p;
755 char_u *arg;
756
757 if (KeyTyped)
758 {
759 msg_scroll = TRUE;
760 saved_wait_return = FALSE;
761 }
762 need_wait_return = FALSE;
763
764 if (line_arg != NULL)
765 {
766 // Use eap->arg, split up in parts by line breaks.
767 theline = line_arg;
768 p = vim_strchr(theline, '\n');
769 if (p == NULL)
770 line_arg += STRLEN(line_arg);
771 else
772 {
773 *p = NUL;
774 line_arg = p + 1;
775 }
776 }
777 else
778 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000779 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100780 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100781 }
782 if (KeyTyped)
783 lines_left = Rows - 1;
784 if (theline == NULL)
785 {
786 // Use the start of the function for the line number.
787 SOURCING_LNUM = sourcing_lnum_top;
788 if (skip_until != NULL)
789 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200790 else if (nesting_inline[nesting])
791 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100792 else if (eap->cmdidx == CMD_def)
793 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000795 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100796 goto theend;
797 }
798
799 // Detect line continuation: SOURCING_LNUM increased more than one.
800 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
801 if (SOURCING_LNUM < sourcing_lnum_off)
802 sourcing_lnum_off -= SOURCING_LNUM;
803 else
804 sourcing_lnum_off = 0;
805
806 if (skip_until != NULL)
807 {
808 // Don't check for ":endfunc"/":enddef" between
809 // * ":append" and "."
810 // * ":python <<EOF" and "EOF"
811 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
812 if (heredoc_trimmed == NULL
813 || (is_heredoc && skipwhite(theline) == theline)
814 || STRNCMP(theline, heredoc_trimmed,
815 STRLEN(heredoc_trimmed)) == 0)
816 {
817 if (heredoc_trimmed == NULL)
818 p = theline;
819 else if (is_heredoc)
820 p = skipwhite(theline) == theline
821 ? theline : theline + STRLEN(heredoc_trimmed);
822 else
823 p = theline + STRLEN(heredoc_trimmed);
824 if (STRCMP(p, skip_until) == 0)
825 {
826 VIM_CLEAR(skip_until);
827 VIM_CLEAR(heredoc_trimmed);
828 getline_options = vim9_function
829 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
830 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200831
832 if (heredoc_concat_len > 0)
833 {
834 // Replace the starting line with all the concatenated
835 // lines.
836 ga_concat(&heredoc_ga, theline);
837 vim_free(((char_u **)(newlines->ga_data))[
838 heredoc_concat_len - 1]);
839 ((char_u **)(newlines->ga_data))[
840 heredoc_concat_len - 1] = heredoc_ga.ga_data;
841 ga_init(&heredoc_ga);
842 heredoc_concat_len = 0;
843 theline += STRLEN(theline); // skip the "EOF"
844 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100845 }
846 }
847 }
848 else
849 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200850 int c;
851 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000852 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100853
854 // skip ':' and blanks
855 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
856 ;
857
858 // Check for "endfunction", "enddef" or "}".
859 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000860 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200861 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100862 ? *p == '}'
863 : (checkforcmd(&p, nesting_def[nesting]
864 ? "enddef" : "endfunction", 4)
865 && *p != ':'))
866 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000867 if (!nesting_inline[nesting] && nesting_def[nesting]
868 && p < cmd + 6)
869 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100870 if (nesting-- == 0)
871 {
872 char_u *nextcmd = NULL;
873
874 if (*p == '|' || *p == '}')
875 nextcmd = p + 1;
876 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
877 nextcmd = line_arg;
878 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100879 && (vim9_function || p_verbose > 0))
880 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200881 SOURCING_LNUM = sourcing_lnum_top
882 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100883 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000884 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100885 else
886 give_warning2((char_u *)
887 _("W22: Text found after :endfunction: %s"),
888 p, TRUE);
889 }
890 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100891 {
892 // Another command follows. If the line came from "eap"
893 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000894 // change "eap->cmdlinep" to point to the last fetched
895 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100896 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000897 if (lines_to_free->ga_len > 0
898 && *eap->cmdlinep !=
899 ((char_u **)lines_to_free->ga_data)
900 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100901 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000902 // *cmdlinep will be freed later, thus remove the
903 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100904 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000905 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
906 [lines_to_free->ga_len - 1];
907 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100908 }
909 }
910 break;
911 }
912 }
913
914 // Check for mismatched "endfunc" or "enddef".
915 // We don't check for "def" inside "func" thus we also can't check
916 // for "enddef".
917 // We continue to find the end of the function, although we might
918 // not find it.
919 else if (nesting_def[nesting])
920 {
921 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
922 emsg(_(e_mismatched_endfunction));
923 }
924 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
925 emsg(_(e_mismatched_enddef));
926
927 // Increase indent inside "if", "while", "for" and "try", decrease
928 // at "end".
929 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
930 indent -= 2;
931 else if (STRNCMP(p, "if", 2) == 0
932 || STRNCMP(p, "wh", 2) == 0
933 || STRNCMP(p, "for", 3) == 0
934 || STRNCMP(p, "try", 3) == 0)
935 indent += 2;
936
937 // Check for defining a function inside this function.
938 // Only recognize "def" inside "def", not inside "function",
939 // For backwards compatibility, see Test_function_python().
940 c = *p;
941 if (is_function_cmd(&p)
942 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
943 {
944 if (*p == '!')
945 p = skipwhite(p + 1);
946 p += eval_fname_script(p);
947 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
948 NULL, NULL));
949 if (*skipwhite(p) == '(')
950 {
951 if (nesting == MAX_FUNC_NESTING - 1)
952 emsg(_(e_function_nesting_too_deep));
953 else
954 {
955 ++nesting;
956 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200957 nesting_inline[nesting] = FALSE;
958 indent += 2;
959 }
960 }
961 }
962
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200963 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200964 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200965 // Not a comment line: check for nested inline function.
966 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200967 while (end > p && VIM_ISWHITE(*end))
968 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200969 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200970 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200971 int is_block;
972
973 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200974 --end;
975 while (end > p && VIM_ISWHITE(*end))
976 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200977 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
978 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200979 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200980 char_u *s = p;
981
982 // check for line starting with "au" for :autocmd or
983 // "com" for :command, these can use a {} block
984 is_block = checkforcmd_noparen(&s, "autocmd", 2)
985 || checkforcmd_noparen(&s, "command", 3);
986 }
987
988 if (is_block)
989 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200990 if (nesting == MAX_FUNC_NESTING - 1)
991 emsg(_(e_function_nesting_too_deep));
992 else
993 {
994 ++nesting;
995 nesting_def[nesting] = TRUE;
996 nesting_inline[nesting] = TRUE;
997 indent += 2;
998 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100999 }
1000 }
1001 }
1002
1003 // Check for ":append", ":change", ":insert". Not for :def.
1004 p = skip_range(p, FALSE, NULL);
1005 if (!vim9_function
1006 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1007 || (p[0] == 'c'
1008 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1009 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1010 && (STRNCMP(&p[3], "nge", 3) != 0
1011 || !ASCII_ISALPHA(p[6])))))))
1012 || (p[0] == 'i'
1013 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1014 && (!ASCII_ISALPHA(p[2])
1015 || (p[2] == 's'
1016 && (!ASCII_ISALPHA(p[3])
1017 || p[3] == 'e'))))))))
1018 skip_until = vim_strsave((char_u *)".");
1019
1020 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1021 arg = skipwhite(skiptowhite(p));
1022 if (arg[0] == '<' && arg[1] =='<'
1023 && ((p[0] == 'p' && p[1] == 'y'
1024 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1025 || ((p[2] == '3' || p[2] == 'x')
1026 && !ASCII_ISALPHA(p[3]))))
1027 || (p[0] == 'p' && p[1] == 'e'
1028 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1029 || (p[0] == 't' && p[1] == 'c'
1030 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1031 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1032 && !ASCII_ISALPHA(p[3]))
1033 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1034 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1035 || (p[0] == 'm' && p[1] == 'z'
1036 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1037 ))
1038 {
1039 // ":python <<" continues until a dot, like ":append"
1040 p = skipwhite(arg + 2);
1041 if (STRNCMP(p, "trim", 4) == 0)
1042 {
1043 // Ignore leading white space.
1044 p = skipwhite(p + 4);
1045 heredoc_trimmed = vim_strnsave(theline,
1046 skipwhite(theline) - theline);
1047 }
1048 if (*p == NUL)
1049 skip_until = vim_strsave((char_u *)".");
1050 else
1051 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1052 getline_options = GETLINE_NONE;
1053 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001054 if (eap->cmdidx == CMD_def)
1055 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001056 }
1057
1058 // Check for ":cmd v =<< [trim] EOF"
1059 // and ":cmd [a, b] =<< [trim] EOF"
1060 // and "lines =<< [trim] EOF" for Vim9
1061 // Where "cmd" can be "let", "var", "final" or "const".
1062 arg = skipwhite(skiptowhite(p));
1063 if (*arg == '[')
1064 arg = vim_strchr(arg, ']');
1065 if (arg != NULL)
1066 {
1067 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1068 && arg[1] == '<' && arg[2] =='<');
1069
1070 if (!found)
1071 // skip over the argument after "cmd"
1072 arg = skipwhite(skiptowhite(arg));
1073 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1074 && (checkforcmd(&p, "let", 2)
1075 || checkforcmd(&p, "var", 3)
1076 || checkforcmd(&p, "final", 5)
1077 || checkforcmd(&p, "const", 5))))
1078 {
1079 p = skipwhite(arg + 3);
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001080 while (TRUE)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001081 {
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001082 if (STRNCMP(p, "trim", 4) == 0)
1083 {
1084 // Ignore leading white space.
1085 p = skipwhite(p + 4);
1086 heredoc_trimmed = vim_strnsave(theline,
1087 skipwhite(theline) - theline);
1088 continue;
1089 }
1090 if (STRNCMP(p, "eval", 4) == 0)
1091 {
1092 // Ignore leading white space.
1093 p = skipwhite(p + 4);
1094 continue;
1095 }
1096 break;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001097 }
1098 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1099 getline_options = GETLINE_NONE;
1100 is_heredoc = TRUE;
1101 }
1102 }
1103 }
1104
1105 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001106 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001107 goto theend;
1108
Bram Moolenaar20677332021-06-06 17:02:53 +02001109 if (heredoc_concat_len > 0)
1110 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001111 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001112 // to be used for the instruction later.
1113 ga_concat(&heredoc_ga, theline);
1114 ga_concat(&heredoc_ga, (char_u *)"\n");
1115 p = vim_strsave((char_u *)"");
1116 }
1117 else
1118 {
1119 // Copy the line to newly allocated memory. get_one_sourceline()
1120 // allocates 250 bytes per line, this saves 80% on average. The
1121 // cost is an extra alloc/free.
1122 p = vim_strsave(theline);
1123 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001124 if (p == NULL)
1125 goto theend;
1126 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1127
1128 // Add NULL lines for continuation lines, so that the line count is
1129 // equal to the index in the growarray.
1130 while (sourcing_lnum_off-- > 0)
1131 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1132
1133 // Check for end of eap->arg.
1134 if (line_arg != NULL && *line_arg == NUL)
1135 line_arg = NULL;
1136 }
1137
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001138 // Return OK when no error was detected.
1139 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001140 ret = OK;
1141
1142theend:
1143 vim_free(skip_until);
1144 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001145 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001146 need_wait_return |= saved_wait_return;
1147 return ret;
1148}
1149
1150/*
1151 * Handle the body of a lambda. *arg points to the "{", process statements
1152 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001153 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001154 * When successful "rettv" is set to a funcref.
1155 */
1156 static int
1157lambda_function_body(
1158 char_u **arg,
1159 typval_T *rettv,
1160 evalarg_T *evalarg,
1161 garray_T *newargs,
1162 garray_T *argtypes,
1163 int varargs,
1164 garray_T *default_args,
1165 char_u *ret_type)
1166{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001167 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001168 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001169 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001170 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001171 exarg_T eap;
1172 garray_T newlines;
1173 char_u *cmdline = NULL;
1174 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001175 partial_T *pt;
1176 char_u *name;
1177 int lnum_save = -1;
1178 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1179
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001180 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1181 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001182 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001183 return FAIL;
1184 }
1185
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001186 CLEAR_FIELD(eap);
1187 eap.cmdidx = CMD_block;
1188 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001189 eap.cmdlinep = &cmdline;
1190 eap.skip = !evaluate;
1191 if (evalarg->eval_cctx != NULL)
1192 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1193 else
1194 {
1195 eap.getline = evalarg->eval_getline;
1196 eap.cookie = evalarg->eval_cookie;
1197 }
1198
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001199 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001200 if (get_function_body(&eap, &newlines, NULL,
1201 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001202 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001203
1204 // When inside a lambda must add the function lines to evalarg.eval_ga.
1205 evalarg->eval_break_count += newlines.ga_len;
1206 if (gap->ga_itemsize > 0)
1207 {
1208 int idx;
1209 char_u *last;
1210 size_t plen;
1211 char_u *pnl;
1212
1213 for (idx = 0; idx < newlines.ga_len; ++idx)
1214 {
1215 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1216
Bram Moolenaarecb66452021-05-18 15:09:18 +02001217 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001218 goto erret;
1219
1220 // Going to concatenate the lines after parsing. For an empty or
1221 // comment line use an empty string.
1222 // Insert NL characters at the start of each line, the string will
1223 // be split again later in .get_lambda_tv().
1224 if (*p == NUL || vim9_comment_start(p))
1225 p = (char_u *)"";
1226 plen = STRLEN(p);
1227 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1228 if (pnl != NULL)
1229 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001230 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1231 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001232 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001233 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001234 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001235 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 // more is following after the "}", which was skipped
1237 last = cmdline;
1238 else
1239 // nothing is following the "}"
1240 last = (char_u *)"}";
1241 plen = STRLEN(last);
1242 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1243 if (pnl != NULL)
1244 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001245 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1246 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001247 }
1248
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001249 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001250 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001251 garray_T *tfgap = &evalarg->eval_tofree_ga;
1252
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001253 // Something comes after the "}".
1254 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001255
1256 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001257 if (ga_grow(tfgap, 1) == OK)
1258 {
1259 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1260 evalarg->eval_using_cmdline = TRUE;
1261 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001262 }
1263 else
1264 *arg = (char_u *)"";
1265
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001266 if (!evaluate)
1267 {
1268 ret = OK;
1269 goto erret;
1270 }
1271
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001272 name = get_lambda_name();
1273 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1274 if (ufunc == NULL)
1275 goto erret;
1276 set_ufunc_name(ufunc, name);
1277 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001278 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001279 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001280 ufunc->uf_refcount = 1;
1281 ufunc->uf_args = *newargs;
1282 newargs->ga_data = NULL;
1283 ufunc->uf_def_args = *default_args;
1284 default_args->ga_data = NULL;
1285 ufunc->uf_func_type = &t_func_any;
1286
1287 // error messages are for the first function line
1288 lnum_save = SOURCING_LNUM;
1289 SOURCING_LNUM = sourcing_lnum_top;
1290
1291 // parse argument types
1292 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1293 {
1294 SOURCING_LNUM = lnum_save;
1295 goto erret;
1296 }
1297
1298 // parse the return type, if any
1299 if (parse_return_type(ufunc, ret_type) == FAIL)
1300 goto erret;
1301
1302 pt = ALLOC_CLEAR_ONE(partial_T);
1303 if (pt == NULL)
1304 goto erret;
1305 pt->pt_func = ufunc;
1306 pt->pt_refcount = 1;
1307
1308 ufunc->uf_lines = newlines;
1309 newlines.ga_data = NULL;
1310 if (sandbox)
1311 ufunc->uf_flags |= FC_SANDBOX;
1312 if (!ASCII_ISUPPER(*ufunc->uf_name))
1313 ufunc->uf_flags |= FC_VIM9;
1314 ufunc->uf_script_ctx = current_sctx;
1315 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1316 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1317 set_function_type(ufunc);
1318
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001319 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1320
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001321 rettv->vval.v_partial = pt;
1322 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001323 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001324 ret = OK;
1325
1326erret:
1327 if (lnum_save >= 0)
1328 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001329 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001330 if (newargs != NULL)
1331 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001332 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001333 if (ufunc != NULL)
1334 {
1335 func_clear(ufunc, TRUE);
1336 func_free(ufunc, TRUE);
1337 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001338 return ret;
1339}
1340
1341/*
1342 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001343 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001344 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001345 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1346 */
1347 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001348get_lambda_tv(
1349 char_u **arg,
1350 typval_T *rettv,
1351 int types_optional,
1352 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001353{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001354 int evaluate = evalarg != NULL
1355 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356 garray_T newargs;
1357 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001358 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001359 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001360 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001361 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001362 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001364 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001366 char_u *s;
1367 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001368 int *old_eval_lavars = eval_lavars_used;
1369 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001370 char_u *tofree1 = NULL;
1371 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001372 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001373 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001374 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001375 int vim9script = in_vim9script();
Bram Moolenaar65c44152020-12-24 15:14:01 +01001376
Bram Moolenaar4525a572022-02-13 11:57:33 +00001377 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001378 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379
1380 ga_init(&newargs);
1381 ga_init(&newlines);
1382
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001383 // First, check if this is really a lambda expression. "->" or "=>" must
1384 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001385 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001386 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001387 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001388 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001389 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001390 {
1391 if (types_optional)
1392 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001393 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001394 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001395
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001396 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001397 if (evaluate)
1398 pnewargs = &newargs;
1399 else
1400 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001401 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001402 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001403 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001404 &varargs, &default_args,
1405 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001406 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001407 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001408 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001409 {
1410 if (types_optional)
1411 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001412 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001413 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001414 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001415 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001416
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001417 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1418 if (ret_type != NULL)
1419 {
1420 ret_type = vim_strsave(ret_type);
1421 tofree2 = ret_type;
1422 }
1423
Bram Moolenaare38eab22019-12-05 21:50:01 +01001424 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001425 if (evaluate)
1426 eval_lavars_used = &eval_lavars;
1427
Bram Moolenaar65c44152020-12-24 15:14:01 +01001428 *arg = skipwhite_and_linebreak(*arg, evalarg);
1429
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001430 // Recognize "{" as the start of a function body.
1431 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001432 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001433 if (evalarg == NULL)
1434 // cannot happen?
1435 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001436 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1437 types_optional ? &argtypes : NULL, varargs,
1438 &default_args, ret_type) == FAIL)
1439 goto errret;
1440 goto theend;
1441 }
1442 if (default_args.ga_len > 0)
1443 {
1444 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001445 goto errret;
1446 }
1447
Bram Moolenaare38eab22019-12-05 21:50:01 +01001448 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001449 start = *arg;
1450 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 if (ret == FAIL)
1452 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001453 if (evalarg != NULL)
1454 {
1455 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001456 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001457 evalarg->eval_tofree = NULL;
1458 }
1459
Bram Moolenaar65c44152020-12-24 15:14:01 +01001460 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001461 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001462 *arg = skipwhite_and_linebreak(*arg, evalarg);
1463 if (**arg != '}')
1464 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001465 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001466 goto errret;
1467 }
1468 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001469 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001470
1471 if (evaluate)
1472 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001473 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001474 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001475 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001476 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001477 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001478
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001479 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 if (fp == NULL)
1481 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001482 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001483 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001484 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001485 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001487 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488 if (ga_grow(&newlines, 1) == FAIL)
1489 goto errret;
1490
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001491 // If there are line breaks, we need to split up the string.
1492 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001493 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001494 line_end = end;
1495
1496 // Add "return " before the expression (or the first line).
1497 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001498 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499 if (p == NULL)
1500 goto errret;
1501 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1502 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001503 vim_strncpy(p + 7, start, line_end - start);
1504
1505 if (line_end != end)
1506 {
1507 // Add more lines, split by line breaks. Thus is used when a
1508 // lambda with { cmds } is encountered.
1509 while (*line_end == '\n')
1510 {
1511 if (ga_grow(&newlines, 1) == FAIL)
1512 goto errret;
1513 start = line_end + 1;
1514 line_end = vim_strchr(start, '\n');
1515 if (line_end == NULL)
1516 line_end = end;
1517 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1518 vim_strnsave(start, line_end - start);
1519 }
1520 }
1521
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001522 if (strstr((char *)p + 7, "a:") == NULL)
1523 // No a: variables are used for sure.
1524 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525
1526 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001527 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001529 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001530 if (types_optional)
1531 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001532 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001533 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001534 goto errret;
1535 if (ret_type != NULL)
1536 {
1537 fp->uf_ret_type = parse_type(&ret_type,
1538 &fp->uf_type_list, TRUE);
1539 if (fp->uf_ret_type == NULL)
1540 goto errret;
1541 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001542 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001543 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001544 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001545
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001546 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001547 if (current_funccal != NULL && eval_lavars)
1548 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001549 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001550 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001551 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553
1554#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555 if (prof_def_func())
1556 func_do_profile(fp);
1557#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001558 if (sandbox)
1559 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001560 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001561 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001562 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001563 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001565 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001566 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001567
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001568 function_using_block_scopes(fp, evalarg->eval_cstack);
1569
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001570 pt->pt_func = fp;
1571 pt->pt_refcount = 1;
1572 rettv->vval.v_partial = pt;
1573 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001574
1575 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001578theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001579 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001580 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001581 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001582 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001583 vim_free(tofree1);
1584 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001585 if (types_optional)
1586 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001587
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001588 return OK;
1589
1590errret:
1591 ga_clear_strings(&newargs);
1592 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001593 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001594 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001595 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001596 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001597 if (fp != NULL)
1598 vim_free(fp->uf_arg_types);
1599 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001601 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001602 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001603 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001604 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001605 vim_free(tofree1);
1606 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001607 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 return FAIL;
1609}
1610
1611/*
1612 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1613 * name it contains, otherwise return "name".
1614 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1615 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001616 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1617 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001618 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001619 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620 */
1621 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001622deref_func_name(
1623 char_u *name,
1624 int *lenp,
1625 partial_T **partialp,
1626 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001627 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001628 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001629 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001630{
1631 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001632 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001633 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001634 char_u *s = NULL;
1635 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001636 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637
1638 if (partialp != NULL)
1639 *partialp = NULL;
1640
1641 cc = name[*lenp];
1642 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001643
Bram Moolenaar71f21932022-01-07 18:20:55 +00001644 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001646 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001648 tv = &v->di_tv;
1649 }
1650 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1651 {
1652 imported_T *import;
1653 char_u *p = name;
1654 int len = *lenp;
1655
1656 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001658 p = name + 2;
1659 len -= 2;
1660 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001661 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001662
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001663 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001664 if (import != NULL)
1665 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001666 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001667 if (new_function)
1668 semsg(_(e_redefining_imported_item_str), name);
1669 else
1670 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001671 name[len] = cc;
1672 *lenp = 0;
1673 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001674 }
1675 }
1676
1677 if (tv != NULL)
1678 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001679 if (found_var != NULL)
1680 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001681 if (tv->v_type == VAR_FUNC)
1682 {
1683 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001684 {
1685 *lenp = 0;
1686 return (char_u *)""; // just in case
1687 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001688 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001689 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001690 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001692 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001694 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001695
1696 if (pt == NULL)
1697 {
1698 *lenp = 0;
1699 return (char_u *)""; // just in case
1700 }
1701 if (partialp != NULL)
1702 *partialp = pt;
1703 s = partial_name(pt);
1704 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001706
1707 if (s != NULL)
1708 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001709 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001710 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001711 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001712
1713 if (sv != NULL)
1714 *type = sv->sv_type;
1715 }
1716 return s;
1717 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718 }
1719
1720 return name;
1721}
1722
1723/*
1724 * Give an error message with a function name. Handle <SNR> things.
1725 * "ermsg" is to be passed without translation, use N_() instead of _().
1726 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001727 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001728emsg_funcname(char *ermsg, char_u *name)
1729{
Bram Moolenaar54598062022-01-13 12:05:09 +00001730 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001731
Bram Moolenaar54598062022-01-13 12:05:09 +00001732 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001734 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001735 if (p != name)
1736 vim_free(p);
1737}
1738
1739/*
1740 * Allocate a variable for the result of a function.
1741 * Return OK or FAIL.
1742 */
1743 int
1744get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001745 char_u *name, // name of the function
1746 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001747 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001748 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001749 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001750 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751{
1752 char_u *argp;
1753 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001754 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1755 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001756 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001757 int evaluate = evalarg == NULL
1758 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001759
1760 /*
1761 * Get the arguments.
1762 */
1763 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001764 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1765 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001766 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001767 // skip the '(' or ',' and possibly line breaks
1768 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1769
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001770 if (*argp == ')' || *argp == ',' || *argp == NUL)
1771 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001772 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 {
1774 ret = FAIL;
1775 break;
1776 }
1777 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001778 // The comma should come right after the argument, but this wasn't
1779 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001780 if (vim9script)
1781 {
1782 if (*argp != ',' && *skipwhite(argp) == ',')
1783 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001784 if (evaluate)
1785 semsg(_(e_no_white_space_allowed_before_str_str),
1786 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001787 ret = FAIL;
1788 break;
1789 }
1790 }
1791 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001792 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 if (*argp != ',')
1794 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001795 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1796 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001797 if (evaluate)
1798 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001799 ret = FAIL;
1800 break;
1801 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001803 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804 if (*argp == ')')
1805 ++argp;
1806 else
1807 ret = FAIL;
1808
1809 if (ret == OK)
1810 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001811 int i = 0;
1812 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813
1814 if (get_vim_var_nr(VV_TESTING))
1815 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001816 // Prepare for calling test_garbagecollect_now(), need to know
1817 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001819 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 for (i = 0; i < argcount; ++i)
1821 if (ga_grow(&funcargs, 1) == OK)
1822 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1823 &argvars[i];
1824 }
1825
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001826 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001827 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001828 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001829 // An error in a builtin function does not return FAIL, but we do
1830 // want to abort further processing if an error was given.
1831 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001832 clear_tv(rettv);
1833 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834
1835 funcargs.ga_len -= i;
1836 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001837 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 {
1839 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001840 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001842 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 }
1844
1845 while (--argcount >= 0)
1846 clear_tv(&argvars[argcount]);
1847
Bram Moolenaar4525a572022-02-13 11:57:33 +00001848 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001849 *arg = argp;
1850 else
1851 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001852 return ret;
1853}
1854
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855/*
1856 * Return TRUE if "p" starts with "<SID>" or "s:".
1857 * Only works if eval_fname_script() returned non-zero for "p"!
1858 */
1859 static int
1860eval_fname_sid(char_u *p)
1861{
1862 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1863}
1864
1865/*
1866 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1867 * Change <SNR>123_name() to K_SNR 123_name().
1868 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1869 * (slow).
1870 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001871 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001872fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1873{
1874 int llen;
1875 char_u *fname;
1876 int i;
1877
1878 llen = eval_fname_script(name);
1879 if (llen > 0)
1880 {
1881 fname_buf[0] = K_SPECIAL;
1882 fname_buf[1] = KS_EXTRA;
1883 fname_buf[2] = (int)KE_SNR;
1884 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001885 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001886 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001887 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001888 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001889 else
1890 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001891 sprintf((char *)fname_buf + 3, "%ld_",
1892 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001893 i = (int)STRLEN(fname_buf);
1894 }
1895 }
1896 if (i + STRLEN(name + llen) < FLEN_FIXED)
1897 {
1898 STRCPY(fname_buf + i, name + llen);
1899 fname = fname_buf;
1900 }
1901 else
1902 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001903 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001904 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001905 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906 else
1907 {
1908 *tofree = fname;
1909 mch_memmove(fname, fname_buf, (size_t)i);
1910 STRCPY(fname + i, name + llen);
1911 }
1912 }
1913 }
1914 else
1915 fname = name;
1916 return fname;
1917}
1918
1919/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001920 * Concatenate the script ID and function name into "<SNR>99_name".
1921 * "buffer" must have size MAX_FUNC_NAME_LEN.
1922 */
1923 void
1924func_name_with_sid(char_u *name, int sid, char_u *buffer)
1925{
1926 // A script-local function is stored as "<SNR>99_name".
1927 buffer[0] = K_SPECIAL;
1928 buffer[1] = KS_EXTRA;
1929 buffer[2] = (int)KE_SNR;
1930 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1931 (long)sid, name);
1932}
1933
1934/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001935 * Find a function "name" in script "sid".
1936 */
1937 static ufunc_T *
1938find_func_with_sid(char_u *name, int sid)
1939{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001940 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001941 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942
Bram Moolenaarb8822442022-01-11 15:24:05 +00001943 if (!SCRIPT_ID_VALID(sid))
1944 return NULL; // not in a script
1945
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001946 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001947 hi = hash_find(&func_hashtab, buffer);
1948 if (!HASHITEM_EMPTY(hi))
1949 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001950 return NULL;
1951}
1952
1953/*
1954 * Find a function "name" in script "sid" prefixing the autoload prefix.
1955 */
1956 static ufunc_T *
1957find_func_with_prefix(char_u *name, int sid)
1958{
1959 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001960 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001961 scriptitem_T *si;
1962
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001963 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001964 return NULL; // already has the prefix
1965 if (!SCRIPT_ID_VALID(sid))
1966 return NULL; // not in a script
1967 si = SCRIPT_ITEM(sid);
1968 if (si->sn_autoload_prefix != NULL)
1969 {
1970 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1971 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001972 char_u *namep;
1973
1974 // skip a "<SNR>99_" prefix
1975 namep = untrans_function_name(name);
1976 if (namep == NULL)
1977 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001978
1979 // An exported function in an autoload script is stored as
1980 // "dir#path#name".
1981 if (len < sizeof(buffer))
1982 auto_name = buffer;
1983 else
1984 auto_name = alloc(len);
1985 if (auto_name != NULL)
1986 {
1987 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001988 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001989 hi = hash_find(&func_hashtab, auto_name);
1990 if (auto_name != buffer)
1991 vim_free(auto_name);
1992 if (!HASHITEM_EMPTY(hi))
1993 return HI2UF(hi);
1994 }
1995 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001996
1997 return NULL;
1998}
1999
2000/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002001 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002002 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2003 * functions.
2004 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002005 * Return NULL for unknown function.
2006 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002007 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002008find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002009{
2010 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002011 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002012
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002013 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002014 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002015 // Find script-local function before global one.
2016 if (in_vim9script() && eval_isnamec1(*name)
2017 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002018 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002019 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2020 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002021 if (func != NULL)
2022 return func;
2023 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002024 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2025 {
2026 char_u *p = name + 5;
2027 long sid;
2028
2029 // printable "<SNR>123_Name" form
2030 sid = getdigits(&p);
2031 if (*p == '_')
2032 {
2033 func = find_func_with_sid(p + 1, (int)sid);
2034 if (func != NULL)
2035 return func;
2036 }
2037 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002038 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002040 if ((flags & FFED_NO_GLOBAL) == 0)
2041 {
2042 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002043 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002044 if (!HASHITEM_EMPTY(hi))
2045 return HI2UF(hi);
2046 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002047
Bram Moolenaarb8822442022-01-11 15:24:05 +00002048 // Find autoload function if this is an autoload script.
2049 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2050 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002051}
2052
2053/*
2054 * Find a function by name, return pointer to it in ufuncs.
2055 * "cctx" is passed in a :def function to find imported functions.
2056 * Return NULL for unknown or dead function.
2057 */
2058 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002059find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002060{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002061 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002062
2063 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2064 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002065 return NULL;
2066}
2067
2068/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002069 * Return TRUE if "ufunc" is a global function.
2070 */
2071 int
2072func_is_global(ufunc_T *ufunc)
2073{
2074 return ufunc->uf_name[0] != K_SPECIAL;
2075}
2076
2077/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002078 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2079 */
2080 int
2081func_requires_g_prefix(ufunc_T *ufunc)
2082{
2083 return ufunc->uf_name[0] != K_SPECIAL
2084 && (ufunc->uf_flags & FC_LAMBDA) == 0
2085 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2086}
2087
2088/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002089 * Copy the function name of "fp" to buffer "buf".
2090 * "buf" must be able to hold the function name plus three bytes.
2091 * Takes care of script-local function names.
2092 */
2093 static void
2094cat_func_name(char_u *buf, ufunc_T *fp)
2095{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002096 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002097 {
2098 STRCPY(buf, "<SNR>");
2099 STRCAT(buf, fp->uf_name + 3);
2100 }
2101 else
2102 STRCPY(buf, fp->uf_name);
2103}
2104
2105/*
2106 * Add a number variable "name" to dict "dp" with value "nr".
2107 */
2108 static void
2109add_nr_var(
2110 dict_T *dp,
2111 dictitem_T *v,
2112 char *name,
2113 varnumber_T nr)
2114{
2115 STRCPY(v->di_key, name);
2116 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2117 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2118 v->di_tv.v_type = VAR_NUMBER;
2119 v->di_tv.v_lock = VAR_FIXED;
2120 v->di_tv.vval.v_number = nr;
2121}
2122
2123/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002124 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002126 static void
2127free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002128{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002129 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002130
2131 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2132 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002133 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002134
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002135 // When garbage collecting a funccall_T may be freed before the
2136 // function that references it, clear its uf_scoped field.
2137 // The function may have been redefined and point to another
2138 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002139 if (fp != NULL && fp->uf_scoped == fc)
2140 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002141 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002142 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002143
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002144 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002145 vim_free(fc);
2146}
2147
2148/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002149 * Free "fc" and what it contains.
2150 * Can be called only when "fc" is kept beyond the period of it called,
2151 * i.e. after cleanup_function_call(fc).
2152 */
2153 static void
2154free_funccal_contents(funccall_T *fc)
2155{
2156 listitem_T *li;
2157
2158 // Free all l: variables.
2159 vars_clear(&fc->l_vars.dv_hashtab);
2160
2161 // Free all a: variables.
2162 vars_clear(&fc->l_avars.dv_hashtab);
2163
2164 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002165 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002166 clear_tv(&li->li_tv);
2167
2168 free_funccal(fc);
2169}
2170
2171/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002172 * Handle the last part of returning from a function: free the local hashtable.
2173 * Unless it is still in use by a closure.
2174 */
2175 static void
2176cleanup_function_call(funccall_T *fc)
2177{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002178 int may_free_fc = fc->fc_refcount <= 0;
2179 int free_fc = TRUE;
2180
Bram Moolenaar6914c642017-04-01 21:21:30 +02002181 current_funccal = fc->caller;
2182
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002183 // Free all l: variables if not referred.
2184 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2185 vars_clear(&fc->l_vars.dv_hashtab);
2186 else
2187 free_fc = FALSE;
2188
2189 // If the a:000 list and the l: and a: dicts are not referenced and
2190 // there is no closure using it, we can free the funccall_T and what's
2191 // in it.
2192 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2193 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002194 else
2195 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002196 int todo;
2197 hashitem_T *hi;
2198 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002199
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002200 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002201
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002202 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002203 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2204 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2205 {
2206 if (!HASHITEM_EMPTY(hi))
2207 {
2208 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002209 di = HI2DI(hi);
2210 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002211 }
2212 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002213 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002214
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002215 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2216 fc->l_varlist.lv_first = NULL;
2217 else
2218 {
2219 listitem_T *li;
2220
2221 free_fc = FALSE;
2222
2223 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002224 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002225 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002226 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002227
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002228 if (free_fc)
2229 free_funccal(fc);
2230 else
2231 {
2232 static int made_copy = 0;
2233
2234 // "fc" is still in use. This can happen when returning "a:000",
2235 // assigning "l:" to a global variable or defining a closure.
2236 // Link "fc" in the list for garbage collection later.
2237 fc->caller = previous_funccal;
2238 previous_funccal = fc;
2239
2240 if (want_garbage_collect)
2241 // If garbage collector is ready, clear count.
2242 made_copy = 0;
2243 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002244 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002245 // We have made a lot of copies, worth 4 Mbyte. This can happen
2246 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002247 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002248 // too much memory.
2249 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002250 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002251 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002252 }
2253}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002254
2255/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002256 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2257 */
2258 static int
2259numbered_function(char_u *name)
2260{
2261 return isdigit(*name)
2262 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2263}
2264
2265/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002266 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002267 * 1. ordinary names, function defined with :function or :def;
2268 * can start with "<SNR>123_" literally or with K_SPECIAL.
2269 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002270 * For the first we only count the name stored in func_hashtab as a reference,
2271 * using function() does not count as a reference, because the function is
2272 * looked up by name.
2273 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002274 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002275func_name_refcount(char_u *name)
2276{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002277 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002278}
2279
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002280/*
2281 * Unreference "fc": decrement the reference count and free it when it
2282 * becomes zero. "fp" is detached from "fc".
2283 * When "force" is TRUE we are exiting.
2284 */
2285 static void
2286funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2287{
2288 funccall_T **pfc;
2289 int i;
2290
2291 if (fc == NULL)
2292 return;
2293
2294 if (--fc->fc_refcount <= 0 && (force || (
2295 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2296 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2297 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2298 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2299 {
2300 if (fc == *pfc)
2301 {
2302 *pfc = fc->caller;
2303 free_funccal_contents(fc);
2304 return;
2305 }
2306 }
2307 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2308 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2309 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2310}
2311
2312/*
2313 * Remove the function from the function hashtable. If the function was
2314 * deleted while it still has references this was already done.
2315 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2316 */
2317 static int
2318func_remove(ufunc_T *fp)
2319{
2320 hashitem_T *hi;
2321
2322 // Return if it was already virtually deleted.
2323 if (fp->uf_flags & FC_DEAD)
2324 return FALSE;
2325
2326 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2327 if (!HASHITEM_EMPTY(hi))
2328 {
2329 // When there is a def-function index do not actually remove the
2330 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002331 // Do remove it when it's a copy.
2332 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002333 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002334 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002335 return FALSE;
2336 }
2337 hash_remove(&func_hashtab, hi);
2338 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002339 return TRUE;
2340 }
2341 return FALSE;
2342}
2343
2344 static void
2345func_clear_items(ufunc_T *fp)
2346{
2347 ga_clear_strings(&(fp->uf_args));
2348 ga_clear_strings(&(fp->uf_def_args));
2349 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002350 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002351 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002352 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002353 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002354
2355 // Increment the refcount of this function to avoid it being freed
2356 // recursively when the partial is freed.
2357 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002358 partial_unref(fp->uf_partial);
2359 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002360 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002361
2362#ifdef FEAT_LUA
2363 if (fp->uf_cb_free != NULL)
2364 {
2365 fp->uf_cb_free(fp->uf_cb_state);
2366 fp->uf_cb_free = NULL;
2367 }
2368
2369 fp->uf_cb_state = NULL;
2370 fp->uf_cb = NULL;
2371#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002372#ifdef FEAT_PROFILE
2373 VIM_CLEAR(fp->uf_tml_count);
2374 VIM_CLEAR(fp->uf_tml_total);
2375 VIM_CLEAR(fp->uf_tml_self);
2376#endif
2377}
2378
2379/*
2380 * Free all things that a function contains. Does not free the function
2381 * itself, use func_free() for that.
2382 * When "force" is TRUE we are exiting.
2383 */
2384 static void
2385func_clear(ufunc_T *fp, int force)
2386{
2387 if (fp->uf_cleared)
2388 return;
2389 fp->uf_cleared = TRUE;
2390
2391 // clear this function
2392 func_clear_items(fp);
2393 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002394 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002395}
2396
2397/*
2398 * Free a function and remove it from the list of functions. Does not free
2399 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002400 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002401 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002402 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002403 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002404func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002405{
2406 // Only remove it when not done already, otherwise we would remove a newer
2407 // version of the function with the same name.
2408 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2409 func_remove(fp);
2410
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002411 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002412 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002413 if (fp->uf_dfunc_idx > 0)
2414 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002415 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002416 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002417 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002418 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002419 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002420}
2421
2422/*
2423 * Free all things that a function contains and free the function itself.
2424 * When "force" is TRUE we are exiting.
2425 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002426 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002427func_clear_free(ufunc_T *fp, int force)
2428{
2429 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002430 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2431 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002432 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002433 else
2434 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002435}
2436
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002437/*
2438 * Copy already defined function "lambda" to a new function with name "global".
2439 * This is for when a compiled function defines a global function.
2440 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002441 int
2442copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002443{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002444 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002445 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002446
2447 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002448 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002449 semsg(_(e_lambda_function_not_found_str), lambda);
2450 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002451 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002452
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002453 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002454 if (fp != NULL)
2455 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002456 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002457 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002458 return FAIL;
2459 }
2460
2461 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2462 if (fp == NULL)
2463 return FAIL;
2464
2465 fp->uf_varargs = ufunc->uf_varargs;
2466 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2467 fp->uf_def_status = ufunc->uf_def_status;
2468 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2469 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2470 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2471 == FAIL
2472 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2473 goto failed;
2474
2475 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2476 : vim_strsave(ufunc->uf_name_exp);
2477 if (ufunc->uf_arg_types != NULL)
2478 {
2479 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2480 if (fp->uf_arg_types == NULL)
2481 goto failed;
2482 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2483 sizeof(type_T *) * fp->uf_args.ga_len);
2484 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002485 if (ufunc->uf_va_name != NULL)
2486 {
2487 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2488 if (fp->uf_va_name == NULL)
2489 goto failed;
2490 }
2491 fp->uf_ret_type = ufunc->uf_ret_type;
2492
2493 fp->uf_refcount = 1;
2494 STRCPY(fp->uf_name, global);
2495 hash_add(&func_hashtab, UF2HIKEY(fp));
2496
2497 // the referenced dfunc_T is now used one more time
2498 link_def_function(fp);
2499
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002500 // Create a partial to store the context of the function where it was
2501 // instantiated. Only needs to be done once. Do this on the original
2502 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002503 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2504 {
2505 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2506
2507 if (pt == NULL)
2508 goto failed;
2509 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002510 {
2511 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002512 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002513 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002514 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002515 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002516 }
2517
2518 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002519
2520failed:
2521 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002522 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002523}
2524
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002525static int funcdepth = 0;
2526
2527/*
2528 * Increment the function call depth count.
2529 * Return FAIL when going over 'maxfuncdepth'.
2530 * Otherwise return OK, must call funcdepth_decrement() later!
2531 */
2532 int
2533funcdepth_increment(void)
2534{
2535 if (funcdepth >= p_mfd)
2536 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002537 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002538 return FAIL;
2539 }
2540 ++funcdepth;
2541 return OK;
2542}
2543
2544 void
2545funcdepth_decrement(void)
2546{
2547 --funcdepth;
2548}
2549
2550/*
2551 * Get the current function call depth.
2552 */
2553 int
2554funcdepth_get(void)
2555{
2556 return funcdepth;
2557}
2558
2559/*
2560 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002561 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002562 * times as funcdepth_increment().
2563 */
2564 void
2565funcdepth_restore(int depth)
2566{
2567 funcdepth = depth;
2568}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002569
2570/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571 * Call a user function.
2572 */
2573 static void
2574call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002575 ufunc_T *fp, // pointer to function
2576 int argcount, // nr of args
2577 typval_T *argvars, // arguments
2578 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002579 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002580 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002581{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002582 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002583 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002584 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002585 funccall_T *fc;
2586 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002587 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002589 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590 int i;
2591 int ai;
2592 int islambda = FALSE;
2593 char_u numbuf[NUMBUFLEN];
2594 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002595 typval_T *tv_to_free[MAX_FUNC_ARGS];
2596 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002597#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002598 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002599#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002600 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601
Bram Moolenaarb2049902021-01-24 12:53:53 +01002602#ifdef FEAT_PROFILE
2603 CLEAR_FIELD(profile_info);
2604#endif
2605
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002606 // If depth of calling is getting too high, don't execute the function.
2607 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002609 rettv->v_type = VAR_NUMBER;
2610 rettv->vval.v_number = -1;
2611 return;
2612 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613
Bram Moolenaare38eab22019-12-05 21:50:01 +01002614 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002616 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002617 if (fc == NULL)
2618 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002619 fc->caller = current_funccal;
2620 current_funccal = fc;
2621 fc->func = fp;
2622 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002624 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002625 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2626 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002627 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002628 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002629 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002631 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002632 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002633#ifdef FEAT_PROFILE
2634 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2635#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002636 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002637#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002638 if (do_profiling == PROF_YES)
2639 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002640#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002641 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002642 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002643 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002644#ifdef FEAT_PROFILE
2645 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002646 || (caller != NULL && caller->uf_profiling)))
2647 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002648#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002649 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002650 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002651 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002652 return;
2653 }
2654
Bram Moolenaar38453522021-11-28 22:00:12 +00002655 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656
2657 /*
2658 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2659 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2660 * each argument variable and saves a lot of time.
2661 */
2662 /*
2663 * Init l: variables.
2664 */
2665 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2666 if (selfdict != NULL)
2667 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002668 // Set l:self to "selfdict". Use "name" to avoid a warning from
2669 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670 v = &fc->fixvar[fixvar_idx++].var;
2671 name = v->di_key;
2672 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002673 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2675 v->di_tv.v_type = VAR_DICT;
2676 v->di_tv.v_lock = 0;
2677 v->di_tv.vval.v_dict = selfdict;
2678 ++selfdict->dv_refcount;
2679 }
2680
2681 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002682 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002683 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002684 * Set a:000 to a list with room for the "..." arguments.
2685 */
2686 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002687 if ((fp->uf_flags & FC_NOARGS) == 0)
2688 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002689 (varnumber_T)(argcount >= fp->uf_args.ga_len
2690 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002691 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002692 if ((fp->uf_flags & FC_NOARGS) == 0)
2693 {
2694 // Use "name" to avoid a warning from some compiler that checks the
2695 // destination size.
2696 v = &fc->fixvar[fixvar_idx++].var;
2697 name = v->di_key;
2698 STRCPY(name, "000");
2699 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2700 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2701 v->di_tv.v_type = VAR_LIST;
2702 v->di_tv.v_lock = VAR_FIXED;
2703 v->di_tv.vval.v_list = &fc->l_varlist;
2704 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002705 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2707 fc->l_varlist.lv_lock = VAR_FIXED;
2708
2709 /*
2710 * Set a:firstline to "firstline" and a:lastline to "lastline".
2711 * Set a:name to named arguments.
2712 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002713 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002715 if ((fp->uf_flags & FC_NOARGS) == 0)
2716 {
2717 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002718 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002719 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002720 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002721 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002722 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 {
2724 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002725 typval_T def_rettv;
2726 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002727
2728 ai = i - fp->uf_args.ga_len;
2729 if (ai < 0)
2730 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002731 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002732 name = FUNCARG(fp, i);
2733 if (islambda)
2734 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002735
2736 // evaluate named argument default expression
2737 isdefault = ai + fp->uf_def_args.ga_len >= 0
2738 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2739 && argvars[i].vval.v_number == VVAL_NONE));
2740 if (isdefault)
2741 {
2742 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002743
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002744 def_rettv.v_type = VAR_NUMBER;
2745 def_rettv.vval.v_number = -1;
2746
2747 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2748 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002749 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002750 {
2751 default_arg_err = 1;
2752 break;
2753 }
2754 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002755 }
2756 else
2757 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002758 if ((fp->uf_flags & FC_NOARGS) != 0)
2759 // Bail out if no a: arguments used (in lambda).
2760 break;
2761
Bram Moolenaare38eab22019-12-05 21:50:01 +01002762 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 sprintf((char *)numbuf, "%d", ai + 1);
2764 name = numbuf;
2765 }
2766 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2767 {
2768 v = &fc->fixvar[fixvar_idx++].var;
2769 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002770 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771 }
2772 else
2773 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002774 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 if (v == NULL)
2776 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002777 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002779
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002780 // Note: the values are copied directly to avoid alloc/free.
2781 // "argvars" must have VAR_FIXED for v_lock.
2782 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 v->di_tv.v_lock = VAR_FIXED;
2784
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002785 if (isdefault)
2786 // Need to free this later, no matter where it's stored.
2787 tv_to_free[tv_to_free_len++] = &v->di_tv;
2788
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789 if (addlocal)
2790 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002791 // Named arguments should be accessed without the "a:" prefix in
2792 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002793 copy_tv(&v->di_tv, &v->di_tv);
2794 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002795 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002796 else
2797 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798
2799 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2800 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002801 listitem_T *li = &fc->l_listitems[ai];
2802
2803 li->li_tv = argvars[i];
2804 li->li_tv.v_lock = VAR_FIXED;
2805 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 }
2807 }
2808
Bram Moolenaare38eab22019-12-05 21:50:01 +01002809 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002811
2812 if (fp->uf_flags & FC_SANDBOX)
2813 {
2814 using_sandbox = TRUE;
2815 ++sandbox;
2816 }
2817
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002818 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002819 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002820 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002822 ++no_wait_return;
2823 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002825 smsg(_("calling %s"), SOURCING_NAME);
2826 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002828 char_u buf[MSG_BUF_LEN];
2829 char_u numbuf2[NUMBUFLEN];
2830 char_u *tofree;
2831 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002833 msg_puts("(");
2834 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002836 if (i > 0)
2837 msg_puts(", ");
2838 if (argvars[i].v_type == VAR_NUMBER)
2839 msg_outnum((long)argvars[i].vval.v_number);
2840 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002842 // Do not want errors such as E724 here.
2843 ++emsg_off;
2844 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2845 --emsg_off;
2846 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002848 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002850 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2851 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002853 msg_puts((char *)s);
2854 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 }
2856 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002858 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002860 msg_puts("\n"); // don't overwrite this either
2861
2862 verbose_leave_scroll();
2863 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 }
2865#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002866 if (do_profiling == PROF_YES)
2867 profile_may_start_func(&profile_info, fp,
2868 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869#endif
2870
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002871 // "legacy" does not apply to commands in the function
2872 sticky_cmdmod_flags = 0;
2873
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002874 save_current_sctx = current_sctx;
2875 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 save_did_emsg = did_emsg;
2877 did_emsg = FALSE;
2878
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002879 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2880 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002881 else if (islambda)
2882 {
2883 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2884
2885 // A Lambda always has the command "return {expr}". It is much faster
2886 // to evaluate {expr} directly.
2887 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002888 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002889 --ex_nesting_level;
2890 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002891 else
2892 // call do_cmdline() to execute the lines
2893 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002894 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2895
2896 --RedrawingDisabled;
2897
Bram Moolenaare38eab22019-12-05 21:50:01 +01002898 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002899 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2900 {
2901 clear_tv(rettv);
2902 rettv->v_type = VAR_NUMBER;
2903 rettv->vval.v_number = -1;
2904 }
2905
2906#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002907 if (do_profiling == PROF_YES)
2908 {
2909 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2910
2911 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2912 profile_may_end_func(&profile_info, fp, caller);
2913 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002914#endif
2915
Bram Moolenaare38eab22019-12-05 21:50:01 +01002916 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917 if (p_verbose >= 12)
2918 {
2919 ++no_wait_return;
2920 verbose_enter_scroll();
2921
2922 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002923 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002925 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002926 (long)fc->rettv->vval.v_number);
2927 else
2928 {
2929 char_u buf[MSG_BUF_LEN];
2930 char_u numbuf2[NUMBUFLEN];
2931 char_u *tofree;
2932 char_u *s;
2933
Bram Moolenaare38eab22019-12-05 21:50:01 +01002934 // The value may be very long. Skip the middle part, so that we
2935 // have some idea how it starts and ends. smsg() would always
2936 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002937 ++emsg_off;
2938 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2939 --emsg_off;
2940 if (s != NULL)
2941 {
2942 if (vim_strsize(s) > MSG_BUF_CLEN)
2943 {
2944 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2945 s = buf;
2946 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002947 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002948 vim_free(tofree);
2949 }
2950 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002951 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952
2953 verbose_leave_scroll();
2954 --no_wait_return;
2955 }
2956
Bram Moolenaare31ee862020-01-07 20:59:34 +01002957 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002958 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002959 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002960#ifdef FEAT_PROFILE
2961 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002962 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002963#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002964 if (using_sandbox)
2965 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002966 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002968 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969 {
2970 ++no_wait_return;
2971 verbose_enter_scroll();
2972
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002973 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002974 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002975
2976 verbose_leave_scroll();
2977 --no_wait_return;
2978 }
2979
2980 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002981 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002982 for (i = 0; i < tv_to_free_len; ++i)
2983 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002984 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002985}
2986
2987/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002988 * Check the argument count for user function "fp".
2989 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2990 */
2991 int
2992check_user_func_argcount(ufunc_T *fp, int argcount)
2993{
2994 int regular_args = fp->uf_args.ga_len;
2995
2996 if (argcount < regular_args - fp->uf_def_args.ga_len)
2997 return FCERR_TOOFEW;
2998 else if (!has_varargs(fp) && argcount > regular_args)
2999 return FCERR_TOOMANY;
3000 return FCERR_UNKNOWN;
3001}
3002
3003/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003004 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003005 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003006 int
3007call_user_func_check(
3008 ufunc_T *fp,
3009 int argcount,
3010 typval_T *argvars,
3011 typval_T *rettv,
3012 funcexe_T *funcexe,
3013 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003014{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003015 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003016
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003017 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3018 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003019 error = check_user_func_argcount(fp, argcount);
3020 if (error != FCERR_UNKNOWN)
3021 return error;
3022 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 error = FCERR_DICT;
3024 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003025 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003026 int did_save_redo = FALSE;
3027 save_redo_T save_redo;
3028
3029 /*
3030 * Call the user function.
3031 * Save and restore search patterns, script variables and
3032 * redo buffer.
3033 */
3034 save_search_patterns();
3035 if (!ins_compl_active())
3036 {
3037 saveRedobuff(&save_redo);
3038 did_save_redo = TRUE;
3039 }
3040 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003041 call_user_func(fp, argcount, argvars, rettv, funcexe,
3042 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003043 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3044 // Function was unreferenced while being used, free it now.
3045 func_clear_free(fp, FALSE);
3046 if (did_save_redo)
3047 restoreRedobuff(&save_redo);
3048 restore_search_patterns();
3049 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003050 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003051 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003052}
3053
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003054static funccal_entry_T *funccal_stack = NULL;
3055
3056/*
3057 * Save the current function call pointer, and set it to NULL.
3058 * Used when executing autocommands and for ":source".
3059 */
3060 void
3061save_funccal(funccal_entry_T *entry)
3062{
3063 entry->top_funccal = current_funccal;
3064 entry->next = funccal_stack;
3065 funccal_stack = entry;
3066 current_funccal = NULL;
3067}
3068
3069 void
3070restore_funccal(void)
3071{
3072 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003073 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003074 else
3075 {
3076 current_funccal = funccal_stack->top_funccal;
3077 funccal_stack = funccal_stack->next;
3078 }
3079}
3080
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003081 funccall_T *
3082get_current_funccal(void)
3083{
3084 return current_funccal;
3085}
3086
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003087/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003088 * Return TRUE when currently at the script level:
3089 * - not in a function
3090 * - not executing an autocommand
3091 * Note that when an autocommand sources a script the result is FALSE;
3092 */
3093 int
3094at_script_level(void)
3095{
3096 return current_funccal == NULL && autocmd_match == NULL;
3097}
3098
3099/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003100 * Mark all functions of script "sid" as deleted.
3101 */
3102 void
3103delete_script_functions(int sid)
3104{
3105 hashitem_T *hi;
3106 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003107 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003108 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003109 size_t len;
3110
3111 buf[0] = K_SPECIAL;
3112 buf[1] = KS_EXTRA;
3113 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003114 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003115 len = STRLEN(buf);
3116
Bram Moolenaarce658352020-07-31 23:47:12 +02003117 while (todo > 0)
3118 {
3119 todo = func_hashtab.ht_used;
3120 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3121 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003122 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003123 fp = HI2UF(hi);
3124 if (STRNCMP(fp->uf_name, buf, len) == 0)
3125 {
3126 int changed = func_hashtab.ht_changed;
3127
3128 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003129
3130 if (fp->uf_calls > 0)
3131 {
3132 // Function is executing, don't free it but do remove
3133 // it from the hashtable.
3134 if (func_remove(fp))
3135 fp->uf_refcount--;
3136 }
3137 else
3138 {
3139 func_clear(fp, TRUE);
3140 // When clearing a function another function can be
3141 // cleared as a side effect. When that happens start
3142 // over.
3143 if (changed != func_hashtab.ht_changed)
3144 break;
3145 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003146 }
3147 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003148 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003149 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003150}
3151
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152#if defined(EXITFREE) || defined(PROTO)
3153 void
3154free_all_functions(void)
3155{
3156 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003157 ufunc_T *fp;
3158 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003159 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003160 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161
Bram Moolenaare38eab22019-12-05 21:50:01 +01003162 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003163 while (current_funccal != NULL)
3164 {
3165 clear_tv(current_funccal->rettv);
3166 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003167 if (current_funccal == NULL && funccal_stack != NULL)
3168 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003169 }
3170
Bram Moolenaare38eab22019-12-05 21:50:01 +01003171 // First clear what the functions contain. Since this may lower the
3172 // reference count of a function, it may also free a function and change
3173 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003174 while (todo > 0)
3175 {
3176 todo = func_hashtab.ht_used;
3177 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3178 if (!HASHITEM_EMPTY(hi))
3179 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003180 // clear the def function index now
3181 fp = HI2UF(hi);
3182 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003183 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003184
Bram Moolenaare38eab22019-12-05 21:50:01 +01003185 // Only free functions that are not refcounted, those are
3186 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003187 if (func_name_refcount(fp->uf_name))
3188 ++skipped;
3189 else
3190 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003191 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003192 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003193 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003194 {
3195 skipped = 0;
3196 break;
3197 }
3198 }
3199 --todo;
3200 }
3201 }
3202
Bram Moolenaare38eab22019-12-05 21:50:01 +01003203 // Now actually free the functions. Need to start all over every time,
3204 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003205 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003206 while (func_hashtab.ht_used > skipped)
3207 {
3208 todo = func_hashtab.ht_used;
3209 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 if (!HASHITEM_EMPTY(hi))
3211 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003212 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003213 // Only free functions that are not refcounted, those are
3214 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003215 fp = HI2UF(hi);
3216 if (func_name_refcount(fp->uf_name))
3217 ++skipped;
3218 else
3219 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003220 if (func_free(fp, FALSE) == OK)
3221 {
3222 skipped = 0;
3223 break;
3224 }
3225 // did not actually free it
3226 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003227 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003229 }
3230 if (skipped == 0)
3231 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003232
3233 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234}
3235#endif
3236
3237/*
3238 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003239 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3240 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 * "len" is the length of "name", or -1 for NUL terminated.
3242 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003243 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244builtin_function(char_u *name, int len)
3245{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003246 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247
Bram Moolenaara26b9702020-04-18 19:53:28 +02003248 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003250 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3251 {
3252 if (name[i] == AUTOLOAD_CHAR)
3253 return FALSE;
3254 if (!eval_isnamec(name[i]))
3255 {
3256 // "name.something" is not a builtin function
3257 if (name[i] == '.')
3258 return FALSE;
3259 break;
3260 }
3261 }
3262 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263}
3264
3265 int
3266func_call(
3267 char_u *name,
3268 typval_T *args,
3269 partial_T *partial,
3270 dict_T *selfdict,
3271 typval_T *rettv)
3272{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003273 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274 listitem_T *item;
3275 typval_T argv[MAX_FUNC_ARGS + 1];
3276 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 int r = 0;
3278
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003279 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003280 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 {
3282 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3283 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003284 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285 break;
3286 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003287 // Make a copy of each argument. This is needed to be able to set
3288 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289 copy_tv(&item->li_tv, &argv[argc++]);
3290 }
3291
3292 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003293 {
3294 funcexe_T funcexe;
3295
Bram Moolenaara80faa82020-04-12 19:37:17 +02003296 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003297 funcexe.fe_firstline = curwin->w_cursor.lnum;
3298 funcexe.fe_lastline = curwin->w_cursor.lnum;
3299 funcexe.fe_evaluate = TRUE;
3300 funcexe.fe_partial = partial;
3301 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003302 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304
Bram Moolenaare38eab22019-12-05 21:50:01 +01003305 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 while (argc > 0)
3307 clear_tv(&argv[--argc]);
3308
3309 return r;
3310}
3311
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003312static int callback_depth = 0;
3313
3314 int
3315get_callback_depth(void)
3316{
3317 return callback_depth;
3318}
3319
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003321 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003322 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003323 */
3324 int
3325call_callback(
3326 callback_T *callback,
3327 int len, // length of "name" or -1 to use strlen()
3328 typval_T *rettv, // return value goes here
3329 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003330 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003331 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003332{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003333 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003334 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003335
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003336 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3337 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003338 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003339 funcexe.fe_evaluate = TRUE;
3340 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003341 ++callback_depth;
3342 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3343 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003344
3345 // When a :def function was called that uses :try an error would be turned
3346 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003347 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003348 {
3349 need_rethrow = FALSE;
3350 handle_did_throw();
3351 }
3352
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003353 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003354}
3355
3356/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003357 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003358 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003359 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3360 */
3361 varnumber_T
3362call_callback_retnr(
3363 callback_T *callback,
3364 int argcount, // number of "argvars"
3365 typval_T *argvars) // vars for arguments, must have "argcount"
3366 // PLUS ONE elements!
3367{
3368 typval_T rettv;
3369 varnumber_T retval;
3370
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003371 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003372 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003373
3374 retval = tv_get_number_chk(&rettv, NULL);
3375 clear_tv(&rettv);
3376 return retval;
3377}
3378
3379/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003380 * Give an error message for the result of a function.
3381 * Nothing if "error" is FCERR_NONE.
3382 */
3383 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003384user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003385{
3386 switch (error)
3387 {
3388 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003389 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003390 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003391 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003392 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003393 break;
3394 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003395 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003396 break;
3397 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003398 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003399 break;
3400 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003401 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003402 break;
3403 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003404 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003405 break;
3406 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003407 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408 break;
3409 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003410 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3411 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003412 break;
3413 }
3414}
3415
3416/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003418 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419 * Return FAIL when the function can't be called, OK otherwise.
3420 * Also returns OK when an error was encountered while executing the function.
3421 */
3422 int
3423call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003424 char_u *funcname, // name of the function
3425 int len, // length of "name" or -1 to use strlen()
3426 typval_T *rettv, // return value goes here
3427 int argcount_in, // number of "argvars"
3428 typval_T *argvars_in, // vars for arguments, must have "argcount"
3429 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003430 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431{
3432 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003433 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003435 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 char_u fname_buf[FLEN_FIXED + 1];
3437 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003438 char_u *fname = NULL;
3439 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 int argcount = argcount_in;
3441 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003442 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003443 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003444 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003446 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003447 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003448 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003449 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003451 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3452 // even when call_func() returns FAIL.
3453 rettv->v_type = VAR_UNKNOWN;
3454
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003455 if (partial != NULL)
3456 fp = partial->pt_func;
3457 if (fp == NULL)
3458 {
3459 // Make a copy of the name, if it comes from a funcref variable it
3460 // could be changed or deleted in the called function.
3461 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3462 if (name == NULL)
3463 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003464
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003465 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003468 if (funcexe->fe_doesrange != NULL)
3469 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470
3471 if (partial != NULL)
3472 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003473 // When the function has a partial with a dict and there is a dict
3474 // argument, use the dict argument. That is backwards compatible.
3475 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003476 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003477 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003478 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 {
3480 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003481 {
3482 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3483 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003484 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003485 goto theend;
3486 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003487 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003488 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489 for (i = 0; i < argcount_in; ++i)
3490 argv[i + argv_clear] = argvars_in[i];
3491 argvars = argv;
3492 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003493
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003494 if (funcexe->fe_check_type != NULL
3495 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003496 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003497 // Now funcexe->fe_check_type is missing the added arguments,
3498 // make a copy of the type with the correction.
3499 check_type = *funcexe->fe_check_type;
3500 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003501 check_type.tt_args = check_type_args;
3502 CLEAR_FIELD(check_type_args);
3503 for (i = 0; i < check_type.tt_argcount; ++i)
3504 check_type_args[i + partial->pt_argc] =
3505 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003506 check_type.tt_argcount += partial->pt_argc;
3507 check_type.tt_min_argcount += partial->pt_argc;
3508 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 }
3510 }
3511
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003512 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3513 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003514 {
3515 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003516 if (check_argument_types(funcexe->fe_check_type,
3517 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003518 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003519 error = FCERR_OTHER;
3520 }
3521
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003522 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 {
3524 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003525 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526
Bram Moolenaar333894b2020-08-01 18:53:07 +02003527 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003528 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003529 {
3530 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533
Bram Moolenaare38eab22019-12-05 21:50:01 +01003534 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003536 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003538 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 {
3540 /*
3541 * User defined function.
3542 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003543 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003544 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003545 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003546 if (fp != NULL && !is_global && in_vim9script()
3547 && func_requires_g_prefix(fp))
3548 // In Vim9 script g: is required to find a global
3549 // non-autoload function.
3550 fp = NULL;
3551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552
Bram Moolenaare38eab22019-12-05 21:50:01 +01003553 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 if (fp == NULL
3555 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003556 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 && !aborting())
3558 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003559 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003560 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003562 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3564 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003565 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003566 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003568 if (fp == NULL)
3569 {
3570 char_u *p = untrans_function_name(rfname);
3571
3572 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003573 // Don't do this if the name starts with "s:".
3574 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003575 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003578 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003579 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003580#ifdef FEAT_LUA
3581 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3582 {
3583 cfunc_T cb = fp->uf_cb;
3584
3585 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3586 }
3587#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003588 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003590 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003591 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003592 argcount = funcexe->fe_argv_func(argcount, argvars,
3593 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003594
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003595 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003596 {
3597 // Method call: base->Method()
3598 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003599 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003600 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003601 argvars = argv;
3602 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003603 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003604
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003605 error = call_user_func_check(fp, argcount, argvars, rettv,
3606 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 }
3608 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003609 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003610 {
3611 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003612 * expr->method(): Find the method name in the table, call its
3613 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003614 */
3615 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003616 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003617 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 else
3619 {
3620 /*
3621 * Find the function name in the table, call its implementation.
3622 */
3623 error = call_internal_func(fname, argcount, argvars, rettv);
3624 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003625
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003626 /*
3627 * The function call (or "FuncUndefined" autocommand sequence) might
3628 * have been aborted by an error, an interrupt, or an explicitly thrown
3629 * exception that has not been caught so far. This situation can be
3630 * tested for by calling aborting(). For an error in an internal
3631 * function or for the "E132" error in call_user_func(), however, the
3632 * throw point at which the "force_abort" flag (temporarily reset by
3633 * emsg()) is normally updated has not been reached yet. We need to
3634 * update that flag first to make aborting() reliable.
3635 */
3636 update_force_abort();
3637 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003638 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639 ret = OK;
3640
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003641theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 /*
3643 * Report an error unless the argument evaluation or function call has been
3644 * cancelled due to an aborting error, an interrupt, or an exception.
3645 */
3646 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003647 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003649 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003651 clear_tv(&argv[--argv_clear + argv_base]);
3652
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 vim_free(tofree);
3654 vim_free(name);
3655
3656 return ret;
3657}
3658
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003659 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003660printable_func_name(ufunc_T *fp)
3661{
3662 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3663}
3664
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003666 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667 */
3668 static void
3669list_func_head(ufunc_T *fp, int indent)
3670{
3671 int j;
3672
3673 msg_start();
3674 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003675 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003676 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003677 msg_puts("def ");
3678 else
3679 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003680 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 msg_putchar('(');
3682 for (j = 0; j < fp->uf_args.ga_len; ++j)
3683 {
3684 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003685 msg_puts(", ");
3686 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003687 if (fp->uf_arg_types != NULL)
3688 {
3689 char *tofree;
3690
3691 msg_puts(": ");
3692 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3693 vim_free(tofree);
3694 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003695 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3696 {
3697 msg_puts(" = ");
3698 msg_puts(((char **)(fp->uf_def_args.ga_data))
3699 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3700 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 }
3702 if (fp->uf_varargs)
3703 {
3704 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003705 msg_puts(", ");
3706 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003708 if (fp->uf_va_name != NULL)
3709 {
3710 if (j)
3711 msg_puts(", ");
3712 msg_puts("...");
3713 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003714 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003715 {
3716 char *tofree;
3717
3718 msg_puts(": ");
3719 msg_puts(type_name(fp->uf_va_type, &tofree));
3720 vim_free(tofree);
3721 }
3722 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003724
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003725 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003726 {
3727 if (fp->uf_ret_type != &t_void)
3728 {
3729 char *tofree;
3730
3731 msg_puts(": ");
3732 msg_puts(type_name(fp->uf_ret_type, &tofree));
3733 vim_free(tofree);
3734 }
3735 }
3736 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003737 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003739 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003740 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003741 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003742 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003743 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744 msg_clr_eos();
3745 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003746 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747}
3748
3749/*
3750 * Get a function name, translating "<SID>" and "<SNR>".
3751 * Also handles a Funcref in a List or Dictionary.
3752 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003753 * Set "*is_global" to TRUE when the function must be global, unless
3754 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 * flags:
3756 * TFN_INT: internal function name OK
3757 * TFN_QUIET: be quiet
3758 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003759 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 * Advances "pp" to just after the function name (if no error).
3761 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003762 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003763trans_function_name(
3764 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003765 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003766 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003768 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003769 partial_T **partial, // return: partial of a FuncRef
3770 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771{
3772 char_u *name = NULL;
3773 char_u *start;
3774 char_u *end;
3775 int lead;
3776 char_u sid_buf[20];
3777 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003779 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003781 int vim9script = in_vim9script();
3782 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783
3784 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003785 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 start = *pp;
3787
Bram Moolenaare38eab22019-12-05 21:50:01 +01003788 // Check for hard coded <SNR>: already translated function ID (from a user
3789 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3791 && (*pp)[2] == (int)KE_SNR)
3792 {
3793 *pp += 3;
3794 len = get_id_len(pp) + 3;
3795 return vim_strnsave(start, len);
3796 }
3797
Bram Moolenaare38eab22019-12-05 21:50:01 +01003798 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3799 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 lead = eval_fname_script(start);
3801 if (lead > 2)
3802 start += lead;
3803
Bram Moolenaare38eab22019-12-05 21:50:01 +01003804 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003805 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003807 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003808 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 {
3810 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003811 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 goto theend;
3813 }
3814 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3815 {
3816 /*
3817 * Report an invalid expression in braces, unless the expression
3818 * evaluation has been cancelled due to an aborting error, an
3819 * interrupt, or an exception.
3820 */
3821 if (!aborting())
3822 {
3823 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003824 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 }
3826 else
3827 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3828 goto theend;
3829 }
3830
3831 if (lv.ll_tv != NULL)
3832 {
3833 if (fdp != NULL)
3834 {
3835 fdp->fd_dict = lv.ll_dict;
3836 fdp->fd_newkey = lv.ll_newkey;
3837 lv.ll_newkey = NULL;
3838 fdp->fd_di = lv.ll_di;
3839 }
3840 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3841 {
3842 name = vim_strsave(lv.ll_tv->vval.v_string);
3843 *pp = end;
3844 }
3845 else if (lv.ll_tv->v_type == VAR_PARTIAL
3846 && lv.ll_tv->vval.v_partial != NULL)
3847 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003848 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 *pp = end;
3850 if (partial != NULL)
3851 *partial = lv.ll_tv->vval.v_partial;
3852 }
3853 else
3854 {
3855 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3856 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003857 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858 else
3859 *pp = end;
3860 name = NULL;
3861 }
3862 goto theend;
3863 }
3864
3865 if (lv.ll_name == NULL)
3866 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003867 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 *pp = end;
3869 goto theend;
3870 }
3871
Bram Moolenaare38eab22019-12-05 21:50:01 +01003872 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 if (lv.ll_exp_name != NULL)
3874 {
3875 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003876 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003877 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878 if (name == lv.ll_exp_name)
3879 name = NULL;
3880 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003881 else if (lv.ll_sid > 0)
3882 {
3883 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3884 int cc = *lv.ll_name_end;
3885
3886 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3887 *lv.ll_name_end = NUL;
3888 if (si->sn_autoload_prefix != NULL)
3889 {
3890 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3891 }
3892 else
3893 {
3894 sid_buf[0] = K_SPECIAL;
3895 sid_buf[1] = KS_EXTRA;
3896 sid_buf[2] = (int)KE_SNR;
3897 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003898 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003899 name = concat_str(sid_buf, lv.ll_name);
3900 }
3901 *lv.ll_name_end = cc;
3902 *pp = end;
3903 goto theend;
3904 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003905 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906 {
3907 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003908 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003909 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910 if (name == *pp)
3911 name = NULL;
3912 }
3913 if (name != NULL)
3914 {
3915 name = vim_strsave(name);
3916 *pp = end;
3917 if (STRNCMP(name, "<SNR>", 5) == 0)
3918 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003919 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 name[0] = K_SPECIAL;
3921 name[1] = KS_EXTRA;
3922 name[2] = (int)KE_SNR;
3923 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3924 }
3925 goto theend;
3926 }
3927
3928 if (lv.ll_exp_name != NULL)
3929 {
3930 len = (int)STRLEN(lv.ll_exp_name);
3931 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3932 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3933 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003934 // When there was "s:" already or the name expanded to get a
3935 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 lv.ll_name += 2;
3937 len -= 2;
3938 lead = 2;
3939 }
3940 }
3941 else
3942 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003943 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003945 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003946 if (lv.ll_name[0] == 'g')
3947 {
3948 if (is_global != NULL)
3949 {
3950 *is_global = TRUE;
3951 }
3952 else
3953 {
3954 // dropping "g:" without setting "is_global" won't work in
3955 // Vim9script, put it back later
3956 prefix_g = TRUE;
3957 extra = 2;
3958 }
3959 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003961 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003962 len = (int)(end - lv.ll_name);
3963 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003964 if (len <= 0)
3965 {
3966 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003967 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003968 goto theend;
3969 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003971 // In Vim9 script a user function is script-local by default, unless it
3972 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003973 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003974
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003975 /*
3976 * Copy the function name to allocated memory.
3977 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3978 * Accept <SNR>123_name() outside a script.
3979 */
3980 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003981 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003982 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003984 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003985 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003986 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
Bram Moolenaar3787f262022-02-07 21:54:01 +00003987 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003988 semsg(_(vim9script
Bram Moolenaar3787f262022-02-07 21:54:01 +00003989 ? e_function_name_must_start_with_capital_str
3990 : e_function_name_must_start_with_capital_or_s_str),
3991 start);
3992 goto theend;
3993 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003994 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00003995 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00003996 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003997 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 || eval_fname_sid(*pp))
3999 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004000 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004001 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004002 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004003 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 goto theend;
4005 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004006 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004007 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004008 extra = 3 + (int)STRLEN(sid_buf);
4009 else
4010 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 }
4012 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004013 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004014 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004016 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004017 : e_function_name_must_start_with_capital_or_s_str),
4018 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004019 goto theend;
4020 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004021 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022 {
4023 char_u *cp = vim_strchr(lv.ll_name, ':');
4024
4025 if (cp != NULL && cp < end)
4026 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004027 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028 goto theend;
4029 }
4030 }
4031
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004032 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 if (name != NULL)
4034 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004035 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 {
4037 name[0] = K_SPECIAL;
4038 name[1] = KS_EXTRA;
4039 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004040 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 STRCPY(name + 3, sid_buf);
4042 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004043 else if (prefix_g)
4044 {
4045 name[0] = 'g';
4046 name[1] = ':';
4047 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004048 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4049 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050 }
4051 *pp = end;
4052
4053theend:
4054 clear_lval(&lv);
4055 return name;
4056}
4057
4058/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004059 * Assuming "name" is the result of trans_function_name() and it was prefixed
4060 * to use the script-local name, return the unmodified name (points into
4061 * "name"). Otherwise return NULL.
4062 * This can be used to first search for a script-local function and fall back
4063 * to the global function if not found.
4064 */
4065 char_u *
4066untrans_function_name(char_u *name)
4067{
4068 char_u *p;
4069
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004070 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004071 {
4072 p = vim_strchr(name, '_');
4073 if (p != NULL)
4074 return p + 1;
4075 }
4076 return NULL;
4077}
4078
4079/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004080 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4081 * current script ID and returns the expanded function name. The caller should
4082 * free the returned name. If not called from a script context or the function
4083 * name doesn't start with these prefixes, then returns NULL.
4084 * This doesn't check whether the script-local function exists or not.
4085 */
4086 char_u *
4087get_scriptlocal_funcname(char_u *funcname)
4088{
4089 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004090 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004091 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004092 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004093
4094 if (funcname == NULL)
4095 return NULL;
4096
4097 if (STRNCMP(funcname, "s:", 2) != 0
4098 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004099 {
4100 ufunc_T *ufunc;
4101
4102 // The function name does not have a script-local prefix. Try finding
4103 // it when in a Vim9 script and there is no "g:" prefix.
4104 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4105 return NULL;
4106 ufunc = find_func(funcname, FALSE);
4107 if (ufunc == NULL || func_is_global(ufunc)
4108 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4109 return NULL;
4110 ++p;
4111 off = 0;
4112 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004113 else
4114 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004115
4116 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4117 {
4118 emsg(_(e_using_sid_not_in_script_context));
4119 return NULL;
4120 }
4121 // Expand s: prefix into <SNR>nr_<name>
4122 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4123 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004124 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004125 if (newname == NULL)
4126 return NULL;
4127 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004128 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004129
4130 return newname;
4131}
4132
4133/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004134 * Return script-local "fname" with the 3-byte sequence replaced by
4135 * printable <SNR> in allocated memory.
4136 */
4137 char_u *
4138alloc_printable_func_name(char_u *fname)
4139{
4140 char_u *n = alloc(STRLEN(fname + 3) + 6);
4141
4142 if (n != NULL)
4143 {
4144 STRCPY(n, "<SNR>");
4145 STRCPY(n + 5, fname + 3);
4146 }
4147 return n;
4148}
4149
4150/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004151 * Call trans_function_name(), except that a lambda is returned as-is.
4152 * Returns the name in allocated memory.
4153 */
4154 char_u *
4155save_function_name(
4156 char_u **name,
4157 int *is_global,
4158 int skip,
4159 int flags,
4160 funcdict_T *fudi)
4161{
4162 char_u *p = *name;
4163 char_u *saved;
4164
4165 if (STRNCMP(p, "<lambda>", 8) == 0)
4166 {
4167 p += 8;
4168 (void)getdigits(&p);
4169 saved = vim_strnsave(*name, p - *name);
4170 if (fudi != NULL)
4171 CLEAR_POINTER(fudi);
4172 }
4173 else
4174 saved = trans_function_name(&p, is_global, skip,
4175 flags, fudi, NULL, NULL);
4176 *name = p;
4177 return saved;
4178}
4179
4180/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004181 * List functions. When "regmatch" is NULL all of then.
4182 * Otherwise functions matching "regmatch".
4183 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004184 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004185list_functions(regmatch_T *regmatch)
4186{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004187 int changed = func_hashtab.ht_changed;
4188 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004189 hashitem_T *hi;
4190
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004191 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004192 {
4193 if (!HASHITEM_EMPTY(hi))
4194 {
4195 ufunc_T *fp = HI2UF(hi);
4196
4197 --todo;
4198 if ((fp->uf_flags & FC_DEAD) == 0
4199 && (regmatch == NULL
4200 ? !message_filtered(fp->uf_name)
4201 && !func_name_refcount(fp->uf_name)
4202 : !isdigit(*fp->uf_name)
4203 && vim_regexec(regmatch, fp->uf_name, 0)))
4204 {
4205 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004206 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004207 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004208 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004209 return;
4210 }
4211 }
4212 }
4213 }
4214}
4215
4216/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004217 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004218 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4219 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004220 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004221 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004223 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004224define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004225{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004226 int j;
4227 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004228 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004229 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004230 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231 char_u *p;
4232 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004233 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234 char_u *line_arg = NULL;
4235 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004236 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004237 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238 garray_T newlines;
4239 int varargs = FALSE;
4240 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004241 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004242 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004243 int fp_allocated = FALSE;
4244 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004245 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004246 dictitem_T *v;
4247 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004248 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004249 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004251 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004252 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004253 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254
4255 /*
4256 * ":function" without argument: list functions.
4257 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004258 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259 {
4260 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004261 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004262 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004263 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 }
4265
4266 /*
4267 * ":function /pat": list functions matching pattern.
4268 */
4269 if (*eap->arg == '/')
4270 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004271 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004272 if (!eap->skip)
4273 {
4274 regmatch_T regmatch;
4275
4276 c = *p;
4277 *p = NUL;
4278 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4279 *p = c;
4280 if (regmatch.regprog != NULL)
4281 {
4282 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004283 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004284 vim_regfree(regmatch.regprog);
4285 }
4286 }
4287 if (*p == '/')
4288 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004289 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004290 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004291 }
4292
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004293 ga_init(&newargs);
4294 ga_init(&argtypes);
4295 ga_init(&default_args);
4296
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 /*
4298 * Get the function name. There are these situations:
4299 * func normal function name
4300 * "name" == func, "fudi.fd_dict" == NULL
4301 * dict.func new dictionary entry
4302 * "name" == NULL, "fudi.fd_dict" set,
4303 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4304 * dict.func existing dict entry with a Funcref
4305 * "name" == func, "fudi.fd_dict" set,
4306 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4307 * dict.func existing dict entry that's not a Funcref
4308 * "name" == NULL, "fudi.fd_dict" set,
4309 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4310 * s:func script-local function name
4311 * g:func global function name, same as "func"
4312 */
4313 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004314 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004316 // nested function, argument is (args).
4317 paren = TRUE;
4318 CLEAR_FIELD(fudi);
4319 }
4320 else
4321 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004322 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004323 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004324 if (p[0] == 's' && p[1] == ':')
4325 {
4326 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4327 return NULL;
4328 }
4329 p = to_name_end(p, TRUE);
4330 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4331 {
4332 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4333 eap->arg);
4334 return NULL;
4335 }
4336 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004337 }
4338
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004339 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004340 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004341 paren = (vim_strchr(p, '(') != NULL);
4342 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004343 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004344 /*
4345 * Return on an invalid expression in braces, unless the expression
4346 * evaluation has been cancelled due to an aborting error, an
4347 * interrupt, or an exception.
4348 */
4349 if (!aborting())
4350 {
4351 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004352 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004353 vim_free(fudi.fd_newkey);
4354 return NULL;
4355 }
4356 else
4357 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004359
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004360 // For "export def FuncName()" in an autoload script the function name
4361 // is stored with the legacy autoload name "dir#script#FuncName" so
4362 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004363 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004364 {
4365 char_u *prefixed = may_prefix_autoload(name);
4366
4367 if (prefixed != NULL && prefixed != name)
4368 {
4369 vim_free(name);
4370 name = prefixed;
4371 }
4372 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004373 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004374 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004375 {
4376 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4377 goto ret_free;
4378 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004379 }
4380
Bram Moolenaare38eab22019-12-05 21:50:01 +01004381 // An error in a function call during evaluation of an expression in magic
4382 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383 saved_did_emsg = did_emsg;
4384 did_emsg = FALSE;
4385
4386 /*
4387 * ":function func" with only function name: list function.
4388 */
4389 if (!paren)
4390 {
4391 if (!ends_excmd(*skipwhite(p)))
4392 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004393 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 goto ret_free;
4395 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004396 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397 if (eap->nextcmd != NULL)
4398 *p = NUL;
4399 if (!eap->skip && !got_int)
4400 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004401 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004402 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4403 {
4404 char_u *up = untrans_function_name(name);
4405
4406 // With Vim9 script the name was made script-local, if not
4407 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004408 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004409 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004410 }
4411
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004412 if (fp != NULL)
4413 {
4414 list_func_head(fp, TRUE);
4415 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4416 {
4417 if (FUNCLINE(fp, j) == NULL)
4418 continue;
4419 msg_putchar('\n');
4420 msg_outnum((long)(j + 1));
4421 if (j < 9)
4422 msg_putchar(' ');
4423 if (j < 99)
4424 msg_putchar(' ');
4425 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004426 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 ui_breakcheck();
4428 }
4429 if (!got_int)
4430 {
4431 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004432 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004433 msg_puts(" enddef");
4434 else
4435 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 }
4437 }
4438 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004439 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 }
4441 goto ret_free;
4442 }
4443
4444 /*
4445 * ":function name(arg1, arg2)" Define function.
4446 */
4447 p = skipwhite(p);
4448 if (*p != '(')
4449 {
4450 if (!eap->skip)
4451 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004452 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453 goto ret_free;
4454 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004455 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004456 if (vim_strchr(p, '(') != NULL)
4457 p = vim_strchr(p, '(');
4458 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004460 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4461 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004462 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004463 goto ret_free;
4464 }
4465
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004466 // In Vim9 script only global functions can be redefined.
4467 if (vim9script && eap->forceit && !is_global)
4468 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004469 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004470 goto ret_free;
4471 }
4472
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004473 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474
Bram Moolenaar04b12692020-05-04 23:24:44 +02004475 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004477 // Check the name of the function. Unless it's a dictionary function
4478 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479 if (name != NULL)
4480 arg = name;
4481 else
4482 arg = fudi.fd_newkey;
4483 if (arg != NULL && (fudi.fd_di == NULL
4484 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4485 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4486 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004487 char_u *name_base = arg;
4488 int i;
4489
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004490 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004491 {
4492 name_base = vim_strchr(arg, '_');
4493 if (name_base == NULL)
4494 name_base = arg + 3;
4495 else
4496 ++name_base;
4497 }
4498 for (i = 0; name_base[i] != NUL && (i == 0
4499 ? eval_isnamec1(name_base[i])
4500 : eval_isnamec(name_base[i])); ++i)
4501 ;
4502 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004503 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004504
4505 // In Vim9 script a function cannot have the same name as a
4506 // variable.
4507 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004508 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4509 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004510 + EVAL_VAR_NO_FUNC) == OK)
4511 {
4512 semsg(_(e_redefining_script_item_str), name_base);
4513 goto ret_free;
4514 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004516 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004518 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004519 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004520 goto ret_free;
4521 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004522 }
4523
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004524 // This may get more lines and make the pointers into the first line
4525 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004526 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004527 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004528 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004529 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004530 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004531 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004532 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004533
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004534 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004536 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004537 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004538 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004539 if (*p != ':')
4540 {
4541 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4542 p = skipwhite(p);
4543 }
4544 else if (!IS_WHITE_OR_NUL(p[1]))
4545 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004546 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004547 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004548 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004549 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004550 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004551 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004552 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004553 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004554 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004555 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004556 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004557 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004558 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004560 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004561 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004562 else
4563 // find extra arguments "range", "dict", "abort" and "closure"
4564 for (;;)
4565 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004566 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004567 p = skipwhite(p);
4568 if (STRNCMP(p, "range", 5) == 0)
4569 {
4570 flags |= FC_RANGE;
4571 p += 5;
4572 }
4573 else if (STRNCMP(p, "dict", 4) == 0)
4574 {
4575 flags |= FC_DICT;
4576 p += 4;
4577 }
4578 else if (STRNCMP(p, "abort", 5) == 0)
4579 {
4580 flags |= FC_ABORT;
4581 p += 5;
4582 }
4583 else if (STRNCMP(p, "closure", 7) == 0)
4584 {
4585 flags |= FC_CLOSURE;
4586 p += 7;
4587 if (current_funccal == NULL)
4588 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004589 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004590 name == NULL ? (char_u *)"" : name);
4591 goto erret;
4592 }
4593 }
4594 else
4595 break;
4596 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004597
Bram Moolenaare38eab22019-12-05 21:50:01 +01004598 // When there is a line break use what follows for the function body.
4599 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 if (*p == '\n')
4601 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004602 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004603 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4604 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004605 && !(VIM_ISWHITE(*whitep) && *p == '#'
4606 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004607 && !eap->skip
4608 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004609 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004610
4611 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004612 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4613 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614 */
4615 if (KeyTyped)
4616 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004617 // Check if the function already exists, don't let the user type the
4618 // whole function before telling him it doesn't work! For a script we
4619 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004620 if (!eap->skip && !eap->forceit)
4621 {
4622 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004623 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004624 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004625 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004626 }
4627
4628 if (!eap->skip && did_emsg)
4629 goto erret;
4630
Bram Moolenaare38eab22019-12-05 21:50:01 +01004631 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632 cmdline_row = msg_row;
4633 }
4634
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004635 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004636 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004637
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004638 // Do not define the function when getting the body fails and when
4639 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004640 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004641 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 goto erret;
4643
4644 /*
4645 * If there are no errors, add the function
4646 */
4647 if (fudi.fd_dict == NULL)
4648 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004649 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004650 char_u *find_name = name;
4651 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004652 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004653
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004654 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004655 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004656 var_conflict = TRUE;
4657
4658 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4659 {
4660 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4661
4662 if (si->sn_autoload_prefix != NULL)
4663 {
4664 if (is_export)
4665 {
4666 find_name = name + STRLEN(si->sn_autoload_prefix);
4667 v = find_var(find_name, &ht, TRUE);
4668 if (v != NULL)
4669 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004670 // Only check if the function already exists in the script,
4671 // global functions can be shadowed.
4672 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004673 }
4674 else
4675 {
4676 char_u *prefixed = may_prefix_autoload(name);
4677
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004678 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004679 {
4680 v = find_var(prefixed, &ht, TRUE);
4681 if (v != NULL)
4682 var_conflict = TRUE;
4683 vim_free(prefixed);
4684 }
4685 }
4686 }
4687 }
4688 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004690 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691 goto erret;
4692 }
4693
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004694 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004695 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004697 char_u *uname = untrans_function_name(name);
4698
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004699 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004700 }
4701
4702 if (fp != NULL || import != NULL)
4703 {
4704 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004705
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004706 // Function can be replaced with "function!" and when sourcing the
4707 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004708 // A name that is used by an import can not be overruled.
4709 if (import != NULL
4710 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004711 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004712 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004714 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004715 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004716 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004717 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004718 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719 goto erret;
4720 }
4721 if (fp->uf_calls > 0)
4722 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004723 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004724 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725 goto erret;
4726 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004727 if (fp->uf_refcount > 1)
4728 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004729 // This function is referenced somewhere, don't redefine it but
4730 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004731 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004732 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004733 fp = NULL;
4734 overwrite = TRUE;
4735 }
4736 else
4737 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004738 char_u *exp_name = fp->uf_name_exp;
4739
4740 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004741 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004742 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004743 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004744 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004745 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004746#ifdef FEAT_PROFILE
4747 fp->uf_profiling = FALSE;
4748 fp->uf_prof_initialized = FALSE;
4749#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004750 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004751 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752 }
4753 }
4754 else
4755 {
4756 char numbuf[20];
4757
4758 fp = NULL;
4759 if (fudi.fd_newkey == NULL && !eap->forceit)
4760 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004761 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 goto erret;
4763 }
4764 if (fudi.fd_di == NULL)
4765 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004766 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004767 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 goto erret;
4769 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004770 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004771 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004772 goto erret;
4773
Bram Moolenaare38eab22019-12-05 21:50:01 +01004774 // Give the function a sequential number. Can only be used with a
4775 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004776 vim_free(name);
4777 sprintf(numbuf, "%d", ++func_nr);
4778 name = vim_strsave((char_u *)numbuf);
4779 if (name == NULL)
4780 goto erret;
4781 }
4782
4783 if (fp == NULL)
4784 {
4785 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4786 {
4787 int slen, plen;
4788 char_u *scriptname;
4789
Bram Moolenaare38eab22019-12-05 21:50:01 +01004790 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004791 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004792 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 {
4794 scriptname = autoload_name(name);
4795 if (scriptname != NULL)
4796 {
4797 p = vim_strchr(scriptname, '/');
4798 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004799 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004801 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004802 j = OK;
4803 vim_free(scriptname);
4804 }
4805 }
4806 if (j == FAIL)
4807 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004808 linenr_T save_lnum = SOURCING_LNUM;
4809
4810 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004811 semsg(_(e_function_name_does_not_match_script_file_name_str),
4812 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004813 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004814 goto erret;
4815 }
4816 }
4817
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004818 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 if (fp == NULL)
4820 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004821 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004822
4823 if (fudi.fd_dict != NULL)
4824 {
4825 if (fudi.fd_di == NULL)
4826 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004827 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004828 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4829 if (fudi.fd_di == NULL)
4830 {
4831 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004832 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 goto erret;
4834 }
4835 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4836 {
4837 vim_free(fudi.fd_di);
4838 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004839 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004840 goto erret;
4841 }
4842 }
4843 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004844 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845 clear_tv(&fudi.fd_di->di_tv);
4846 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848
Bram Moolenaare38eab22019-12-05 21:50:01 +01004849 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004850 flags |= FC_DICT;
4851 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004852 }
4853 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004854 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004855 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004856 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004857
4858 if (eap->cmdidx == CMD_def)
4859 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004860 int lnum_save = SOURCING_LNUM;
4861 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004862
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004863 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004864
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004865 // error messages are for the first function line
4866 SOURCING_LNUM = sourcing_lnum_top;
4867
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004868 // The function may use script variables from the context.
4869 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004870
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004871 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004872 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004873 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004874 free_fp = fp_allocated;
4875 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004876 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004877 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004878
4879 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004880 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004881 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004882 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004883 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004884 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004885 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004886 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004887 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004888 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004889 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004890
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004891 if (fp_allocated)
4892 {
4893 // insert the new function in the function list
4894 set_ufunc_name(fp, name);
4895 if (overwrite)
4896 {
4897 hi = hash_find(&func_hashtab, name);
4898 hi->hi_key = UF2HIKEY(fp);
4899 }
4900 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4901 {
4902 free_fp = TRUE;
4903 goto erret;
4904 }
4905 fp->uf_refcount = 1;
4906 }
4907
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004909 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004910 if ((flags & FC_CLOSURE) != 0)
4911 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004912 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004913 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004914 }
4915 else
4916 fp->uf_scoped = NULL;
4917
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004918#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919 if (prof_def_func())
4920 func_do_profile(fp);
4921#endif
4922 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004923 if (sandbox)
4924 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004925 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004926 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927 fp->uf_flags = flags;
4928 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004929 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004930 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004931 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004932 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004933 if (is_export)
4934 {
4935 fp->uf_flags |= FC_EXPORT;
4936 // let ex_export() know the export worked.
4937 is_export = FALSE;
4938 }
4939
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004940 if (eap->cmdidx == CMD_def)
4941 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004942 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4943 // :func does not use Vim9 script syntax, even in a Vim9 script file
4944 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004945
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 goto ret_free;
4947
4948erret:
4949 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004950 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004951 if (fp != NULL)
4952 {
4953 ga_init(&fp->uf_args);
4954 ga_init(&fp->uf_def_args);
4955 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956errret_2:
4957 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004958 if (fp != NULL)
4959 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004960 if (free_fp)
4961 {
4962 vim_free(fp);
4963 fp = NULL;
4964 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004966 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004967 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004968 if (name != name_arg)
4969 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004970 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004972
4973 return fp;
4974}
4975
4976/*
4977 * ":function"
4978 */
4979 void
4980ex_function(exarg_T *eap)
4981{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004982 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004983
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004984 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4985 (void)define_function(eap, NULL, &lines_to_free);
4986 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004987}
4988
4989/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004990 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004991 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004992 */
4993 void
4994ex_defcompile(exarg_T *eap UNUSED)
4995{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004996 long todo = (long)func_hashtab.ht_used;
4997 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004998 hashitem_T *hi;
4999 ufunc_T *ufunc;
5000
5001 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5002 {
5003 if (!HASHITEM_EMPTY(hi))
5004 {
5005 --todo;
5006 ufunc = HI2UF(hi);
5007 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005008 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5009 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005010 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02005011 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005012
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02005013 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005014 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02005015 // a function has been added or removed, need to start over
5016 todo = (long)func_hashtab.ht_used;
5017 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005018 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02005019 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005020 }
5021 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005022 }
5023 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005024}
5025
5026/*
5027 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5028 * Return 2 if "p" starts with "s:".
5029 * Return 0 otherwise.
5030 */
5031 int
5032eval_fname_script(char_u *p)
5033{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005034 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5035 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005036 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5037 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5038 return 5;
5039 if (p[0] == 's' && p[1] == ':')
5040 return 2;
5041 return 0;
5042}
5043
5044 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005045translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005046{
5047 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005048 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005049 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005050}
5051
5052/*
5053 * Return TRUE when "ufunc" has old-style "..." varargs
5054 * or named varargs "...name: type".
5055 */
5056 int
5057has_varargs(ufunc_T *ufunc)
5058{
5059 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005060}
5061
5062/*
5063 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005064 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 */
5066 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005067function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068{
5069 char_u *nm = name;
5070 char_u *p;
5071 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005072 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005073 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005075 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5076 if (no_deref)
5077 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005078 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005079 nm = skipwhite(nm);
5080
Bram Moolenaare38eab22019-12-05 21:50:01 +01005081 // Only accept "funcname", "funcname ", "funcname (..." and
5082 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005083 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005084 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085 vim_free(p);
5086 return n;
5087}
5088
Bram Moolenaar113e1072019-01-20 15:30:40 +01005089#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005090 char_u *
5091get_expanded_name(char_u *name, int check)
5092{
5093 char_u *nm = name;
5094 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005095 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005096
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005097 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005098 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005099
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005100 if (p != NULL && *nm == NUL
5101 && (!check || translated_function_exists(p, is_global)))
5102 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005103
5104 vim_free(p);
5105 return NULL;
5106}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005107#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005108
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109/*
5110 * Function given to ExpandGeneric() to obtain the list of user defined
5111 * function names.
5112 */
5113 char_u *
5114get_user_func_name(expand_T *xp, int idx)
5115{
5116 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005117 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005118 static hashitem_T *hi;
5119 ufunc_T *fp;
5120
5121 if (idx == 0)
5122 {
5123 done = 0;
5124 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005125 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005127 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128 {
5129 if (done++ > 0)
5130 ++hi;
5131 while (HASHITEM_EMPTY(hi))
5132 ++hi;
5133 fp = HI2UF(hi);
5134
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005135 // don't show dead, dict and lambda functions
5136 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005137 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005138 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005139
5140 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005141 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005142
5143 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005144 if (xp->xp_context != EXPAND_USER_FUNC
5145 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146 {
5147 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005148 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005149 STRCAT(IObuff, ")");
5150 }
5151 return IObuff;
5152 }
5153 return NULL;
5154}
5155
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156/*
5157 * ":delfunction {name}"
5158 */
5159 void
5160ex_delfunction(exarg_T *eap)
5161{
5162 ufunc_T *fp = NULL;
5163 char_u *p;
5164 char_u *name;
5165 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005166 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005167
5168 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005169 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5170 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171 vim_free(fudi.fd_newkey);
5172 if (name == NULL)
5173 {
5174 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005175 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005176 return;
5177 }
5178 if (!ends_excmd(*skipwhite(p)))
5179 {
5180 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005181 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005182 return;
5183 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005184 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005185 if (eap->nextcmd != NULL)
5186 *p = NUL;
5187
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005188 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005189 {
5190 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005191 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005192 vim_free(name);
5193 return;
5194 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005195 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005196 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005197 vim_free(name);
5198
5199 if (!eap->skip)
5200 {
5201 if (fp == NULL)
5202 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005203 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005204 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005205 return;
5206 }
5207 if (fp->uf_calls > 0)
5208 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005209 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005210 return;
5211 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005212 if (fp->uf_flags & FC_VIM9)
5213 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005214 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005215 return;
5216 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005217
5218 if (fudi.fd_dict != NULL)
5219 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005220 // Delete the dict item that refers to the function, it will
5221 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005222 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5223 }
5224 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005225 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005226 // A normal function (not a numbered function or lambda) has a
5227 // refcount of 1 for the entry in the hashtable. When deleting
5228 // it and the refcount is more than one, it should be kept.
5229 // A numbered function and lambda should be kept if the refcount is
5230 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005231 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005232 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005233 // Function is still referenced somewhere. Don't free it but
5234 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005235 if (func_remove(fp))
5236 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005237 }
5238 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005239 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005240 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241 }
5242}
5243
5244/*
5245 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005246 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247 */
5248 void
5249func_unref(char_u *name)
5250{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005251 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005252
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005253 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005254 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005255 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005256 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005259 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005260#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005261 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005262 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005263 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005264}
5265
5266/*
5267 * Unreference a Function: decrement the reference count and free it when it
5268 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005269 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005270 */
5271 void
5272func_ptr_unref(ufunc_T *fp)
5273{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005274 if (fp != NULL && (--fp->uf_refcount <= 0
5275 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5276 && fp->uf_partial->pt_refcount <= 1
5277 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005278 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005279 // Only delete it when it's not being used. Otherwise it's done
5280 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005281 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005282 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005283 }
5284}
5285
5286/*
5287 * Count a reference to a Function.
5288 */
5289 void
5290func_ref(char_u *name)
5291{
5292 ufunc_T *fp;
5293
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005294 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005295 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005296 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005297 if (fp != NULL)
5298 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005299 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005300 // Only give an error for a numbered function.
5301 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005302 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005303}
5304
5305/*
5306 * Count a reference to a Function.
5307 */
5308 void
5309func_ptr_ref(ufunc_T *fp)
5310{
5311 if (fp != NULL)
5312 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005313}
5314
5315/*
5316 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5317 * referenced from anywhere that is in use.
5318 */
5319 static int
5320can_free_funccal(funccall_T *fc, int copyID)
5321{
5322 return (fc->l_varlist.lv_copyID != copyID
5323 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005324 && fc->l_avars.dv_copyID != copyID
5325 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005326}
5327
5328/*
5329 * ":return [expr]"
5330 */
5331 void
5332ex_return(exarg_T *eap)
5333{
5334 char_u *arg = eap->arg;
5335 typval_T rettv;
5336 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005337 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005338
5339 if (current_funccal == NULL)
5340 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005341 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342 return;
5343 }
5344
Bram Moolenaar844fb642021-10-23 13:32:30 +01005345 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005346 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5347
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 if (eap->skip)
5349 ++emsg_skip;
5350
5351 eap->nextcmd = NULL;
5352 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005353 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005354 {
5355 if (!eap->skip)
5356 returning = do_return(eap, FALSE, TRUE, &rettv);
5357 else
5358 clear_tv(&rettv);
5359 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005360 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005361 else if (!eap->skip)
5362 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005363 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005364 update_force_abort();
5365
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005366 /*
5367 * Return unless the expression evaluation has been cancelled due to an
5368 * aborting error, an interrupt, or an exception.
5369 */
5370 if (!aborting())
5371 returning = do_return(eap, FALSE, TRUE, NULL);
5372 }
5373
Bram Moolenaare38eab22019-12-05 21:50:01 +01005374 // When skipping or the return gets pending, advance to the next command
5375 // in this line (!returning). Otherwise, ignore the rest of the line.
5376 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005377 if (returning)
5378 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005379 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005380 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005381
5382 if (eap->skip)
5383 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005384 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385}
5386
5387/*
5388 * ":1,25call func(arg1, arg2)" function call.
5389 */
5390 void
5391ex_call(exarg_T *eap)
5392{
5393 char_u *arg = eap->arg;
5394 char_u *startarg;
5395 char_u *name;
5396 char_u *tofree;
5397 int len;
5398 typval_T rettv;
5399 linenr_T lnum;
5400 int doesrange;
5401 int failed = FALSE;
5402 funcdict_T fudi;
5403 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005404 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005405 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005406 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005407 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005408
Bram Moolenaare6b53242020-07-01 17:28:33 +02005409 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005410 if (eap->skip)
5411 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005412 // trans_function_name() doesn't work well when skipping, use eval0()
5413 // instead to skip to any following command, e.g. for:
5414 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005415 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005416 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005417 clear_tv(&rettv);
5418 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005419 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005420 return;
5421 }
5422
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005423 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005424 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005425 if (fudi.fd_newkey != NULL)
5426 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005427 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005428 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005429 vim_free(fudi.fd_newkey);
5430 }
5431 if (tofree == NULL)
5432 return;
5433
Bram Moolenaare38eab22019-12-05 21:50:01 +01005434 // Increase refcount on dictionary, it could get deleted when evaluating
5435 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005436 if (fudi.fd_dict != NULL)
5437 ++fudi.fd_dict->dv_refcount;
5438
Bram Moolenaare38eab22019-12-05 21:50:01 +01005439 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5440 // contents. For VAR_PARTIAL get its partial, unless we already have one
5441 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005443 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005444 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005445 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005446
Bram Moolenaare38eab22019-12-05 21:50:01 +01005447 // Skip white space to allow ":call func ()". Not good, but required for
5448 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005449 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005450 if (*startarg != '(')
5451 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005452 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 goto end;
5454 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005455 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005456 {
5457 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5458 goto end;
5459 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005460
5461 /*
5462 * When skipping, evaluate the function once, to find the end of the
5463 * arguments.
5464 * When the function takes a range, this is discovered after the first
5465 * call, and the loop is broken.
5466 */
5467 if (eap->skip)
5468 {
5469 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005470 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005471 }
5472 else
5473 lnum = eap->line1;
5474 for ( ; lnum <= eap->line2; ++lnum)
5475 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005476 funcexe_T funcexe;
5477
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005478 if (!eap->skip && eap->addr_count > 0)
5479 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005480 if (lnum > curbuf->b_ml.ml_line_count)
5481 {
5482 // If the function deleted lines or switched to another buffer
5483 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005484 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005485 break;
5486 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005487 curwin->w_cursor.lnum = lnum;
5488 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005489 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005490 }
5491 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005492
Bram Moolenaara80faa82020-04-12 19:37:17 +02005493 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005494 funcexe.fe_firstline = eap->line1;
5495 funcexe.fe_lastline = eap->line2;
5496 funcexe.fe_doesrange = &doesrange;
5497 funcexe.fe_evaluate = !eap->skip;
5498 funcexe.fe_partial = partial;
5499 funcexe.fe_selfdict = fudi.fd_dict;
5500 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005501 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005502 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005503 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005504 {
5505 failed = TRUE;
5506 break;
5507 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005508 if (has_watchexpr())
5509 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005510
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005511 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005512 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005513 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005514 {
5515 failed = TRUE;
5516 break;
5517 }
5518
5519 clear_tv(&rettv);
5520 if (doesrange || eap->skip)
5521 break;
5522
Bram Moolenaare38eab22019-12-05 21:50:01 +01005523 // Stop when immediately aborting on error, or when an interrupt
5524 // occurred or an exception was thrown but not caught.
5525 // get_func_tv() returned OK, so that the check for trailing
5526 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005527 if (aborting())
5528 break;
5529 }
5530 if (eap->skip)
5531 --emsg_skip;
5532
Bram Moolenaar1d341892021-09-18 15:25:52 +02005533 // When inside :try we need to check for following "| catch" or "| endtry".
5534 // Not when there was an error, but do check if an exception was thrown.
5535 if ((!aborting() || did_throw)
5536 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005537 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005538 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005539 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005540 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005541 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005542 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005543 {
5544 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005545 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005546 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005547 }
5548 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005549 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005550 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005551 // Must be after using "arg", it may point into memory cleared here.
5552 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005553
5554end:
5555 dict_unref(fudi.fd_dict);
5556 vim_free(tofree);
5557}
5558
5559/*
5560 * Return from a function. Possibly makes the return pending. Also called
5561 * for a pending return at the ":endtry" or after returning from an extra
5562 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5563 * when called due to a ":return" command. "rettv" may point to a typval_T
5564 * with the return rettv. Returns TRUE when the return can be carried out,
5565 * FALSE when the return gets pending.
5566 */
5567 int
5568do_return(
5569 exarg_T *eap,
5570 int reanimate,
5571 int is_cmd,
5572 void *rettv)
5573{
5574 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005575 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005576
5577 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005578 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005579 current_funccal->returned = FALSE;
5580
5581 /*
5582 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5583 * not in its finally clause (which then is to be executed next) is found.
5584 * In this case, make the ":return" pending for execution at the ":endtry".
5585 * Otherwise, return normally.
5586 */
5587 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5588 if (idx >= 0)
5589 {
5590 cstack->cs_pending[idx] = CSTP_RETURN;
5591
5592 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005593 // A pending return again gets pending. "rettv" points to an
5594 // allocated variable with the rettv of the original ":return"'s
5595 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005596 cstack->cs_rettv[idx] = rettv;
5597 else
5598 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005599 // When undoing a return in order to make it pending, get the stored
5600 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005601 if (reanimate)
5602 rettv = current_funccal->rettv;
5603
5604 if (rettv != NULL)
5605 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005606 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005607 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5608 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5609 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005610 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005611 }
5612 else
5613 cstack->cs_rettv[idx] = NULL;
5614
5615 if (reanimate)
5616 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005617 // The pending return value could be overwritten by a ":return"
5618 // without argument in a finally clause; reset the default
5619 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005620 current_funccal->rettv->v_type = VAR_NUMBER;
5621 current_funccal->rettv->vval.v_number = 0;
5622 }
5623 }
5624 report_make_pending(CSTP_RETURN, rettv);
5625 }
5626 else
5627 {
5628 current_funccal->returned = TRUE;
5629
Bram Moolenaare38eab22019-12-05 21:50:01 +01005630 // If the return is carried out now, store the return value. For
5631 // a return immediately after reanimation, the value is already
5632 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005633 if (!reanimate && rettv != NULL)
5634 {
5635 clear_tv(current_funccal->rettv);
5636 *current_funccal->rettv = *(typval_T *)rettv;
5637 if (!is_cmd)
5638 vim_free(rettv);
5639 }
5640 }
5641
5642 return idx < 0;
5643}
5644
5645/*
5646 * Free the variable with a pending return value.
5647 */
5648 void
5649discard_pending_return(void *rettv)
5650{
5651 free_tv((typval_T *)rettv);
5652}
5653
5654/*
5655 * Generate a return command for producing the value of "rettv". The result
5656 * is an allocated string. Used by report_pending() for verbose messages.
5657 */
5658 char_u *
5659get_return_cmd(void *rettv)
5660{
5661 char_u *s = NULL;
5662 char_u *tofree = NULL;
5663 char_u numbuf[NUMBUFLEN];
5664
5665 if (rettv != NULL)
5666 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5667 if (s == NULL)
5668 s = (char_u *)"";
5669
5670 STRCPY(IObuff, ":return ");
5671 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5672 if (STRLEN(s) + 8 >= IOSIZE)
5673 STRCPY(IObuff + IOSIZE - 4, "...");
5674 vim_free(tofree);
5675 return vim_strsave(IObuff);
5676}
5677
5678/*
5679 * Get next function line.
5680 * Called by do_cmdline() to get the next line.
5681 * Returns allocated string, or NULL for end of function.
5682 */
5683 char_u *
5684get_func_line(
5685 int c UNUSED,
5686 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005687 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005688 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005689{
5690 funccall_T *fcp = (funccall_T *)cookie;
5691 ufunc_T *fp = fcp->func;
5692 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005693 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005694
Bram Moolenaare38eab22019-12-05 21:50:01 +01005695 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005696 if (fcp->dbg_tick != debug_tick)
5697 {
5698 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005699 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005700 fcp->dbg_tick = debug_tick;
5701 }
5702#ifdef FEAT_PROFILE
5703 if (do_profiling == PROF_YES)
5704 func_line_end(cookie);
5705#endif
5706
5707 gap = &fp->uf_lines;
5708 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5709 || fcp->returned)
5710 retval = NULL;
5711 else
5712 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005713 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005714 while (fcp->linenr < gap->ga_len
5715 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5716 ++fcp->linenr;
5717 if (fcp->linenr >= gap->ga_len)
5718 retval = NULL;
5719 else
5720 {
5721 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005722 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005723#ifdef FEAT_PROFILE
5724 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005725 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005726#endif
5727 }
5728 }
5729
Bram Moolenaare38eab22019-12-05 21:50:01 +01005730 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005731 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005732 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005733 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005734 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005735 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005736 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005737 fcp->dbg_tick = debug_tick;
5738 }
5739
5740 return retval;
5741}
5742
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005743/*
5744 * Return TRUE if the currently active function should be ended, because a
5745 * return was encountered or an error occurred. Used inside a ":while".
5746 */
5747 int
5748func_has_ended(void *cookie)
5749{
5750 funccall_T *fcp = (funccall_T *)cookie;
5751
Bram Moolenaare38eab22019-12-05 21:50:01 +01005752 // Ignore the "abort" flag if the abortion behavior has been changed due to
5753 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005754 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5755 || fcp->returned);
5756}
5757
5758/*
5759 * return TRUE if cookie indicates a function which "abort"s on errors.
5760 */
5761 int
5762func_has_abort(
5763 void *cookie)
5764{
5765 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5766}
5767
5768
5769/*
5770 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5771 * Don't do this when "Func" is already a partial that was bound
5772 * explicitly (pt_auto is FALSE).
5773 * Changes "rettv" in-place.
5774 * Returns the updated "selfdict_in".
5775 */
5776 dict_T *
5777make_partial(dict_T *selfdict_in, typval_T *rettv)
5778{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005779 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005780 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005781 char_u fname_buf[FLEN_FIXED + 1];
5782 int error;
5783 dict_T *selfdict = selfdict_in;
5784
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005785 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
5786 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005787 fp = rettv->vval.v_partial->pt_func;
5788 else
5789 {
5790 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005791 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005792 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005793 if (fname == NULL)
5794 {
5795 // There is no point binding a dict to a NULL function, just create
5796 // a function reference.
5797 rettv->v_type = VAR_FUNC;
5798 rettv->vval.v_string = NULL;
5799 }
5800 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00005801 {
5802 char_u *tofree = NULL;
5803
5804 // Translate "s:func" to the stored function name.
5805 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
5806 fp = find_func(fname, FALSE);
5807 vim_free(tofree);
5808 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005809 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005810
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005811 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005812 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005813 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005814
5815 if (pt != NULL)
5816 {
5817 pt->pt_refcount = 1;
5818 pt->pt_dict = selfdict;
5819 pt->pt_auto = TRUE;
5820 selfdict = NULL;
5821 if (rettv->v_type == VAR_FUNC)
5822 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005823 // Just a function: Take over the function name and use
5824 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005825 pt->pt_name = rettv->vval.v_string;
5826 }
5827 else
5828 {
5829 partial_T *ret_pt = rettv->vval.v_partial;
5830 int i;
5831
Bram Moolenaare38eab22019-12-05 21:50:01 +01005832 // Partial: copy the function name, use selfdict and copy
5833 // args. Can't take over name or args, the partial might
5834 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005835 if (ret_pt->pt_name != NULL)
5836 {
5837 pt->pt_name = vim_strsave(ret_pt->pt_name);
5838 func_ref(pt->pt_name);
5839 }
5840 else
5841 {
5842 pt->pt_func = ret_pt->pt_func;
5843 func_ptr_ref(pt->pt_func);
5844 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005845 if (ret_pt->pt_argc > 0)
5846 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005847 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005848 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005849 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005850 pt->pt_argc = 0;
5851 else
5852 {
5853 pt->pt_argc = ret_pt->pt_argc;
5854 for (i = 0; i < pt->pt_argc; i++)
5855 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5856 }
5857 }
5858 partial_unref(ret_pt);
5859 }
5860 rettv->v_type = VAR_PARTIAL;
5861 rettv->vval.v_partial = pt;
5862 }
5863 }
5864 return selfdict;
5865}
5866
5867/*
5868 * Return the name of the executed function.
5869 */
5870 char_u *
5871func_name(void *cookie)
5872{
5873 return ((funccall_T *)cookie)->func->uf_name;
5874}
5875
5876/*
5877 * Return the address holding the next breakpoint line for a funccall cookie.
5878 */
5879 linenr_T *
5880func_breakpoint(void *cookie)
5881{
5882 return &((funccall_T *)cookie)->breakpoint;
5883}
5884
5885/*
5886 * Return the address holding the debug tick for a funccall cookie.
5887 */
5888 int *
5889func_dbg_tick(void *cookie)
5890{
5891 return &((funccall_T *)cookie)->dbg_tick;
5892}
5893
5894/*
5895 * Return the nesting level for a funccall cookie.
5896 */
5897 int
5898func_level(void *cookie)
5899{
5900 return ((funccall_T *)cookie)->level;
5901}
5902
5903/*
5904 * Return TRUE when a function was ended by a ":return" command.
5905 */
5906 int
5907current_func_returned(void)
5908{
5909 return current_funccal->returned;
5910}
5911
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005912 int
5913free_unref_funccal(int copyID, int testing)
5914{
5915 int did_free = FALSE;
5916 int did_free_funccal = FALSE;
5917 funccall_T *fc, **pfc;
5918
5919 for (pfc = &previous_funccal; *pfc != NULL; )
5920 {
5921 if (can_free_funccal(*pfc, copyID))
5922 {
5923 fc = *pfc;
5924 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005925 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005926 did_free = TRUE;
5927 did_free_funccal = TRUE;
5928 }
5929 else
5930 pfc = &(*pfc)->caller;
5931 }
5932 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005933 // When a funccal was freed some more items might be garbage
5934 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005935 (void)garbage_collect(testing);
5936
5937 return did_free;
5938}
5939
5940/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005941 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005942 */
5943 static funccall_T *
5944get_funccal(void)
5945{
5946 int i;
5947 funccall_T *funccal;
5948 funccall_T *temp_funccal;
5949
5950 funccal = current_funccal;
5951 if (debug_backtrace_level > 0)
5952 {
5953 for (i = 0; i < debug_backtrace_level; i++)
5954 {
5955 temp_funccal = funccal->caller;
5956 if (temp_funccal)
5957 funccal = temp_funccal;
5958 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005959 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005960 debug_backtrace_level = i;
5961 }
5962 }
5963 return funccal;
5964}
5965
5966/*
5967 * Return the hashtable used for local variables in the current funccal.
5968 * Return NULL if there is no current funccal.
5969 */
5970 hashtab_T *
5971get_funccal_local_ht()
5972{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005973 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005974 return NULL;
5975 return &get_funccal()->l_vars.dv_hashtab;
5976}
5977
5978/*
5979 * Return the l: scope variable.
5980 * Return NULL if there is no current funccal.
5981 */
5982 dictitem_T *
5983get_funccal_local_var()
5984{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005985 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005986 return NULL;
5987 return &get_funccal()->l_vars_var;
5988}
5989
5990/*
5991 * Return the hashtable used for argument in the current funccal.
5992 * Return NULL if there is no current funccal.
5993 */
5994 hashtab_T *
5995get_funccal_args_ht()
5996{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005997 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005998 return NULL;
5999 return &get_funccal()->l_avars.dv_hashtab;
6000}
6001
6002/*
6003 * Return the a: scope variable.
6004 * Return NULL if there is no current funccal.
6005 */
6006 dictitem_T *
6007get_funccal_args_var()
6008{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006009 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006010 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01006011 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006012}
6013
6014/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006015 * List function variables, if there is a function.
6016 */
6017 void
6018list_func_vars(int *first)
6019{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006020 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006021 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006022 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006023}
6024
6025/*
6026 * If "ht" is the hashtable for local variables in the current funccal, return
6027 * the dict that contains it.
6028 * Otherwise return NULL.
6029 */
6030 dict_T *
6031get_current_funccal_dict(hashtab_T *ht)
6032{
6033 if (current_funccal != NULL
6034 && ht == &current_funccal->l_vars.dv_hashtab)
6035 return &current_funccal->l_vars;
6036 return NULL;
6037}
6038
6039/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006040 * Search hashitem in parent scope.
6041 */
6042 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006043find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006044{
6045 funccall_T *old_current_funccal = current_funccal;
6046 hashtab_T *ht;
6047 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006048 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006049
6050 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6051 return NULL;
6052
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006053 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006054 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006055 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006056 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006057 ht = find_var_ht(name, &varname);
6058 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006059 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006060 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006061 if (!HASHITEM_EMPTY(hi))
6062 {
6063 *pht = ht;
6064 break;
6065 }
6066 }
6067 if (current_funccal == current_funccal->func->uf_scoped)
6068 break;
6069 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006070 }
6071 current_funccal = old_current_funccal;
6072
6073 return hi;
6074}
6075
6076/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006077 * Search variable in parent scope.
6078 */
6079 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006080find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006081{
6082 dictitem_T *v = NULL;
6083 funccall_T *old_current_funccal = current_funccal;
6084 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006085 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006086
6087 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6088 return NULL;
6089
Bram Moolenaare38eab22019-12-05 21:50:01 +01006090 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006091 current_funccal = current_funccal->func->uf_scoped;
6092 while (current_funccal)
6093 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006094 ht = find_var_ht(name, &varname);
6095 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006096 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006097 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006098 if (v != NULL)
6099 break;
6100 }
6101 if (current_funccal == current_funccal->func->uf_scoped)
6102 break;
6103 current_funccal = current_funccal->func->uf_scoped;
6104 }
6105 current_funccal = old_current_funccal;
6106
6107 return v;
6108}
6109
6110/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006111 * Set "copyID + 1" in previous_funccal and callers.
6112 */
6113 int
6114set_ref_in_previous_funccal(int copyID)
6115{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006116 funccall_T *fc;
6117
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006118 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006119 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006120 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006121 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6122 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6123 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6124 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006125 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006126 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006127}
6128
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006129 static int
6130set_ref_in_funccal(funccall_T *fc, int copyID)
6131{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006132 if (fc->fc_copyID != copyID)
6133 {
6134 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006135 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6136 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6137 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6138 || set_ref_in_func(NULL, fc->func, copyID))
6139 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006140 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006141 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006142}
6143
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006144/*
6145 * Set "copyID" in all local vars and arguments in the call stack.
6146 */
6147 int
6148set_ref_in_call_stack(int copyID)
6149{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006150 funccall_T *fc;
6151 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006152
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006153 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6154 if (set_ref_in_funccal(fc, copyID))
6155 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006156
6157 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006158 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6159 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6160 if (set_ref_in_funccal(fc, copyID))
6161 return TRUE;
6162 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006163}
6164
6165/*
6166 * Set "copyID" in all functions available by name.
6167 */
6168 int
6169set_ref_in_functions(int copyID)
6170{
6171 int todo;
6172 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006173 ufunc_T *fp;
6174
6175 todo = (int)func_hashtab.ht_used;
6176 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006177 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006178 if (!HASHITEM_EMPTY(hi))
6179 {
6180 --todo;
6181 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006182 if (!func_name_refcount(fp->uf_name)
6183 && set_ref_in_func(NULL, fp, copyID))
6184 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006185 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006186 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006187 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006188}
6189
6190/*
6191 * Set "copyID" in all function arguments.
6192 */
6193 int
6194set_ref_in_func_args(int copyID)
6195{
6196 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006197
6198 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006199 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6200 copyID, NULL, NULL))
6201 return TRUE;
6202 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006203}
6204
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006205/*
6206 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006207 * Returns TRUE if setting references failed somehow.
6208 */
6209 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006210set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006211{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006212 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006213 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006214 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006215 char_u fname_buf[FLEN_FIXED + 1];
6216 char_u *tofree = NULL;
6217 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006218 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006219
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006220 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006221 return FALSE;
6222
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006223 if (fp_in == NULL)
6224 {
6225 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006226 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006227 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006228 if (fp != NULL)
6229 {
6230 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006231 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006232 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006233
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006234 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006235 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006236}
6237
Bram Moolenaare38eab22019-12-05 21:50:01 +01006238#endif // FEAT_EVAL