blob: 3e0d021ba8933022e37ff521eaf0fb9b70666ca2 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020035
36 void
37func_init()
38{
39 hash_init(&func_hashtab);
40}
41
Dominique Pelle748b3082022-01-08 12:41:16 +000042#if defined(FEAT_PROFILE) || defined(PROTO)
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020043/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020044 * Return the function hash table
45 */
46 hashtab_T *
47func_tbl_get(void)
48{
49 return &func_hashtab;
50}
Dominique Pelle748b3082022-01-08 12:41:16 +000051#endif
Bram Moolenaar660a10a2019-07-14 15:48:38 +020052
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaardce24412022-02-08 20:35:30 +000058 * If "eap" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaardce24412022-02-08 20:35:30 +000069 exarg_T *eap,
Bram Moolenaar2a389082021-04-09 20:24:31 +020070 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010071 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072{
Bram Moolenaar6e949782020-04-13 17:21:00 +020073 char_u *p = arg;
74 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020075 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010076
77 while (ASCII_ISALNUM(*p) || *p == '_')
78 ++p;
79 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020080 || (argtypes == NULL
81 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
82 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010083 {
84 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000085 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 return arg;
87 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010088
Bram Moolenaar057e84a2021-02-28 16:55:11 +010089 // Vim9 script: cannot use script var name for argument. In function: also
90 // check local vars and arguments.
91 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
Bram Moolenaardce24412022-02-08 20:35:30 +000092 evalarg == NULL ? NULL : evalarg->eval_cctx,
93 eap == NULL ? NULL : eap->cstack, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000117 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000172 * Get a next line, store it in "eap" if appropriate and put the line in
173 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000174 */
175 static char_u *
176get_function_line(
177 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000178 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000179 int indent,
180 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000181{
182 char_u *theline;
183
184 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000185 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000186 else
187 theline = eap->getline(':', eap->cookie, indent, getline_options);
188 if (theline != NULL)
189 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000190 if (lines_to_free->ga_len > 0
191 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
192 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000193 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000194 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000195 }
196
197 return theline;
198}
199
200/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100203 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200204 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100205 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206get_function_args(
207 char_u **argp,
208 char_u endchar,
209 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100210 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100211 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100212 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200213 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200214 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200215 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000216 exarg_T *eap, // can be NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000217 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200218{
219 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100220 char_u *arg;
221 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200223 int any_default = FALSE;
224 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100225 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200226
227 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000228 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100229 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000230 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200231 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000232 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200233
234 if (varargs != NULL)
235 *varargs = FALSE;
236
237 /*
238 * Isolate the arguments: "arg1, arg2, ...)"
239 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100240 arg = skipwhite(*argp);
241 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200242 while (*p != endchar)
243 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200244 while (eap != NULL && eap->getline != NULL
245 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200246 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200247 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000248 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000249 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000250
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 if (theline == NULL)
252 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200253 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200254 p = skipwhite(theline);
255 }
256
257 if (mustend && *p != endchar)
258 {
259 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000260 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100261 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200262 }
263 if (*p == endchar)
264 break;
265
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
267 {
268 if (varargs != NULL)
269 *varargs = TRUE;
270 p += 3;
271 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272
273 if (argtypes != NULL)
274 {
275 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200276 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100278 if (!skip)
279 emsg(_(e_missing_name_after_dots));
280 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100281 }
282
283 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100284 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000285 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100286 if (p == arg)
287 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100288 if (*skipwhite(p) == '=')
289 {
290 emsg(_(e_cannot_use_default_for_variable_arguments));
291 break;
292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 }
295 else
296 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200297 char_u *np;
298
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200299 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100300 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000301 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200303 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304
Bram Moolenaar015cf102021-06-26 21:52:02 +0200305 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200306 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200307 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200308 if (*np == '=' && np[1] != '=' && np[1] != '~'
309 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 {
311 typval_T rettv;
312
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100313 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 any_default = TRUE;
315 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200316 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200317 p = skipwhite(p);
318 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200319 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200320 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200321 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200322 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200323 if (ga_grow(default_args, 1) == FAIL)
324 goto err_ret;
325
326 // trim trailing whitespace
327 while (p > expr && VIM_ISWHITE(p[-1]))
328 p--;
329 c = *p;
330 *p = NUL;
331 expr = vim_strsave(expr);
332 if (expr == NULL)
333 {
334 *p = c;
335 goto err_ret;
336 }
337 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200338 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200339 default_args->ga_len++;
340 *p = c;
341 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200342 }
343 else
344 mustend = TRUE;
345 }
346 else if (any_default)
347 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000348 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200349 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200350 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200351
352 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
353 {
354 // Be tolerant when skipping
355 if (!skip)
356 {
357 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
358 goto err_ret;
359 }
360 p = skipwhite(p);
361 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200363 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200364 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200365 // Don't give this error when skipping, it makes the "->" not
366 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100367 // Allow missing space after comma in legacy functions.
368 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200369 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
370 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100371 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200372 goto err_ret;
373 }
374 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200375 else
376 mustend = TRUE;
377 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200378 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200379 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200380 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200381
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200382 if (*p != endchar)
383 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100384 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200385
386 *argp = p;
387 return OK;
388
389err_ret:
390 if (newargs != NULL)
391 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200392 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200393 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200394 return FAIL;
395}
396
397/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100398 * Parse the argument types, filling "fp->uf_arg_types".
399 * Return OK or FAIL.
400 */
401 static int
402parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
403{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200404 int len = 0;
405
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100406 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
407 if (argtypes->ga_len > 0)
408 {
409 // When "varargs" is set the last name/type goes into uf_va_name
410 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200411 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100412
413 if (len > 0)
414 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
415 if (fp->uf_arg_types != NULL)
416 {
417 int i;
418 type_T *type;
419
420 for (i = 0; i < len; ++ i)
421 {
422 char_u *p = ((char_u **)argtypes->ga_data)[i];
423
424 if (p == NULL)
425 // will get the type from the default value
426 type = &t_unknown;
427 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100428 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100429 if (type == NULL)
430 return FAIL;
431 fp->uf_arg_types[i] = type;
432 }
433 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100434 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200435
436 if (varargs)
437 {
438 char_u *p;
439
440 // Move the last argument "...name: type" to uf_va_name and
441 // uf_va_type.
442 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
443 [fp->uf_args.ga_len - 1];
444 --fp->uf_args.ga_len;
445 p = ((char_u **)argtypes->ga_data)[len];
446 if (p == NULL)
447 // TODO: get type from default value
448 fp->uf_va_type = &t_list_any;
449 else
450 {
451 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
452 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
453 {
454 semsg(_(e_variable_arguments_type_must_be_list_str),
455 ((char_u **)argtypes->ga_data)[len]);
456 return FAIL;
457 }
458 }
459 if (fp->uf_va_type == NULL)
460 return FAIL;
461 }
462
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100463 return OK;
464}
465
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100466 static int
467parse_return_type(ufunc_T *fp, char_u *ret_type)
468{
469 if (ret_type == NULL)
470 fp->uf_ret_type = &t_void;
471 else
472 {
473 char_u *p = ret_type;
474
475 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
476 if (fp->uf_ret_type == NULL)
477 {
478 fp->uf_ret_type = &t_void;
479 return FAIL;
480 }
481 }
482 return OK;
483}
484
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100485/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200486 * Register function "fp" as using "current_funccal" as its scope.
487 */
488 static int
489register_closure(ufunc_T *fp)
490{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200491 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100492 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200493 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200494 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 fp->uf_scoped = current_funccal;
496 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497
Bram Moolenaar58016442016-07-31 18:30:22 +0200498 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
499 return FAIL;
500 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
501 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200502 return OK;
503}
504
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100505 static void
506set_ufunc_name(ufunc_T *fp, char_u *name)
507{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100508 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
509 // actually extends beyond the struct.
510 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100511
512 if (name[0] == K_SPECIAL)
513 {
514 fp->uf_name_exp = alloc(STRLEN(name) + 3);
515 if (fp->uf_name_exp != NULL)
516 {
517 STRCPY(fp->uf_name_exp, "<SNR>");
518 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
519 }
520 }
521}
522
Bram Moolenaar58016442016-07-31 18:30:22 +0200523/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200524 * Get a name for a lambda. Returned in static memory.
525 */
526 char_u *
527get_lambda_name(void)
528{
529 static char_u name[30];
530 static int lambda_no = 0;
531
532 sprintf((char*)name, "<lambda>%d", ++lambda_no);
533 return name;
534}
535
Bram Moolenaar801ab062020-06-25 19:27:56 +0200536#if defined(FEAT_LUA) || defined(PROTO)
537/*
538 * Registers a native C callback which can be called from Vim script.
539 * Returns the name of the Vim script function.
540 */
541 char_u *
542register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
543{
544 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200545 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200546
547 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
548 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200549 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200550
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200551 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200552 fp->uf_refcount = 1;
553 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000554 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200555 fp->uf_calls = 0;
556 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200557 fp->uf_cb = cb;
558 fp->uf_cb_free = cb_free;
559 fp->uf_cb_state = state;
560
561 set_ufunc_name(fp, name);
562 hash_add(&func_hashtab, UF2HIKEY(fp));
563
564 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200565}
566#endif
567
Bram Moolenaar04b12692020-05-04 23:24:44 +0200568/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100569 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100570 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100571 * If "white_error" is not NULL check for correct use of white space and set
572 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100573 * Return NULL if no valid arrow found.
574 */
575 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576skip_arrow(
577 char_u *start,
578 int equal_arrow,
579 char_u **ret_type,
580 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100581{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100582 char_u *s = start;
583 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100584
585 if (equal_arrow)
586 {
587 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100588 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100589 if (white_error != NULL && !VIM_ISWHITE(s[1]))
590 {
591 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100592 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100593 return NULL;
594 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100595 s = skipwhite(s + 1);
596 *ret_type = s;
597 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100598 if (s == *ret_type)
599 {
600 emsg(_(e_missing_return_type));
601 return NULL;
602 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100603 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100604 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100605 s = skipwhite(s);
606 if (*s != '=')
607 return NULL;
608 ++s;
609 }
610 if (*s != '>')
611 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100612 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
613 || !IS_WHITE_OR_NUL(s[1])))
614 {
615 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100616 semsg(_(e_white_space_required_before_and_after_str_at_str),
617 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100618 return NULL;
619 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100620 return skipwhite(s + 1);
621}
622
623/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100624 * Check if "*cmd" points to a function command and if so advance "*cmd" and
625 * return TRUE.
626 * Otherwise return FALSE;
627 * Do not consider "function(" to be a command.
628 */
629 static int
630is_function_cmd(char_u **cmd)
631{
632 char_u *p = *cmd;
633
634 if (checkforcmd(&p, "function", 2))
635 {
636 if (*p == '(')
637 return FALSE;
638 *cmd = p;
639 return TRUE;
640 }
641 return FALSE;
642}
643
644/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200645 * Called when defining a function: The context may be needed for script
646 * variables declared in a block that is visible now but not when the function
647 * is compiled or called later.
648 */
649 static void
650function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
651{
652 if (cstack != NULL && cstack->cs_idx >= 0)
653 {
654 int count = cstack->cs_idx + 1;
655 int i;
656
657 fp->uf_block_ids = ALLOC_MULT(int, count);
658 if (fp->uf_block_ids != NULL)
659 {
660 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
661 sizeof(int) * count);
662 fp->uf_block_depth = count;
663 }
664
665 // Set flag in each block to indicate a function was defined. This
666 // is used to keep the variable when leaving the block, see
667 // hide_script_var().
668 for (i = 0; i <= cstack->cs_idx; ++i)
669 cstack->cs_flags[i] |= CSF_FUNC_DEF;
670 }
671}
672
673/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100674 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200675 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100676 * "newlines" must already have been initialized.
677 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
678 */
679 static int
680get_function_body(
681 exarg_T *eap,
682 garray_T *newlines,
683 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000684 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100685{
686 linenr_T sourcing_lnum_top = SOURCING_LNUM;
687 linenr_T sourcing_lnum_off;
688 int saved_wait_return = need_wait_return;
689 char_u *line_arg = line_arg_in;
690 int vim9_function = eap->cmdidx == CMD_def
691 || eap->cmdidx == CMD_block;
692#define MAX_FUNC_NESTING 50
693 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200694 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100695 int nesting = 0;
696 getline_opt_T getline_options;
697 int indent = 2;
698 char_u *skip_until = NULL;
699 int ret = FAIL;
700 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200701 int heredoc_concat_len = 0;
702 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100703 char_u *heredoc_trimmed = NULL;
704
Bram Moolenaar20677332021-06-06 17:02:53 +0200705 ga_init2(&heredoc_ga, 1, 500);
706
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100707 // Detect having skipped over comment lines to find the return
708 // type. Add NULL lines to keep the line count correct.
709 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
710 if (SOURCING_LNUM < sourcing_lnum_off)
711 {
712 sourcing_lnum_off -= SOURCING_LNUM;
713 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
714 goto theend;
715 while (sourcing_lnum_off-- > 0)
716 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
717 }
718
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200719 nesting_def[0] = vim9_function;
720 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100721 getline_options = vim9_function
722 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
723 for (;;)
724 {
725 char_u *theline;
726 char_u *p;
727 char_u *arg;
728
729 if (KeyTyped)
730 {
731 msg_scroll = TRUE;
732 saved_wait_return = FALSE;
733 }
734 need_wait_return = FALSE;
735
736 if (line_arg != NULL)
737 {
738 // Use eap->arg, split up in parts by line breaks.
739 theline = line_arg;
740 p = vim_strchr(theline, '\n');
741 if (p == NULL)
742 line_arg += STRLEN(line_arg);
743 else
744 {
745 *p = NUL;
746 line_arg = p + 1;
747 }
748 }
749 else
750 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000751 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100752 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100753 }
754 if (KeyTyped)
755 lines_left = Rows - 1;
756 if (theline == NULL)
757 {
758 // Use the start of the function for the line number.
759 SOURCING_LNUM = sourcing_lnum_top;
760 if (skip_until != NULL)
761 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200762 else if (nesting_inline[nesting])
763 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100764 else if (eap->cmdidx == CMD_def)
765 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100766 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000767 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100768 goto theend;
769 }
770
771 // Detect line continuation: SOURCING_LNUM increased more than one.
772 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
773 if (SOURCING_LNUM < sourcing_lnum_off)
774 sourcing_lnum_off -= SOURCING_LNUM;
775 else
776 sourcing_lnum_off = 0;
777
778 if (skip_until != NULL)
779 {
780 // Don't check for ":endfunc"/":enddef" between
781 // * ":append" and "."
782 // * ":python <<EOF" and "EOF"
783 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
784 if (heredoc_trimmed == NULL
785 || (is_heredoc && skipwhite(theline) == theline)
786 || STRNCMP(theline, heredoc_trimmed,
787 STRLEN(heredoc_trimmed)) == 0)
788 {
789 if (heredoc_trimmed == NULL)
790 p = theline;
791 else if (is_heredoc)
792 p = skipwhite(theline) == theline
793 ? theline : theline + STRLEN(heredoc_trimmed);
794 else
795 p = theline + STRLEN(heredoc_trimmed);
796 if (STRCMP(p, skip_until) == 0)
797 {
798 VIM_CLEAR(skip_until);
799 VIM_CLEAR(heredoc_trimmed);
800 getline_options = vim9_function
801 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
802 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200803
804 if (heredoc_concat_len > 0)
805 {
806 // Replace the starting line with all the concatenated
807 // lines.
808 ga_concat(&heredoc_ga, theline);
809 vim_free(((char_u **)(newlines->ga_data))[
810 heredoc_concat_len - 1]);
811 ((char_u **)(newlines->ga_data))[
812 heredoc_concat_len - 1] = heredoc_ga.ga_data;
813 ga_init(&heredoc_ga);
814 heredoc_concat_len = 0;
815 theline += STRLEN(theline); // skip the "EOF"
816 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100817 }
818 }
819 }
820 else
821 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200822 int c;
823 char_u *end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100824
825 // skip ':' and blanks
826 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
827 ;
828
829 // Check for "endfunction", "enddef" or "}".
830 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200831 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100832 ? *p == '}'
833 : (checkforcmd(&p, nesting_def[nesting]
834 ? "enddef" : "endfunction", 4)
835 && *p != ':'))
836 {
837 if (nesting-- == 0)
838 {
839 char_u *nextcmd = NULL;
840
841 if (*p == '|' || *p == '}')
842 nextcmd = p + 1;
843 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
844 nextcmd = line_arg;
845 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100846 && (vim9_function || p_verbose > 0))
847 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200848 SOURCING_LNUM = sourcing_lnum_top
849 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100850 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000851 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100852 else
853 give_warning2((char_u *)
854 _("W22: Text found after :endfunction: %s"),
855 p, TRUE);
856 }
857 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100858 {
859 // Another command follows. If the line came from "eap"
860 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000861 // change "eap->cmdlinep" to point to the last fetched
862 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100863 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000864 if (lines_to_free->ga_len > 0
865 && *eap->cmdlinep !=
866 ((char_u **)lines_to_free->ga_data)
867 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000869 // *cmdlinep will be freed later, thus remove the
870 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100871 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000872 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
873 [lines_to_free->ga_len - 1];
874 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100875 }
876 }
877 break;
878 }
879 }
880
881 // Check for mismatched "endfunc" or "enddef".
882 // We don't check for "def" inside "func" thus we also can't check
883 // for "enddef".
884 // We continue to find the end of the function, although we might
885 // not find it.
886 else if (nesting_def[nesting])
887 {
888 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
889 emsg(_(e_mismatched_endfunction));
890 }
891 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
892 emsg(_(e_mismatched_enddef));
893
894 // Increase indent inside "if", "while", "for" and "try", decrease
895 // at "end".
896 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
897 indent -= 2;
898 else if (STRNCMP(p, "if", 2) == 0
899 || STRNCMP(p, "wh", 2) == 0
900 || STRNCMP(p, "for", 3) == 0
901 || STRNCMP(p, "try", 3) == 0)
902 indent += 2;
903
904 // Check for defining a function inside this function.
905 // Only recognize "def" inside "def", not inside "function",
906 // For backwards compatibility, see Test_function_python().
907 c = *p;
908 if (is_function_cmd(&p)
909 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
910 {
911 if (*p == '!')
912 p = skipwhite(p + 1);
913 p += eval_fname_script(p);
914 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
915 NULL, NULL));
916 if (*skipwhite(p) == '(')
917 {
918 if (nesting == MAX_FUNC_NESTING - 1)
919 emsg(_(e_function_nesting_too_deep));
920 else
921 {
922 ++nesting;
923 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200924 nesting_inline[nesting] = FALSE;
925 indent += 2;
926 }
927 }
928 }
929
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200930 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200931 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200932 // Not a comment line: check for nested inline function.
933 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200934 while (end > p && VIM_ISWHITE(*end))
935 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200936 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200937 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200938 int is_block;
939
940 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200941 --end;
942 while (end > p && VIM_ISWHITE(*end))
943 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200944 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
945 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200946 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200947 char_u *s = p;
948
949 // check for line starting with "au" for :autocmd or
950 // "com" for :command, these can use a {} block
951 is_block = checkforcmd_noparen(&s, "autocmd", 2)
952 || checkforcmd_noparen(&s, "command", 3);
953 }
954
955 if (is_block)
956 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200957 if (nesting == MAX_FUNC_NESTING - 1)
958 emsg(_(e_function_nesting_too_deep));
959 else
960 {
961 ++nesting;
962 nesting_def[nesting] = TRUE;
963 nesting_inline[nesting] = TRUE;
964 indent += 2;
965 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100966 }
967 }
968 }
969
970 // Check for ":append", ":change", ":insert". Not for :def.
971 p = skip_range(p, FALSE, NULL);
972 if (!vim9_function
973 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
974 || (p[0] == 'c'
975 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
976 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
977 && (STRNCMP(&p[3], "nge", 3) != 0
978 || !ASCII_ISALPHA(p[6])))))))
979 || (p[0] == 'i'
980 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
981 && (!ASCII_ISALPHA(p[2])
982 || (p[2] == 's'
983 && (!ASCII_ISALPHA(p[3])
984 || p[3] == 'e'))))))))
985 skip_until = vim_strsave((char_u *)".");
986
987 // Check for ":python <<EOF", ":tcl <<EOF", etc.
988 arg = skipwhite(skiptowhite(p));
989 if (arg[0] == '<' && arg[1] =='<'
990 && ((p[0] == 'p' && p[1] == 'y'
991 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
992 || ((p[2] == '3' || p[2] == 'x')
993 && !ASCII_ISALPHA(p[3]))))
994 || (p[0] == 'p' && p[1] == 'e'
995 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
996 || (p[0] == 't' && p[1] == 'c'
997 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
998 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
999 && !ASCII_ISALPHA(p[3]))
1000 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1001 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1002 || (p[0] == 'm' && p[1] == 'z'
1003 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1004 ))
1005 {
1006 // ":python <<" continues until a dot, like ":append"
1007 p = skipwhite(arg + 2);
1008 if (STRNCMP(p, "trim", 4) == 0)
1009 {
1010 // Ignore leading white space.
1011 p = skipwhite(p + 4);
1012 heredoc_trimmed = vim_strnsave(theline,
1013 skipwhite(theline) - theline);
1014 }
1015 if (*p == NUL)
1016 skip_until = vim_strsave((char_u *)".");
1017 else
1018 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1019 getline_options = GETLINE_NONE;
1020 is_heredoc = TRUE;
Bram Moolenaar20677332021-06-06 17:02:53 +02001021 if (eap->cmdidx == CMD_def)
1022 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001023 }
1024
1025 // Check for ":cmd v =<< [trim] EOF"
1026 // and ":cmd [a, b] =<< [trim] EOF"
1027 // and "lines =<< [trim] EOF" for Vim9
1028 // Where "cmd" can be "let", "var", "final" or "const".
1029 arg = skipwhite(skiptowhite(p));
1030 if (*arg == '[')
1031 arg = vim_strchr(arg, ']');
1032 if (arg != NULL)
1033 {
1034 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1035 && arg[1] == '<' && arg[2] =='<');
1036
1037 if (!found)
1038 // skip over the argument after "cmd"
1039 arg = skipwhite(skiptowhite(arg));
1040 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1041 && (checkforcmd(&p, "let", 2)
1042 || checkforcmd(&p, "var", 3)
1043 || checkforcmd(&p, "final", 5)
1044 || checkforcmd(&p, "const", 5))))
1045 {
1046 p = skipwhite(arg + 3);
1047 if (STRNCMP(p, "trim", 4) == 0)
1048 {
1049 // Ignore leading white space.
1050 p = skipwhite(p + 4);
1051 heredoc_trimmed = vim_strnsave(theline,
1052 skipwhite(theline) - theline);
1053 }
1054 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1055 getline_options = GETLINE_NONE;
1056 is_heredoc = TRUE;
1057 }
1058 }
1059 }
1060
1061 // Add the line to the function.
1062 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1063 goto theend;
1064
Bram Moolenaar20677332021-06-06 17:02:53 +02001065 if (heredoc_concat_len > 0)
1066 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001067 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001068 // to be used for the instruction later.
1069 ga_concat(&heredoc_ga, theline);
1070 ga_concat(&heredoc_ga, (char_u *)"\n");
1071 p = vim_strsave((char_u *)"");
1072 }
1073 else
1074 {
1075 // Copy the line to newly allocated memory. get_one_sourceline()
1076 // allocates 250 bytes per line, this saves 80% on average. The
1077 // cost is an extra alloc/free.
1078 p = vim_strsave(theline);
1079 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 if (p == NULL)
1081 goto theend;
1082 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1083
1084 // Add NULL lines for continuation lines, so that the line count is
1085 // equal to the index in the growarray.
1086 while (sourcing_lnum_off-- > 0)
1087 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1088
1089 // Check for end of eap->arg.
1090 if (line_arg != NULL && *line_arg == NUL)
1091 line_arg = NULL;
1092 }
1093
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001094 // Return OK when no error was detected.
1095 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001096 ret = OK;
1097
1098theend:
1099 vim_free(skip_until);
1100 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001101 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001102 need_wait_return |= saved_wait_return;
1103 return ret;
1104}
1105
1106/*
1107 * Handle the body of a lambda. *arg points to the "{", process statements
1108 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001109 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001110 * When successful "rettv" is set to a funcref.
1111 */
1112 static int
1113lambda_function_body(
1114 char_u **arg,
1115 typval_T *rettv,
1116 evalarg_T *evalarg,
1117 garray_T *newargs,
1118 garray_T *argtypes,
1119 int varargs,
1120 garray_T *default_args,
1121 char_u *ret_type)
1122{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001123 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001124 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001125 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001126 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001127 exarg_T eap;
1128 garray_T newlines;
1129 char_u *cmdline = NULL;
1130 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001131 partial_T *pt;
1132 char_u *name;
1133 int lnum_save = -1;
1134 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1135
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001136 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1137 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001138 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001139 return FAIL;
1140 }
1141
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 CLEAR_FIELD(eap);
1143 eap.cmdidx = CMD_block;
1144 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001145 eap.cmdlinep = &cmdline;
1146 eap.skip = !evaluate;
1147 if (evalarg->eval_cctx != NULL)
1148 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1149 else
1150 {
1151 eap.getline = evalarg->eval_getline;
1152 eap.cookie = evalarg->eval_cookie;
1153 }
1154
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001155 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001156 if (get_function_body(&eap, &newlines, NULL,
1157 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001158 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001159
1160 // When inside a lambda must add the function lines to evalarg.eval_ga.
1161 evalarg->eval_break_count += newlines.ga_len;
1162 if (gap->ga_itemsize > 0)
1163 {
1164 int idx;
1165 char_u *last;
1166 size_t plen;
1167 char_u *pnl;
1168
1169 for (idx = 0; idx < newlines.ga_len; ++idx)
1170 {
1171 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1172
Bram Moolenaarecb66452021-05-18 15:09:18 +02001173 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001174 goto erret;
1175
1176 // Going to concatenate the lines after parsing. For an empty or
1177 // comment line use an empty string.
1178 // Insert NL characters at the start of each line, the string will
1179 // be split again later in .get_lambda_tv().
1180 if (*p == NUL || vim9_comment_start(p))
1181 p = (char_u *)"";
1182 plen = STRLEN(p);
1183 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1184 if (pnl != NULL)
1185 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001186 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1187 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001188 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001189 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001190 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001191 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001192 // more is following after the "}", which was skipped
1193 last = cmdline;
1194 else
1195 // nothing is following the "}"
1196 last = (char_u *)"}";
1197 plen = STRLEN(last);
1198 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1199 if (pnl != NULL)
1200 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001201 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1202 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001203 }
1204
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001205 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001207 garray_T *tfgap = &evalarg->eval_tofree_ga;
1208
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001209 // Something comes after the "}".
1210 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001211
1212 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001213 if (ga_grow(tfgap, 1) == OK)
1214 {
1215 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1216 evalarg->eval_using_cmdline = TRUE;
1217 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001218 }
1219 else
1220 *arg = (char_u *)"";
1221
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001222 if (!evaluate)
1223 {
1224 ret = OK;
1225 goto erret;
1226 }
1227
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001228 name = get_lambda_name();
1229 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1230 if (ufunc == NULL)
1231 goto erret;
1232 set_ufunc_name(ufunc, name);
1233 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001234 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001235 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001236 ufunc->uf_refcount = 1;
1237 ufunc->uf_args = *newargs;
1238 newargs->ga_data = NULL;
1239 ufunc->uf_def_args = *default_args;
1240 default_args->ga_data = NULL;
1241 ufunc->uf_func_type = &t_func_any;
1242
1243 // error messages are for the first function line
1244 lnum_save = SOURCING_LNUM;
1245 SOURCING_LNUM = sourcing_lnum_top;
1246
1247 // parse argument types
1248 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1249 {
1250 SOURCING_LNUM = lnum_save;
1251 goto erret;
1252 }
1253
1254 // parse the return type, if any
1255 if (parse_return_type(ufunc, ret_type) == FAIL)
1256 goto erret;
1257
1258 pt = ALLOC_CLEAR_ONE(partial_T);
1259 if (pt == NULL)
1260 goto erret;
1261 pt->pt_func = ufunc;
1262 pt->pt_refcount = 1;
1263
1264 ufunc->uf_lines = newlines;
1265 newlines.ga_data = NULL;
1266 if (sandbox)
1267 ufunc->uf_flags |= FC_SANDBOX;
1268 if (!ASCII_ISUPPER(*ufunc->uf_name))
1269 ufunc->uf_flags |= FC_VIM9;
1270 ufunc->uf_script_ctx = current_sctx;
1271 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1272 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1273 set_function_type(ufunc);
1274
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001275 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1276
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001277 rettv->vval.v_partial = pt;
1278 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001279 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001280 ret = OK;
1281
1282erret:
1283 if (lnum_save >= 0)
1284 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001286 if (newargs != NULL)
1287 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001288 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001289 if (ufunc != NULL)
1290 {
1291 func_clear(ufunc, TRUE);
1292 func_free(ufunc, TRUE);
1293 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001294 return ret;
1295}
1296
1297/*
1298 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001299 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001300 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001301 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1302 */
1303 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001304get_lambda_tv(
1305 char_u **arg,
1306 typval_T *rettv,
1307 int types_optional,
1308 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001310 int evaluate = evalarg != NULL
1311 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001312 garray_T newargs;
1313 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001314 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001315 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001316 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001318 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001319 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001320 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001321 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001322 char_u *s;
1323 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001324 int *old_eval_lavars = eval_lavars_used;
1325 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001326 char_u *tofree1 = NULL;
1327 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001328 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001329 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001330 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001331 int vim9script = in_vim9script();
Bram Moolenaar65c44152020-12-24 15:14:01 +01001332
Bram Moolenaar4525a572022-02-13 11:57:33 +00001333 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001334 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001335
1336 ga_init(&newargs);
1337 ga_init(&newlines);
1338
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001339 // First, check if this is really a lambda expression. "->" or "=>" must
1340 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001341 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001342 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001343 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001344 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001345 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001346 {
1347 if (types_optional)
1348 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001349 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001350 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001351
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001352 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001353 if (evaluate)
1354 pnewargs = &newargs;
1355 else
1356 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001357 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001358 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001359 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001360 &varargs, &default_args,
1361 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001362 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001363 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001364 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001365 {
1366 if (types_optional)
1367 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001368 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001369 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001370 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001371 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001373 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1374 if (ret_type != NULL)
1375 {
1376 ret_type = vim_strsave(ret_type);
1377 tofree2 = ret_type;
1378 }
1379
Bram Moolenaare38eab22019-12-05 21:50:01 +01001380 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001381 if (evaluate)
1382 eval_lavars_used = &eval_lavars;
1383
Bram Moolenaar65c44152020-12-24 15:14:01 +01001384 *arg = skipwhite_and_linebreak(*arg, evalarg);
1385
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001386 // Recognize "{" as the start of a function body.
1387 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001388 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001389 if (evalarg == NULL)
1390 // cannot happen?
1391 goto theend;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001392 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1393 types_optional ? &argtypes : NULL, varargs,
1394 &default_args, ret_type) == FAIL)
1395 goto errret;
1396 goto theend;
1397 }
1398 if (default_args.ga_len > 0)
1399 {
1400 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001401 goto errret;
1402 }
1403
Bram Moolenaare38eab22019-12-05 21:50:01 +01001404 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001405 start = *arg;
1406 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001407 if (ret == FAIL)
1408 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001409 if (evalarg != NULL)
1410 {
1411 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001412 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001413 evalarg->eval_tofree = NULL;
1414 }
1415
Bram Moolenaar65c44152020-12-24 15:14:01 +01001416 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001417 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001418 *arg = skipwhite_and_linebreak(*arg, evalarg);
1419 if (**arg != '}')
1420 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001421 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001422 goto errret;
1423 }
1424 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001425 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001426
1427 if (evaluate)
1428 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001429 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001430 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001431 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001432 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001433 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001434
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001435 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001436 if (fp == NULL)
1437 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001438 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001439 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001440 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001441 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001442
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001443 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 if (ga_grow(&newlines, 1) == FAIL)
1445 goto errret;
1446
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001447 // If there are line breaks, we need to split up the string.
1448 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001449 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001450 line_end = end;
1451
1452 // Add "return " before the expression (or the first line).
1453 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001454 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 if (p == NULL)
1456 goto errret;
1457 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1458 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001459 vim_strncpy(p + 7, start, line_end - start);
1460
1461 if (line_end != end)
1462 {
1463 // Add more lines, split by line breaks. Thus is used when a
1464 // lambda with { cmds } is encountered.
1465 while (*line_end == '\n')
1466 {
1467 if (ga_grow(&newlines, 1) == FAIL)
1468 goto errret;
1469 start = line_end + 1;
1470 line_end = vim_strchr(start, '\n');
1471 if (line_end == NULL)
1472 line_end = end;
1473 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1474 vim_strnsave(start, line_end - start);
1475 }
1476 }
1477
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001478 if (strstr((char *)p + 7, "a:") == NULL)
1479 // No a: variables are used for sure.
1480 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481
1482 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001483 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001485 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001486 if (types_optional)
1487 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001488 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001489 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001490 goto errret;
1491 if (ret_type != NULL)
1492 {
1493 fp->uf_ret_type = parse_type(&ret_type,
1494 &fp->uf_type_list, TRUE);
1495 if (fp->uf_ret_type == NULL)
1496 goto errret;
1497 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001498 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001499 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001500 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001501
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001502 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001503 if (current_funccal != NULL && eval_lavars)
1504 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001505 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001506 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001507 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001508 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509
1510#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511 if (prof_def_func())
1512 func_do_profile(fp);
1513#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001514 if (sandbox)
1515 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001516 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001517 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001518 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001519 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001521 fp->uf_script_ctx = current_sctx;
Bram Moolenaara755fdb2021-11-20 21:35:41 +00001522 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001524 function_using_block_scopes(fp, evalarg->eval_cstack);
1525
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001526 pt->pt_func = fp;
1527 pt->pt_refcount = 1;
1528 rettv->vval.v_partial = pt;
1529 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001530
1531 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001533
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001534theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001535 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001536 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001537 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001538 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001539 vim_free(tofree1);
1540 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001541 if (types_optional)
1542 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001543
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 return OK;
1545
1546errret:
1547 ga_clear_strings(&newargs);
1548 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001549 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001550 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001551 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001552 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001553 if (fp != NULL)
1554 vim_free(fp->uf_arg_types);
1555 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001557 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001558 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001559 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001560 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001561 vim_free(tofree1);
1562 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001563 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 return FAIL;
1565}
1566
1567/*
1568 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1569 * name it contains, otherwise return "name".
1570 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1571 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001572 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1573 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001574 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001575 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 */
1577 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001578deref_func_name(
1579 char_u *name,
1580 int *lenp,
1581 partial_T **partialp,
1582 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001583 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001584 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001585 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001586{
1587 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001588 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001590 char_u *s = NULL;
1591 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001592 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593
1594 if (partialp != NULL)
1595 *partialp = NULL;
1596
1597 cc = name[*lenp];
1598 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001599
Bram Moolenaar71f21932022-01-07 18:20:55 +00001600 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001602 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001604 tv = &v->di_tv;
1605 }
1606 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1607 {
1608 imported_T *import;
1609 char_u *p = name;
1610 int len = *lenp;
1611
1612 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001614 p = name + 2;
1615 len -= 2;
1616 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001617 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001618
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001619 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001620 if (import != NULL)
1621 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001622 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001623 if (new_function)
1624 semsg(_(e_redefining_imported_item_str), name);
1625 else
1626 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001627 name[len] = cc;
1628 *lenp = 0;
1629 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001630 }
1631 }
1632
1633 if (tv != NULL)
1634 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001635 if (found_var != NULL)
1636 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001637 if (tv->v_type == VAR_FUNC)
1638 {
1639 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001640 {
1641 *lenp = 0;
1642 return (char_u *)""; // just in case
1643 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001644 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001645 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001646 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001648 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001650 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001651
1652 if (pt == NULL)
1653 {
1654 *lenp = 0;
1655 return (char_u *)""; // just in case
1656 }
1657 if (partialp != NULL)
1658 *partialp = pt;
1659 s = partial_name(pt);
1660 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001662
1663 if (s != NULL)
1664 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001665 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001666 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001667 svar_T *sv = find_typval_in_script(tv, 0);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001668
1669 if (sv != NULL)
1670 *type = sv->sv_type;
1671 }
1672 return s;
1673 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001674 }
1675
1676 return name;
1677}
1678
1679/*
1680 * Give an error message with a function name. Handle <SNR> things.
1681 * "ermsg" is to be passed without translation, use N_() instead of _().
1682 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001683 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684emsg_funcname(char *ermsg, char_u *name)
1685{
Bram Moolenaar54598062022-01-13 12:05:09 +00001686 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687
Bram Moolenaar54598062022-01-13 12:05:09 +00001688 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001689 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001690 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 if (p != name)
1692 vim_free(p);
1693}
1694
1695/*
1696 * Allocate a variable for the result of a function.
1697 * Return OK or FAIL.
1698 */
1699 int
1700get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001701 char_u *name, // name of the function
1702 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001704 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001705 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001706 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707{
1708 char_u *argp;
1709 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001710 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1711 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001712 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001713 int evaluate = evalarg == NULL
1714 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715
1716 /*
1717 * Get the arguments.
1718 */
1719 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001720 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1721 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001723 // skip the '(' or ',' and possibly line breaks
1724 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1725
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 if (*argp == ')' || *argp == ',' || *argp == NUL)
1727 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001728 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001729 {
1730 ret = FAIL;
1731 break;
1732 }
1733 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001734 // The comma should come right after the argument, but this wasn't
1735 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001736 if (vim9script)
1737 {
1738 if (*argp != ',' && *skipwhite(argp) == ',')
1739 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001740 if (evaluate)
1741 semsg(_(e_no_white_space_allowed_before_str_str),
1742 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001743 ret = FAIL;
1744 break;
1745 }
1746 }
1747 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001748 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 if (*argp != ',')
1750 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001751 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1752 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001753 if (evaluate)
1754 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001755 ret = FAIL;
1756 break;
1757 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001759 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001760 if (*argp == ')')
1761 ++argp;
1762 else
1763 ret = FAIL;
1764
1765 if (ret == OK)
1766 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001767 int i = 0;
1768 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769
1770 if (get_vim_var_nr(VV_TESTING))
1771 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001772 // Prepare for calling test_garbagecollect_now(), need to know
1773 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001774 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001775 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 for (i = 0; i < argcount; ++i)
1777 if (ga_grow(&funcargs, 1) == OK)
1778 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1779 &argvars[i];
1780 }
1781
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001782 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001783 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001784 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001785 // An error in a builtin function does not return FAIL, but we do
1786 // want to abort further processing if an error was given.
1787 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001788 clear_tv(rettv);
1789 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790
1791 funcargs.ga_len -= i;
1792 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001793 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001794 {
1795 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001796 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001797 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001798 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799 }
1800
1801 while (--argcount >= 0)
1802 clear_tv(&argvars[argcount]);
1803
Bram Moolenaar4525a572022-02-13 11:57:33 +00001804 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001805 *arg = argp;
1806 else
1807 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 return ret;
1809}
1810
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811/*
1812 * Return TRUE if "p" starts with "<SID>" or "s:".
1813 * Only works if eval_fname_script() returned non-zero for "p"!
1814 */
1815 static int
1816eval_fname_sid(char_u *p)
1817{
1818 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1819}
1820
1821/*
1822 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1823 * Change <SNR>123_name() to K_SNR 123_name().
1824 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1825 * (slow).
1826 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001827 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1829{
1830 int llen;
1831 char_u *fname;
1832 int i;
1833
1834 llen = eval_fname_script(name);
1835 if (llen > 0)
1836 {
1837 fname_buf[0] = K_SPECIAL;
1838 fname_buf[1] = KS_EXTRA;
1839 fname_buf[2] = (int)KE_SNR;
1840 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001841 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001842 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001843 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001844 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 else
1846 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001847 sprintf((char *)fname_buf + 3, "%ld_",
1848 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849 i = (int)STRLEN(fname_buf);
1850 }
1851 }
1852 if (i + STRLEN(name + llen) < FLEN_FIXED)
1853 {
1854 STRCPY(fname_buf + i, name + llen);
1855 fname = fname_buf;
1856 }
1857 else
1858 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001859 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001860 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001861 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001862 else
1863 {
1864 *tofree = fname;
1865 mch_memmove(fname, fname_buf, (size_t)i);
1866 STRCPY(fname + i, name + llen);
1867 }
1868 }
1869 }
1870 else
1871 fname = name;
1872 return fname;
1873}
1874
1875/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001876 * Find a function "name" in script "sid".
1877 */
1878 static ufunc_T *
1879find_func_with_sid(char_u *name, int sid)
1880{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001881 hashitem_T *hi;
1882 char_u buffer[200];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001883
Bram Moolenaarb8822442022-01-11 15:24:05 +00001884 if (!SCRIPT_ID_VALID(sid))
1885 return NULL; // not in a script
1886
1887 // A script-local function is stored as "<SNR>99_name".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888 buffer[0] = K_SPECIAL;
1889 buffer[1] = KS_EXTRA;
1890 buffer[2] = (int)KE_SNR;
1891 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1892 (long)sid, name);
1893 hi = hash_find(&func_hashtab, buffer);
1894 if (!HASHITEM_EMPTY(hi))
1895 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001896 return NULL;
1897}
1898
1899/*
1900 * Find a function "name" in script "sid" prefixing the autoload prefix.
1901 */
1902 static ufunc_T *
1903find_func_with_prefix(char_u *name, int sid)
1904{
1905 hashitem_T *hi;
1906 char_u buffer[200];
1907 scriptitem_T *si;
1908
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001909 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001910 return NULL; // already has the prefix
1911 if (!SCRIPT_ID_VALID(sid))
1912 return NULL; // not in a script
1913 si = SCRIPT_ITEM(sid);
1914 if (si->sn_autoload_prefix != NULL)
1915 {
1916 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1917 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001918 char_u *namep;
1919
1920 // skip a "<SNR>99_" prefix
1921 namep = untrans_function_name(name);
1922 if (namep == NULL)
1923 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001924
1925 // An exported function in an autoload script is stored as
1926 // "dir#path#name".
1927 if (len < sizeof(buffer))
1928 auto_name = buffer;
1929 else
1930 auto_name = alloc(len);
1931 if (auto_name != NULL)
1932 {
1933 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001934 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001935 hi = hash_find(&func_hashtab, auto_name);
1936 if (auto_name != buffer)
1937 vim_free(auto_name);
1938 if (!HASHITEM_EMPTY(hi))
1939 return HI2UF(hi);
1940 }
1941 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942
1943 return NULL;
1944}
1945
1946/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001948 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1949 * functions.
1950 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951 * Return NULL for unknown function.
1952 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001953 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001954find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001955{
1956 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001958
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001959 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001961 int find_script_local = in_vim9script() && eval_isnamec1(*name)
1962 && (name[1] != ':' || *name == 's');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001963
Bram Moolenaar95006e32020-08-29 17:47:08 +02001964 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001965 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001966 // Find script-local function before global one.
Bram Moolenaar33b968d2021-12-13 11:31:04 +00001967 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
1968 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001969 if (func != NULL)
1970 return func;
1971 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001972 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001973
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001974 if ((flags & FFED_NO_GLOBAL) == 0)
1975 {
1976 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02001977 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001978 if (!HASHITEM_EMPTY(hi))
1979 return HI2UF(hi);
1980 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001981
Bram Moolenaarb8822442022-01-11 15:24:05 +00001982 // Find autoload function if this is an autoload script.
1983 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
1984 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001985}
1986
1987/*
1988 * Find a function by name, return pointer to it in ufuncs.
1989 * "cctx" is passed in a :def function to find imported functions.
1990 * Return NULL for unknown or dead function.
1991 */
1992 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001993find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001994{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001995 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001996
1997 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1998 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001999 return NULL;
2000}
2001
2002/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002003 * Return TRUE if "ufunc" is a global function.
2004 */
2005 int
2006func_is_global(ufunc_T *ufunc)
2007{
2008 return ufunc->uf_name[0] != K_SPECIAL;
2009}
2010
2011/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002012 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2013 */
2014 int
2015func_requires_g_prefix(ufunc_T *ufunc)
2016{
2017 return ufunc->uf_name[0] != K_SPECIAL
2018 && (ufunc->uf_flags & FC_LAMBDA) == 0
2019 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2020}
2021
2022/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002023 * Copy the function name of "fp" to buffer "buf".
2024 * "buf" must be able to hold the function name plus three bytes.
2025 * Takes care of script-local function names.
2026 */
2027 static void
2028cat_func_name(char_u *buf, ufunc_T *fp)
2029{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002030 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002031 {
2032 STRCPY(buf, "<SNR>");
2033 STRCAT(buf, fp->uf_name + 3);
2034 }
2035 else
2036 STRCPY(buf, fp->uf_name);
2037}
2038
2039/*
2040 * Add a number variable "name" to dict "dp" with value "nr".
2041 */
2042 static void
2043add_nr_var(
2044 dict_T *dp,
2045 dictitem_T *v,
2046 char *name,
2047 varnumber_T nr)
2048{
2049 STRCPY(v->di_key, name);
2050 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2051 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2052 v->di_tv.v_type = VAR_NUMBER;
2053 v->di_tv.v_lock = VAR_FIXED;
2054 v->di_tv.vval.v_number = nr;
2055}
2056
2057/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002058 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002059 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002060 static void
2061free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002062{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002063 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002064
2065 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2066 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002067 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002068
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002069 // When garbage collecting a funccall_T may be freed before the
2070 // function that references it, clear its uf_scoped field.
2071 // The function may have been redefined and point to another
2072 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002073 if (fp != NULL && fp->uf_scoped == fc)
2074 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002075 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002076 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002077
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002078 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002079 vim_free(fc);
2080}
2081
2082/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002083 * Free "fc" and what it contains.
2084 * Can be called only when "fc" is kept beyond the period of it called,
2085 * i.e. after cleanup_function_call(fc).
2086 */
2087 static void
2088free_funccal_contents(funccall_T *fc)
2089{
2090 listitem_T *li;
2091
2092 // Free all l: variables.
2093 vars_clear(&fc->l_vars.dv_hashtab);
2094
2095 // Free all a: variables.
2096 vars_clear(&fc->l_avars.dv_hashtab);
2097
2098 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002099 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002100 clear_tv(&li->li_tv);
2101
2102 free_funccal(fc);
2103}
2104
2105/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002106 * Handle the last part of returning from a function: free the local hashtable.
2107 * Unless it is still in use by a closure.
2108 */
2109 static void
2110cleanup_function_call(funccall_T *fc)
2111{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002112 int may_free_fc = fc->fc_refcount <= 0;
2113 int free_fc = TRUE;
2114
Bram Moolenaar6914c642017-04-01 21:21:30 +02002115 current_funccal = fc->caller;
2116
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002117 // Free all l: variables if not referred.
2118 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2119 vars_clear(&fc->l_vars.dv_hashtab);
2120 else
2121 free_fc = FALSE;
2122
2123 // If the a:000 list and the l: and a: dicts are not referenced and
2124 // there is no closure using it, we can free the funccall_T and what's
2125 // in it.
2126 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2127 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002128 else
2129 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002130 int todo;
2131 hashitem_T *hi;
2132 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002133
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002134 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002135
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002136 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002137 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2138 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2139 {
2140 if (!HASHITEM_EMPTY(hi))
2141 {
2142 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002143 di = HI2DI(hi);
2144 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002145 }
2146 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002147 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002148
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002149 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2150 fc->l_varlist.lv_first = NULL;
2151 else
2152 {
2153 listitem_T *li;
2154
2155 free_fc = FALSE;
2156
2157 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002158 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002159 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002160 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002161
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002162 if (free_fc)
2163 free_funccal(fc);
2164 else
2165 {
2166 static int made_copy = 0;
2167
2168 // "fc" is still in use. This can happen when returning "a:000",
2169 // assigning "l:" to a global variable or defining a closure.
2170 // Link "fc" in the list for garbage collection later.
2171 fc->caller = previous_funccal;
2172 previous_funccal = fc;
2173
2174 if (want_garbage_collect)
2175 // If garbage collector is ready, clear count.
2176 made_copy = 0;
2177 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002178 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002179 // We have made a lot of copies, worth 4 Mbyte. This can happen
2180 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002181 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002182 // too much memory.
2183 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002184 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002185 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002186 }
2187}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002188
2189/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002190 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2191 */
2192 static int
2193numbered_function(char_u *name)
2194{
2195 return isdigit(*name)
2196 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2197}
2198
2199/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002200 * There are two kinds of function names:
2201 * 1. ordinary names, function defined with :function or :def
2202 * 2. numbered functions and lambdas
2203 * For the first we only count the name stored in func_hashtab as a reference,
2204 * using function() does not count as a reference, because the function is
2205 * looked up by name.
2206 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002207 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002208func_name_refcount(char_u *name)
2209{
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002210 return numbered_function(name) || *name == '<';
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002211}
2212
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002213/*
2214 * Unreference "fc": decrement the reference count and free it when it
2215 * becomes zero. "fp" is detached from "fc".
2216 * When "force" is TRUE we are exiting.
2217 */
2218 static void
2219funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2220{
2221 funccall_T **pfc;
2222 int i;
2223
2224 if (fc == NULL)
2225 return;
2226
2227 if (--fc->fc_refcount <= 0 && (force || (
2228 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2229 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2230 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2231 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2232 {
2233 if (fc == *pfc)
2234 {
2235 *pfc = fc->caller;
2236 free_funccal_contents(fc);
2237 return;
2238 }
2239 }
2240 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2241 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2242 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2243}
2244
2245/*
2246 * Remove the function from the function hashtable. If the function was
2247 * deleted while it still has references this was already done.
2248 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2249 */
2250 static int
2251func_remove(ufunc_T *fp)
2252{
2253 hashitem_T *hi;
2254
2255 // Return if it was already virtually deleted.
2256 if (fp->uf_flags & FC_DEAD)
2257 return FALSE;
2258
2259 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2260 if (!HASHITEM_EMPTY(hi))
2261 {
2262 // When there is a def-function index do not actually remove the
2263 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002264 // Do remove it when it's a copy.
2265 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002266 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002267 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002268 return FALSE;
2269 }
2270 hash_remove(&func_hashtab, hi);
2271 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002272 return TRUE;
2273 }
2274 return FALSE;
2275}
2276
2277 static void
2278func_clear_items(ufunc_T *fp)
2279{
2280 ga_clear_strings(&(fp->uf_args));
2281 ga_clear_strings(&(fp->uf_def_args));
2282 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002283 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002284 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002285 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002286 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002287
2288 // Increment the refcount of this function to avoid it being freed
2289 // recursively when the partial is freed.
2290 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002291 partial_unref(fp->uf_partial);
2292 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002293 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002294
2295#ifdef FEAT_LUA
2296 if (fp->uf_cb_free != NULL)
2297 {
2298 fp->uf_cb_free(fp->uf_cb_state);
2299 fp->uf_cb_free = NULL;
2300 }
2301
2302 fp->uf_cb_state = NULL;
2303 fp->uf_cb = NULL;
2304#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002305#ifdef FEAT_PROFILE
2306 VIM_CLEAR(fp->uf_tml_count);
2307 VIM_CLEAR(fp->uf_tml_total);
2308 VIM_CLEAR(fp->uf_tml_self);
2309#endif
2310}
2311
2312/*
2313 * Free all things that a function contains. Does not free the function
2314 * itself, use func_free() for that.
2315 * When "force" is TRUE we are exiting.
2316 */
2317 static void
2318func_clear(ufunc_T *fp, int force)
2319{
2320 if (fp->uf_cleared)
2321 return;
2322 fp->uf_cleared = TRUE;
2323
2324 // clear this function
2325 func_clear_items(fp);
2326 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002327 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002328}
2329
2330/*
2331 * Free a function and remove it from the list of functions. Does not free
2332 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002333 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002334 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002335 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002336 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002337func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002338{
2339 // Only remove it when not done already, otherwise we would remove a newer
2340 // version of the function with the same name.
2341 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2342 func_remove(fp);
2343
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002344 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002345 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002346 if (fp->uf_dfunc_idx > 0)
2347 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002348 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002349 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002350 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002351 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002352 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002353}
2354
2355/*
2356 * Free all things that a function contains and free the function itself.
2357 * When "force" is TRUE we are exiting.
2358 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002359 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002360func_clear_free(ufunc_T *fp, int force)
2361{
2362 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002363 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2364 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002365 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002366 else
2367 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002368}
2369
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002370/*
2371 * Copy already defined function "lambda" to a new function with name "global".
2372 * This is for when a compiled function defines a global function.
2373 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002374 int
2375copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002376{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002377 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002378 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002379
2380 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002381 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002382 semsg(_(e_lambda_function_not_found_str), lambda);
2383 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002384 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002385
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002386 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002387 if (fp != NULL)
2388 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002389 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002390 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002391 return FAIL;
2392 }
2393
2394 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2395 if (fp == NULL)
2396 return FAIL;
2397
2398 fp->uf_varargs = ufunc->uf_varargs;
2399 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2400 fp->uf_def_status = ufunc->uf_def_status;
2401 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2402 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2403 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2404 == FAIL
2405 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2406 goto failed;
2407
2408 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2409 : vim_strsave(ufunc->uf_name_exp);
2410 if (ufunc->uf_arg_types != NULL)
2411 {
2412 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2413 if (fp->uf_arg_types == NULL)
2414 goto failed;
2415 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2416 sizeof(type_T *) * fp->uf_args.ga_len);
2417 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002418 if (ufunc->uf_va_name != NULL)
2419 {
2420 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2421 if (fp->uf_va_name == NULL)
2422 goto failed;
2423 }
2424 fp->uf_ret_type = ufunc->uf_ret_type;
2425
2426 fp->uf_refcount = 1;
2427 STRCPY(fp->uf_name, global);
2428 hash_add(&func_hashtab, UF2HIKEY(fp));
2429
2430 // the referenced dfunc_T is now used one more time
2431 link_def_function(fp);
2432
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002433 // Create a partial to store the context of the function where it was
2434 // instantiated. Only needs to be done once. Do this on the original
2435 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002436 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2437 {
2438 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2439
2440 if (pt == NULL)
2441 goto failed;
2442 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002443 {
2444 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002445 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002446 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002447 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002448 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002449 }
2450
2451 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002452
2453failed:
2454 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002455 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002456}
2457
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002458static int funcdepth = 0;
2459
2460/*
2461 * Increment the function call depth count.
2462 * Return FAIL when going over 'maxfuncdepth'.
2463 * Otherwise return OK, must call funcdepth_decrement() later!
2464 */
2465 int
2466funcdepth_increment(void)
2467{
2468 if (funcdepth >= p_mfd)
2469 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002470 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002471 return FAIL;
2472 }
2473 ++funcdepth;
2474 return OK;
2475}
2476
2477 void
2478funcdepth_decrement(void)
2479{
2480 --funcdepth;
2481}
2482
2483/*
2484 * Get the current function call depth.
2485 */
2486 int
2487funcdepth_get(void)
2488{
2489 return funcdepth;
2490}
2491
2492/*
2493 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002494 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002495 * times as funcdepth_increment().
2496 */
2497 void
2498funcdepth_restore(int depth)
2499{
2500 funcdepth = depth;
2501}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002502
2503/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 * Call a user function.
2505 */
2506 static void
2507call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002508 ufunc_T *fp, // pointer to function
2509 int argcount, // nr of args
2510 typval_T *argvars, // arguments
2511 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002512 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002513 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002515 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002516 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002517 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 funccall_T *fc;
2519 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002520 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002522 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 int i;
2524 int ai;
2525 int islambda = FALSE;
2526 char_u numbuf[NUMBUFLEN];
2527 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002528 typval_T *tv_to_free[MAX_FUNC_ARGS];
2529 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002531 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002533 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534
Bram Moolenaarb2049902021-01-24 12:53:53 +01002535#ifdef FEAT_PROFILE
2536 CLEAR_FIELD(profile_info);
2537#endif
2538
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002539 // If depth of calling is getting too high, don't execute the function.
2540 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542 rettv->v_type = VAR_NUMBER;
2543 rettv->vval.v_number = -1;
2544 return;
2545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002546
Bram Moolenaare38eab22019-12-05 21:50:01 +01002547 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002548
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002549 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002550 if (fc == NULL)
2551 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002552 fc->caller = current_funccal;
2553 current_funccal = fc;
2554 fc->func = fp;
2555 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002557 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2559 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002560 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002561 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002562 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002563
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002564 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002565 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002566#ifdef FEAT_PROFILE
2567 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2568#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002569 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002570#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002571 if (do_profiling == PROF_YES)
2572 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002573#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002574 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002575 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002576 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002577#ifdef FEAT_PROFILE
2578 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002579 || (caller != NULL && caller->uf_profiling)))
2580 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002581#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002582 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002583 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002584 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002585 return;
2586 }
2587
Bram Moolenaar38453522021-11-28 22:00:12 +00002588 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002589
2590 /*
2591 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2592 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2593 * each argument variable and saves a lot of time.
2594 */
2595 /*
2596 * Init l: variables.
2597 */
2598 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2599 if (selfdict != NULL)
2600 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002601 // Set l:self to "selfdict". Use "name" to avoid a warning from
2602 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 v = &fc->fixvar[fixvar_idx++].var;
2604 name = v->di_key;
2605 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002606 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2608 v->di_tv.v_type = VAR_DICT;
2609 v->di_tv.v_lock = 0;
2610 v->di_tv.vval.v_dict = selfdict;
2611 ++selfdict->dv_refcount;
2612 }
2613
2614 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002615 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002616 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002617 * Set a:000 to a list with room for the "..." arguments.
2618 */
2619 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002620 if ((fp->uf_flags & FC_NOARGS) == 0)
2621 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002622 (varnumber_T)(argcount >= fp->uf_args.ga_len
2623 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002624 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002625 if ((fp->uf_flags & FC_NOARGS) == 0)
2626 {
2627 // Use "name" to avoid a warning from some compiler that checks the
2628 // destination size.
2629 v = &fc->fixvar[fixvar_idx++].var;
2630 name = v->di_key;
2631 STRCPY(name, "000");
2632 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2633 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2634 v->di_tv.v_type = VAR_LIST;
2635 v->di_tv.v_lock = VAR_FIXED;
2636 v->di_tv.vval.v_list = &fc->l_varlist;
2637 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002638 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2640 fc->l_varlist.lv_lock = VAR_FIXED;
2641
2642 /*
2643 * Set a:firstline to "firstline" and a:lastline to "lastline".
2644 * Set a:name to named arguments.
2645 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002646 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002648 if ((fp->uf_flags & FC_NOARGS) == 0)
2649 {
2650 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002651 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002652 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002653 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002654 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002655 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 {
2657 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002658 typval_T def_rettv;
2659 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660
2661 ai = i - fp->uf_args.ga_len;
2662 if (ai < 0)
2663 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002664 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 name = FUNCARG(fp, i);
2666 if (islambda)
2667 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002668
2669 // evaluate named argument default expression
2670 isdefault = ai + fp->uf_def_args.ga_len >= 0
2671 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2672 && argvars[i].vval.v_number == VVAL_NONE));
2673 if (isdefault)
2674 {
2675 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002676
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002677 def_rettv.v_type = VAR_NUMBER;
2678 def_rettv.vval.v_number = -1;
2679
2680 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2681 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002682 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002683 {
2684 default_arg_err = 1;
2685 break;
2686 }
2687 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688 }
2689 else
2690 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002691 if ((fp->uf_flags & FC_NOARGS) != 0)
2692 // Bail out if no a: arguments used (in lambda).
2693 break;
2694
Bram Moolenaare38eab22019-12-05 21:50:01 +01002695 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696 sprintf((char *)numbuf, "%d", ai + 1);
2697 name = numbuf;
2698 }
2699 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2700 {
2701 v = &fc->fixvar[fixvar_idx++].var;
2702 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002703 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 }
2705 else
2706 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002707 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708 if (v == NULL)
2709 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002710 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002713 // Note: the values are copied directly to avoid alloc/free.
2714 // "argvars" must have VAR_FIXED for v_lock.
2715 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 v->di_tv.v_lock = VAR_FIXED;
2717
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002718 if (isdefault)
2719 // Need to free this later, no matter where it's stored.
2720 tv_to_free[tv_to_free_len++] = &v->di_tv;
2721
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722 if (addlocal)
2723 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002724 // Named arguments should be accessed without the "a:" prefix in
2725 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002726 copy_tv(&v->di_tv, &v->di_tv);
2727 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002729 else
2730 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731
2732 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2733 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002734 listitem_T *li = &fc->l_listitems[ai];
2735
2736 li->li_tv = argvars[i];
2737 li->li_tv.v_lock = VAR_FIXED;
2738 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 }
2740 }
2741
Bram Moolenaare38eab22019-12-05 21:50:01 +01002742 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002744
2745 if (fp->uf_flags & FC_SANDBOX)
2746 {
2747 using_sandbox = TRUE;
2748 ++sandbox;
2749 }
2750
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002751 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002752 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002753 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002755 ++no_wait_return;
2756 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002758 smsg(_("calling %s"), SOURCING_NAME);
2759 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002761 char_u buf[MSG_BUF_LEN];
2762 char_u numbuf2[NUMBUFLEN];
2763 char_u *tofree;
2764 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002766 msg_puts("(");
2767 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002769 if (i > 0)
2770 msg_puts(", ");
2771 if (argvars[i].v_type == VAR_NUMBER)
2772 msg_outnum((long)argvars[i].vval.v_number);
2773 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002775 // Do not want errors such as E724 here.
2776 ++emsg_off;
2777 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2778 --emsg_off;
2779 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002781 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002783 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2784 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002786 msg_puts((char *)s);
2787 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 }
2789 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002791 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002793 msg_puts("\n"); // don't overwrite this either
2794
2795 verbose_leave_scroll();
2796 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 }
2798#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002799 if (do_profiling == PROF_YES)
2800 profile_may_start_func(&profile_info, fp,
2801 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802#endif
2803
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002804 // "legacy" does not apply to commands in the function
2805 sticky_cmdmod_flags = 0;
2806
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002807 save_current_sctx = current_sctx;
2808 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 save_did_emsg = did_emsg;
2810 did_emsg = FALSE;
2811
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002812 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2813 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002814 else if (islambda)
2815 {
2816 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2817
2818 // A Lambda always has the command "return {expr}". It is much faster
2819 // to evaluate {expr} directly.
2820 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002821 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002822 --ex_nesting_level;
2823 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002824 else
2825 // call do_cmdline() to execute the lines
2826 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2828
2829 --RedrawingDisabled;
2830
Bram Moolenaare38eab22019-12-05 21:50:01 +01002831 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2833 {
2834 clear_tv(rettv);
2835 rettv->v_type = VAR_NUMBER;
2836 rettv->vval.v_number = -1;
2837 }
2838
2839#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002840 if (do_profiling == PROF_YES)
2841 {
2842 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2843
2844 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2845 profile_may_end_func(&profile_info, fp, caller);
2846 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847#endif
2848
Bram Moolenaare38eab22019-12-05 21:50:01 +01002849 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 if (p_verbose >= 12)
2851 {
2852 ++no_wait_return;
2853 verbose_enter_scroll();
2854
2855 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002856 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002858 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 (long)fc->rettv->vval.v_number);
2860 else
2861 {
2862 char_u buf[MSG_BUF_LEN];
2863 char_u numbuf2[NUMBUFLEN];
2864 char_u *tofree;
2865 char_u *s;
2866
Bram Moolenaare38eab22019-12-05 21:50:01 +01002867 // The value may be very long. Skip the middle part, so that we
2868 // have some idea how it starts and ends. smsg() would always
2869 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870 ++emsg_off;
2871 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2872 --emsg_off;
2873 if (s != NULL)
2874 {
2875 if (vim_strsize(s) > MSG_BUF_CLEN)
2876 {
2877 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2878 s = buf;
2879 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002880 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881 vim_free(tofree);
2882 }
2883 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002884 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002885
2886 verbose_leave_scroll();
2887 --no_wait_return;
2888 }
2889
Bram Moolenaare31ee862020-01-07 20:59:34 +01002890 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002891 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002892 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893#ifdef FEAT_PROFILE
2894 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002895 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002897 if (using_sandbox)
2898 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002899 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002900
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002901 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902 {
2903 ++no_wait_return;
2904 verbose_enter_scroll();
2905
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002906 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002907 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002908
2909 verbose_leave_scroll();
2910 --no_wait_return;
2911 }
2912
2913 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002914 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002915 for (i = 0; i < tv_to_free_len; ++i)
2916 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002917 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918}
2919
2920/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002921 * Check the argument count for user function "fp".
2922 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2923 */
2924 int
2925check_user_func_argcount(ufunc_T *fp, int argcount)
2926{
2927 int regular_args = fp->uf_args.ga_len;
2928
2929 if (argcount < regular_args - fp->uf_def_args.ga_len)
2930 return FCERR_TOOFEW;
2931 else if (!has_varargs(fp) && argcount > regular_args)
2932 return FCERR_TOOMANY;
2933 return FCERR_UNKNOWN;
2934}
2935
2936/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002937 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002938 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002939 int
2940call_user_func_check(
2941 ufunc_T *fp,
2942 int argcount,
2943 typval_T *argvars,
2944 typval_T *rettv,
2945 funcexe_T *funcexe,
2946 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002947{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002948 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002949
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002950 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
2951 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002952 error = check_user_func_argcount(fp, argcount);
2953 if (error != FCERR_UNKNOWN)
2954 return error;
2955 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002956 error = FCERR_DICT;
2957 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002958 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002959 int did_save_redo = FALSE;
2960 save_redo_T save_redo;
2961
2962 /*
2963 * Call the user function.
2964 * Save and restore search patterns, script variables and
2965 * redo buffer.
2966 */
2967 save_search_patterns();
2968 if (!ins_compl_active())
2969 {
2970 saveRedobuff(&save_redo);
2971 did_save_redo = TRUE;
2972 }
2973 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002974 call_user_func(fp, argcount, argvars, rettv, funcexe,
2975 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002976 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2977 // Function was unreferenced while being used, free it now.
2978 func_clear_free(fp, FALSE);
2979 if (did_save_redo)
2980 restoreRedobuff(&save_redo);
2981 restore_search_patterns();
2982 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002983 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002984 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002985}
2986
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002987static funccal_entry_T *funccal_stack = NULL;
2988
2989/*
2990 * Save the current function call pointer, and set it to NULL.
2991 * Used when executing autocommands and for ":source".
2992 */
2993 void
2994save_funccal(funccal_entry_T *entry)
2995{
2996 entry->top_funccal = current_funccal;
2997 entry->next = funccal_stack;
2998 funccal_stack = entry;
2999 current_funccal = NULL;
3000}
3001
3002 void
3003restore_funccal(void)
3004{
3005 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003006 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003007 else
3008 {
3009 current_funccal = funccal_stack->top_funccal;
3010 funccal_stack = funccal_stack->next;
3011 }
3012}
3013
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003014 funccall_T *
3015get_current_funccal(void)
3016{
3017 return current_funccal;
3018}
3019
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003020/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003021 * Return TRUE when currently at the script level:
3022 * - not in a function
3023 * - not executing an autocommand
3024 * Note that when an autocommand sources a script the result is FALSE;
3025 */
3026 int
3027at_script_level(void)
3028{
3029 return current_funccal == NULL && autocmd_match == NULL;
3030}
3031
3032/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003033 * Mark all functions of script "sid" as deleted.
3034 */
3035 void
3036delete_script_functions(int sid)
3037{
3038 hashitem_T *hi;
3039 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003040 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003041 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003042 size_t len;
3043
3044 buf[0] = K_SPECIAL;
3045 buf[1] = KS_EXTRA;
3046 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003047 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003048 len = STRLEN(buf);
3049
Bram Moolenaarce658352020-07-31 23:47:12 +02003050 while (todo > 0)
3051 {
3052 todo = func_hashtab.ht_used;
3053 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3054 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003055 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003056 fp = HI2UF(hi);
3057 if (STRNCMP(fp->uf_name, buf, len) == 0)
3058 {
3059 int changed = func_hashtab.ht_changed;
3060
3061 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003062
3063 if (fp->uf_calls > 0)
3064 {
3065 // Function is executing, don't free it but do remove
3066 // it from the hashtable.
3067 if (func_remove(fp))
3068 fp->uf_refcount--;
3069 }
3070 else
3071 {
3072 func_clear(fp, TRUE);
3073 // When clearing a function another function can be
3074 // cleared as a side effect. When that happens start
3075 // over.
3076 if (changed != func_hashtab.ht_changed)
3077 break;
3078 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003079 }
3080 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003081 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003082 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003083}
3084
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003085#if defined(EXITFREE) || defined(PROTO)
3086 void
3087free_all_functions(void)
3088{
3089 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003090 ufunc_T *fp;
3091 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003092 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003093 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003094
Bram Moolenaare38eab22019-12-05 21:50:01 +01003095 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003096 while (current_funccal != NULL)
3097 {
3098 clear_tv(current_funccal->rettv);
3099 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003100 if (current_funccal == NULL && funccal_stack != NULL)
3101 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003102 }
3103
Bram Moolenaare38eab22019-12-05 21:50:01 +01003104 // First clear what the functions contain. Since this may lower the
3105 // reference count of a function, it may also free a function and change
3106 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003107 while (todo > 0)
3108 {
3109 todo = func_hashtab.ht_used;
3110 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3111 if (!HASHITEM_EMPTY(hi))
3112 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003113 // clear the def function index now
3114 fp = HI2UF(hi);
3115 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003116 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003117
Bram Moolenaare38eab22019-12-05 21:50:01 +01003118 // Only free functions that are not refcounted, those are
3119 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003120 if (func_name_refcount(fp->uf_name))
3121 ++skipped;
3122 else
3123 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003124 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003125 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003126 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003127 {
3128 skipped = 0;
3129 break;
3130 }
3131 }
3132 --todo;
3133 }
3134 }
3135
Bram Moolenaare38eab22019-12-05 21:50:01 +01003136 // Now actually free the functions. Need to start all over every time,
3137 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003138 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003139 while (func_hashtab.ht_used > skipped)
3140 {
3141 todo = func_hashtab.ht_used;
3142 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 if (!HASHITEM_EMPTY(hi))
3144 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003145 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003146 // Only free functions that are not refcounted, those are
3147 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003148 fp = HI2UF(hi);
3149 if (func_name_refcount(fp->uf_name))
3150 ++skipped;
3151 else
3152 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003153 if (func_free(fp, FALSE) == OK)
3154 {
3155 skipped = 0;
3156 break;
3157 }
3158 // did not actually free it
3159 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003160 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003162 }
3163 if (skipped == 0)
3164 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003165
3166 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167}
3168#endif
3169
3170/*
3171 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003172 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3173 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003174 * "len" is the length of "name", or -1 for NUL terminated.
3175 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003176 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177builtin_function(char_u *name, int len)
3178{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003179 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003180
Bram Moolenaara26b9702020-04-18 19:53:28 +02003181 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003182 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003183 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3184 {
3185 if (name[i] == AUTOLOAD_CHAR)
3186 return FALSE;
3187 if (!eval_isnamec(name[i]))
3188 {
3189 // "name.something" is not a builtin function
3190 if (name[i] == '.')
3191 return FALSE;
3192 break;
3193 }
3194 }
3195 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003196}
3197
3198 int
3199func_call(
3200 char_u *name,
3201 typval_T *args,
3202 partial_T *partial,
3203 dict_T *selfdict,
3204 typval_T *rettv)
3205{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003206 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207 listitem_T *item;
3208 typval_T argv[MAX_FUNC_ARGS + 1];
3209 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 int r = 0;
3211
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003212 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003213 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 {
3215 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3216 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003217 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218 break;
3219 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003220 // Make a copy of each argument. This is needed to be able to set
3221 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003222 copy_tv(&item->li_tv, &argv[argc++]);
3223 }
3224
3225 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003226 {
3227 funcexe_T funcexe;
3228
Bram Moolenaara80faa82020-04-12 19:37:17 +02003229 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003230 funcexe.fe_firstline = curwin->w_cursor.lnum;
3231 funcexe.fe_lastline = curwin->w_cursor.lnum;
3232 funcexe.fe_evaluate = TRUE;
3233 funcexe.fe_partial = partial;
3234 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003235 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3236 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003237
Bram Moolenaare38eab22019-12-05 21:50:01 +01003238 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239 while (argc > 0)
3240 clear_tv(&argv[--argc]);
3241
3242 return r;
3243}
3244
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003245static int callback_depth = 0;
3246
3247 int
3248get_callback_depth(void)
3249{
3250 return callback_depth;
3251}
3252
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003254 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003255 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003256 */
3257 int
3258call_callback(
3259 callback_T *callback,
3260 int len, // length of "name" or -1 to use strlen()
3261 typval_T *rettv, // return value goes here
3262 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003263 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003264 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003265{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003266 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003267 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003268
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003269 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3270 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003271 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003272 funcexe.fe_evaluate = TRUE;
3273 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003274 ++callback_depth;
3275 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3276 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003277
3278 // When a :def function was called that uses :try an error would be turned
3279 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003280 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003281 {
3282 need_rethrow = FALSE;
3283 handle_did_throw();
3284 }
3285
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003286 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003287}
3288
3289/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003290 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003291 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003292 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3293 */
3294 varnumber_T
3295call_callback_retnr(
3296 callback_T *callback,
3297 int argcount, // number of "argvars"
3298 typval_T *argvars) // vars for arguments, must have "argcount"
3299 // PLUS ONE elements!
3300{
3301 typval_T rettv;
3302 varnumber_T retval;
3303
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003304 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003305 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003306
3307 retval = tv_get_number_chk(&rettv, NULL);
3308 clear_tv(&rettv);
3309 return retval;
3310}
3311
3312/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003313 * Give an error message for the result of a function.
3314 * Nothing if "error" is FCERR_NONE.
3315 */
3316 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003317user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003318{
3319 switch (error)
3320 {
3321 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003322 if (funcexe->fe_found_var)
3323 semsg(_(e_not_callable_type_str), name);
3324 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003325 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003326 break;
3327 case FCERR_NOTMETHOD:
3328 emsg_funcname(
Bram Moolenaar9a846fb2022-01-01 21:59:18 +00003329 N_(e_cannot_use_function_as_method_str), name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003330 break;
3331 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003332 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003333 break;
3334 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003335 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003336 break;
3337 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003338 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003339 break;
3340 case FCERR_SCRIPT:
3341 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00003342 e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003343 break;
3344 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003345 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3346 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003347 break;
3348 }
3349}
3350
3351/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003353 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 * Return FAIL when the function can't be called, OK otherwise.
3355 * Also returns OK when an error was encountered while executing the function.
3356 */
3357 int
3358call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003359 char_u *funcname, // name of the function
3360 int len, // length of "name" or -1 to use strlen()
3361 typval_T *rettv, // return value goes here
3362 int argcount_in, // number of "argvars"
3363 typval_T *argvars_in, // vars for arguments, must have "argcount"
3364 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003365 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366{
3367 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003368 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003370 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 char_u fname_buf[FLEN_FIXED + 1];
3372 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003373 char_u *fname = NULL;
3374 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 int argcount = argcount_in;
3376 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003377 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003378 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003379 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003381 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003382 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003383 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003384 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003386 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3387 // even when call_func() returns FAIL.
3388 rettv->v_type = VAR_UNKNOWN;
3389
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003390 if (partial != NULL)
3391 fp = partial->pt_func;
3392 if (fp == NULL)
3393 {
3394 // Make a copy of the name, if it comes from a funcref variable it
3395 // could be changed or deleted in the called function.
3396 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3397 if (name == NULL)
3398 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003400 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3401 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003403 if (funcexe->fe_doesrange != NULL)
3404 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003405
3406 if (partial != NULL)
3407 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003408 // When the function has a partial with a dict and there is a dict
3409 // argument, use the dict argument. That is backwards compatible.
3410 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003411 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003412 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003413 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 {
3415 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003416 {
3417 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3418 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003419 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003420 goto theend;
3421 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003423 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 for (i = 0; i < argcount_in; ++i)
3425 argv[i + argv_clear] = argvars_in[i];
3426 argvars = argv;
3427 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003428
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003429 if (funcexe->fe_check_type != NULL
3430 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003431 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003432 // Now funcexe->fe_check_type is missing the added arguments,
3433 // make a copy of the type with the correction.
3434 check_type = *funcexe->fe_check_type;
3435 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003436 check_type.tt_args = check_type_args;
3437 CLEAR_FIELD(check_type_args);
3438 for (i = 0; i < check_type.tt_argcount; ++i)
3439 check_type_args[i + partial->pt_argc] =
3440 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003441 check_type.tt_argcount += partial->pt_argc;
3442 check_type.tt_min_argcount += partial->pt_argc;
3443 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 }
3445 }
3446
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003447 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3448 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003449 {
3450 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003451 if (check_argument_types(funcexe->fe_check_type,
3452 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003453 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003454 error = FCERR_OTHER;
3455 }
3456
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003457 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 {
3459 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003460 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461
Bram Moolenaar333894b2020-08-01 18:53:07 +02003462 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003463 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003464 {
3465 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003467 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003468
Bram Moolenaare38eab22019-12-05 21:50:01 +01003469 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003471 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003473 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003474 {
3475 /*
3476 * User defined function.
3477 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003478 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003479 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003480 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003481 if (fp != NULL && !is_global && in_vim9script()
3482 && func_requires_g_prefix(fp))
3483 // In Vim9 script g: is required to find a global
3484 // non-autoload function.
3485 fp = NULL;
3486 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003487
Bram Moolenaare38eab22019-12-05 21:50:01 +01003488 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489 if (fp == NULL
3490 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003491 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492 && !aborting())
3493 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003494 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003495 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003497 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3499 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003500 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003501 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003503 if (fp == NULL)
3504 {
3505 char_u *p = untrans_function_name(rfname);
3506
3507 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003508 // Don't do this if the name starts with "s:".
3509 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003510 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003511 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003513 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003514 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003515#ifdef FEAT_LUA
3516 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3517 {
3518 cfunc_T cb = fp->uf_cb;
3519
3520 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3521 }
3522#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003523 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003524 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003525 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003526 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003527 argcount = funcexe->fe_argv_func(argcount, argvars,
3528 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003529
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003530 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003531 {
3532 // Method call: base->Method()
3533 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003534 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003535 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003536 argvars = argv;
3537 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003538 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003539
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003540 error = call_user_func_check(fp, argcount, argvars, rettv,
3541 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 }
3543 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003544 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003545 {
3546 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003547 * expr->method(): Find the method name in the table, call its
3548 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003549 */
3550 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003551 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 else
3554 {
3555 /*
3556 * Find the function name in the table, call its implementation.
3557 */
3558 error = call_internal_func(fname, argcount, argvars, rettv);
3559 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003560
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 /*
3562 * The function call (or "FuncUndefined" autocommand sequence) might
3563 * have been aborted by an error, an interrupt, or an explicitly thrown
3564 * exception that has not been caught so far. This situation can be
3565 * tested for by calling aborting(). For an error in an internal
3566 * function or for the "E132" error in call_user_func(), however, the
3567 * throw point at which the "force_abort" flag (temporarily reset by
3568 * emsg()) is normally updated has not been reached yet. We need to
3569 * update that flag first to make aborting() reliable.
3570 */
3571 update_force_abort();
3572 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003573 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003574 ret = OK;
3575
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003576theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 /*
3578 * Report an error unless the argument evaluation or function call has been
3579 * cancelled due to an aborting error, an interrupt, or an exception.
3580 */
3581 if (!aborting())
3582 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003583 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584 }
3585
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003586 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003588 clear_tv(&argv[--argv_clear + argv_base]);
3589
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 vim_free(tofree);
3591 vim_free(name);
3592
3593 return ret;
3594}
3595
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003596 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003597printable_func_name(ufunc_T *fp)
3598{
3599 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3600}
3601
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003603 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 */
3605 static void
3606list_func_head(ufunc_T *fp, int indent)
3607{
3608 int j;
3609
3610 msg_start();
3611 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003612 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003613 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003614 msg_puts("def ");
3615 else
3616 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003617 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 msg_putchar('(');
3619 for (j = 0; j < fp->uf_args.ga_len; ++j)
3620 {
3621 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003622 msg_puts(", ");
3623 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003624 if (fp->uf_arg_types != NULL)
3625 {
3626 char *tofree;
3627
3628 msg_puts(": ");
3629 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3630 vim_free(tofree);
3631 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003632 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3633 {
3634 msg_puts(" = ");
3635 msg_puts(((char **)(fp->uf_def_args.ga_data))
3636 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3637 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638 }
3639 if (fp->uf_varargs)
3640 {
3641 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003642 msg_puts(", ");
3643 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003645 if (fp->uf_va_name != NULL)
3646 {
3647 if (j)
3648 msg_puts(", ");
3649 msg_puts("...");
3650 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003651 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003652 {
3653 char *tofree;
3654
3655 msg_puts(": ");
3656 msg_puts(type_name(fp->uf_va_type, &tofree));
3657 vim_free(tofree);
3658 }
3659 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003660 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003661
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003662 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003663 {
3664 if (fp->uf_ret_type != &t_void)
3665 {
3666 char *tofree;
3667
3668 msg_puts(": ");
3669 msg_puts(type_name(fp->uf_ret_type, &tofree));
3670 vim_free(tofree);
3671 }
3672 }
3673 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003674 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003676 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003678 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003679 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003680 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 msg_clr_eos();
3682 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003683 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684}
3685
3686/*
3687 * Get a function name, translating "<SID>" and "<SNR>".
3688 * Also handles a Funcref in a List or Dictionary.
3689 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003690 * Set "*is_global" to TRUE when the function must be global, unless
3691 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 * flags:
3693 * TFN_INT: internal function name OK
3694 * TFN_QUIET: be quiet
3695 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003696 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 * Advances "pp" to just after the function name (if no error).
3698 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003699 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700trans_function_name(
3701 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003702 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003703 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003705 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003706 partial_T **partial, // return: partial of a FuncRef
3707 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708{
3709 char_u *name = NULL;
3710 char_u *start;
3711 char_u *end;
3712 int lead;
3713 char_u sid_buf[20];
3714 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003715 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003716 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003718 int vim9script = in_vim9script();
3719 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720
3721 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003722 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 start = *pp;
3724
Bram Moolenaare38eab22019-12-05 21:50:01 +01003725 // Check for hard coded <SNR>: already translated function ID (from a user
3726 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3728 && (*pp)[2] == (int)KE_SNR)
3729 {
3730 *pp += 3;
3731 len = get_id_len(pp) + 3;
3732 return vim_strnsave(start, len);
3733 }
3734
Bram Moolenaare38eab22019-12-05 21:50:01 +01003735 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3736 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 lead = eval_fname_script(start);
3738 if (lead > 2)
3739 start += lead;
3740
Bram Moolenaare38eab22019-12-05 21:50:01 +01003741 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003742 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003744 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003745 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003746 {
3747 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003748 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749 goto theend;
3750 }
3751 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3752 {
3753 /*
3754 * Report an invalid expression in braces, unless the expression
3755 * evaluation has been cancelled due to an aborting error, an
3756 * interrupt, or an exception.
3757 */
3758 if (!aborting())
3759 {
3760 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003761 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003762 }
3763 else
3764 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3765 goto theend;
3766 }
3767
3768 if (lv.ll_tv != NULL)
3769 {
3770 if (fdp != NULL)
3771 {
3772 fdp->fd_dict = lv.ll_dict;
3773 fdp->fd_newkey = lv.ll_newkey;
3774 lv.ll_newkey = NULL;
3775 fdp->fd_di = lv.ll_di;
3776 }
3777 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3778 {
3779 name = vim_strsave(lv.ll_tv->vval.v_string);
3780 *pp = end;
3781 }
3782 else if (lv.ll_tv->v_type == VAR_PARTIAL
3783 && lv.ll_tv->vval.v_partial != NULL)
3784 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003785 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 *pp = end;
3787 if (partial != NULL)
3788 *partial = lv.ll_tv->vval.v_partial;
3789 }
3790 else
3791 {
3792 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3793 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003794 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 else
3796 *pp = end;
3797 name = NULL;
3798 }
3799 goto theend;
3800 }
3801
3802 if (lv.ll_name == NULL)
3803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003804 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 *pp = end;
3806 goto theend;
3807 }
3808
Bram Moolenaare38eab22019-12-05 21:50:01 +01003809 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 if (lv.ll_exp_name != NULL)
3811 {
3812 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003813 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003814 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815 if (name == lv.ll_exp_name)
3816 name = NULL;
3817 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003818 else if (lv.ll_sid > 0)
3819 {
3820 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3821 int cc = *lv.ll_name_end;
3822
3823 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3824 *lv.ll_name_end = NUL;
3825 if (si->sn_autoload_prefix != NULL)
3826 {
3827 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3828 }
3829 else
3830 {
3831 sid_buf[0] = K_SPECIAL;
3832 sid_buf[1] = KS_EXTRA;
3833 sid_buf[2] = (int)KE_SNR;
3834 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003835 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003836 name = concat_str(sid_buf, lv.ll_name);
3837 }
3838 *lv.ll_name_end = cc;
3839 *pp = end;
3840 goto theend;
3841 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003842 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 {
3844 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003845 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003846 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847 if (name == *pp)
3848 name = NULL;
3849 }
3850 if (name != NULL)
3851 {
3852 name = vim_strsave(name);
3853 *pp = end;
3854 if (STRNCMP(name, "<SNR>", 5) == 0)
3855 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003856 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857 name[0] = K_SPECIAL;
3858 name[1] = KS_EXTRA;
3859 name[2] = (int)KE_SNR;
3860 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3861 }
3862 goto theend;
3863 }
3864
3865 if (lv.ll_exp_name != NULL)
3866 {
3867 len = (int)STRLEN(lv.ll_exp_name);
3868 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3869 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3870 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003871 // When there was "s:" already or the name expanded to get a
3872 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 lv.ll_name += 2;
3874 len -= 2;
3875 lead = 2;
3876 }
3877 }
3878 else
3879 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003880 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003882 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003883 if (lv.ll_name[0] == 'g')
3884 {
3885 if (is_global != NULL)
3886 {
3887 *is_global = TRUE;
3888 }
3889 else
3890 {
3891 // dropping "g:" without setting "is_global" won't work in
3892 // Vim9script, put it back later
3893 prefix_g = TRUE;
3894 extra = 2;
3895 }
3896 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003898 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899 len = (int)(end - lv.ll_name);
3900 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003901 if (len <= 0)
3902 {
3903 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003904 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003905 goto theend;
3906 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003908 // In Vim9 script a user function is script-local by default, unless it
3909 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003910 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003911
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003912 /*
3913 * Copy the function name to allocated memory.
3914 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3915 * Accept <SNR>123_name() outside a script.
3916 */
3917 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003918 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003919 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003921 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003922 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003923 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
Bram Moolenaar3787f262022-02-07 21:54:01 +00003924 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003925 semsg(_(vim9script
Bram Moolenaar3787f262022-02-07 21:54:01 +00003926 ? e_function_name_must_start_with_capital_str
3927 : e_function_name_must_start_with_capital_or_s_str),
3928 start);
3929 goto theend;
3930 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003931 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00003932 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00003933 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003934 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 || eval_fname_sid(*pp))
3936 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003937 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003938 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003940 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 goto theend;
3942 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003943 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003944 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003945 extra = 3 + (int)STRLEN(sid_buf);
3946 else
3947 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 }
3949 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02003950 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00003951 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003953 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00003954 : e_function_name_must_start_with_capital_or_s_str),
3955 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003956 goto theend;
3957 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003958 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003959 {
3960 char_u *cp = vim_strchr(lv.ll_name, ':');
3961
3962 if (cp != NULL && cp < end)
3963 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003964 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 goto theend;
3966 }
3967 }
3968
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003969 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970 if (name != NULL)
3971 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003972 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973 {
3974 name[0] = K_SPECIAL;
3975 name[1] = KS_EXTRA;
3976 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003977 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 STRCPY(name + 3, sid_buf);
3979 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003980 else if (prefix_g)
3981 {
3982 name[0] = 'g';
3983 name[1] = ':';
3984 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003985 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3986 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003987 }
3988 *pp = end;
3989
3990theend:
3991 clear_lval(&lv);
3992 return name;
3993}
3994
3995/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003996 * Assuming "name" is the result of trans_function_name() and it was prefixed
3997 * to use the script-local name, return the unmodified name (points into
3998 * "name"). Otherwise return NULL.
3999 * This can be used to first search for a script-local function and fall back
4000 * to the global function if not found.
4001 */
4002 char_u *
4003untrans_function_name(char_u *name)
4004{
4005 char_u *p;
4006
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004007 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004008 {
4009 p = vim_strchr(name, '_');
4010 if (p != NULL)
4011 return p + 1;
4012 }
4013 return NULL;
4014}
4015
4016/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004017 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4018 * current script ID and returns the expanded function name. The caller should
4019 * free the returned name. If not called from a script context or the function
4020 * name doesn't start with these prefixes, then returns NULL.
4021 * This doesn't check whether the script-local function exists or not.
4022 */
4023 char_u *
4024get_scriptlocal_funcname(char_u *funcname)
4025{
4026 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004027 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004028 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004029 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004030
4031 if (funcname == NULL)
4032 return NULL;
4033
4034 if (STRNCMP(funcname, "s:", 2) != 0
4035 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004036 {
4037 ufunc_T *ufunc;
4038
4039 // The function name does not have a script-local prefix. Try finding
4040 // it when in a Vim9 script and there is no "g:" prefix.
4041 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4042 return NULL;
4043 ufunc = find_func(funcname, FALSE);
4044 if (ufunc == NULL || func_is_global(ufunc)
4045 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4046 return NULL;
4047 ++p;
4048 off = 0;
4049 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004050 else
4051 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004052
4053 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4054 {
4055 emsg(_(e_using_sid_not_in_script_context));
4056 return NULL;
4057 }
4058 // Expand s: prefix into <SNR>nr_<name>
4059 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4060 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004061 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004062 if (newname == NULL)
4063 return NULL;
4064 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004065 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004066
4067 return newname;
4068}
4069
4070/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004071 * Call trans_function_name(), except that a lambda is returned as-is.
4072 * Returns the name in allocated memory.
4073 */
4074 char_u *
4075save_function_name(
4076 char_u **name,
4077 int *is_global,
4078 int skip,
4079 int flags,
4080 funcdict_T *fudi)
4081{
4082 char_u *p = *name;
4083 char_u *saved;
4084
4085 if (STRNCMP(p, "<lambda>", 8) == 0)
4086 {
4087 p += 8;
4088 (void)getdigits(&p);
4089 saved = vim_strnsave(*name, p - *name);
4090 if (fudi != NULL)
4091 CLEAR_POINTER(fudi);
4092 }
4093 else
4094 saved = trans_function_name(&p, is_global, skip,
4095 flags, fudi, NULL, NULL);
4096 *name = p;
4097 return saved;
4098}
4099
4100/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004101 * List functions. When "regmatch" is NULL all of then.
4102 * Otherwise functions matching "regmatch".
4103 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004104 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004105list_functions(regmatch_T *regmatch)
4106{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004107 int changed = func_hashtab.ht_changed;
4108 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004109 hashitem_T *hi;
4110
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004111 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004112 {
4113 if (!HASHITEM_EMPTY(hi))
4114 {
4115 ufunc_T *fp = HI2UF(hi);
4116
4117 --todo;
4118 if ((fp->uf_flags & FC_DEAD) == 0
4119 && (regmatch == NULL
4120 ? !message_filtered(fp->uf_name)
4121 && !func_name_refcount(fp->uf_name)
4122 : !isdigit(*fp->uf_name)
4123 && vim_regexec(regmatch, fp->uf_name, 0)))
4124 {
4125 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004126 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004127 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004128 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004129 return;
4130 }
4131 }
4132 }
4133 }
4134}
4135
4136/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004137 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004138 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4139 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004140 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004141 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004142 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004143 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004144define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004146 int j;
4147 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004148 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004149 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004150 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151 char_u *p;
4152 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004153 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 char_u *line_arg = NULL;
4155 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004156 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004157 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 garray_T newlines;
4159 int varargs = FALSE;
4160 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004161 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004162 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004163 int fp_allocated = FALSE;
4164 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004165 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004166 dictitem_T *v;
4167 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004168 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004170 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004171 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004172 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004173 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004174
4175 /*
4176 * ":function" without argument: list functions.
4177 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004178 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 {
4180 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004181 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004182 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004183 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184 }
4185
4186 /*
4187 * ":function /pat": list functions matching pattern.
4188 */
4189 if (*eap->arg == '/')
4190 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004191 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 if (!eap->skip)
4193 {
4194 regmatch_T regmatch;
4195
4196 c = *p;
4197 *p = NUL;
4198 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4199 *p = c;
4200 if (regmatch.regprog != NULL)
4201 {
4202 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004203 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 vim_regfree(regmatch.regprog);
4205 }
4206 }
4207 if (*p == '/')
4208 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004209 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004210 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004211 }
4212
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004213 ga_init(&newargs);
4214 ga_init(&argtypes);
4215 ga_init(&default_args);
4216
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217 /*
4218 * Get the function name. There are these situations:
4219 * func normal function name
4220 * "name" == func, "fudi.fd_dict" == NULL
4221 * dict.func new dictionary entry
4222 * "name" == NULL, "fudi.fd_dict" set,
4223 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4224 * dict.func existing dict entry with a Funcref
4225 * "name" == func, "fudi.fd_dict" set,
4226 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4227 * dict.func existing dict entry that's not a Funcref
4228 * "name" == NULL, "fudi.fd_dict" set,
4229 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4230 * s:func script-local function name
4231 * g:func global function name, same as "func"
4232 */
4233 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004234 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004236 // nested function, argument is (args).
4237 paren = TRUE;
4238 CLEAR_FIELD(fudi);
4239 }
4240 else
4241 {
Bram Moolenaara749a422022-02-12 19:52:25 +00004242 if (vim9script && p[0] == 's' && p[1] == ':')
4243 {
4244 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4245 return NULL;
4246 }
4247
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004248 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004249 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004250 paren = (vim_strchr(p, '(') != NULL);
4251 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004253 /*
4254 * Return on an invalid expression in braces, unless the expression
4255 * evaluation has been cancelled due to an aborting error, an
4256 * interrupt, or an exception.
4257 */
4258 if (!aborting())
4259 {
4260 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004261 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004262 vim_free(fudi.fd_newkey);
4263 return NULL;
4264 }
4265 else
4266 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004268
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004269 // For "export def FuncName()" in an autoload script the function name
4270 // is stored with the legacy autoload name "dir#script#FuncName" so
4271 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004272 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004273 {
4274 char_u *prefixed = may_prefix_autoload(name);
4275
4276 if (prefixed != NULL && prefixed != name)
4277 {
4278 vim_free(name);
4279 name = prefixed;
4280 }
4281 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004282 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004283 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004284 {
4285 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4286 goto ret_free;
4287 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288 }
4289
Bram Moolenaare38eab22019-12-05 21:50:01 +01004290 // An error in a function call during evaluation of an expression in magic
4291 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 saved_did_emsg = did_emsg;
4293 did_emsg = FALSE;
4294
4295 /*
4296 * ":function func" with only function name: list function.
4297 */
4298 if (!paren)
4299 {
4300 if (!ends_excmd(*skipwhite(p)))
4301 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004302 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 goto ret_free;
4304 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004305 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306 if (eap->nextcmd != NULL)
4307 *p = NUL;
4308 if (!eap->skip && !got_int)
4309 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004310 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004311 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4312 {
4313 char_u *up = untrans_function_name(name);
4314
4315 // With Vim9 script the name was made script-local, if not
4316 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004317 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004318 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004319 }
4320
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 if (fp != NULL)
4322 {
4323 list_func_head(fp, TRUE);
4324 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4325 {
4326 if (FUNCLINE(fp, j) == NULL)
4327 continue;
4328 msg_putchar('\n');
4329 msg_outnum((long)(j + 1));
4330 if (j < 9)
4331 msg_putchar(' ');
4332 if (j < 99)
4333 msg_putchar(' ');
4334 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004335 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004336 ui_breakcheck();
4337 }
4338 if (!got_int)
4339 {
4340 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004341 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004342 msg_puts(" enddef");
4343 else
4344 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 }
4346 }
4347 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004348 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 }
4350 goto ret_free;
4351 }
4352
4353 /*
4354 * ":function name(arg1, arg2)" Define function.
4355 */
4356 p = skipwhite(p);
4357 if (*p != '(')
4358 {
4359 if (!eap->skip)
4360 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004361 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004362 goto ret_free;
4363 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004364 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004365 if (vim_strchr(p, '(') != NULL)
4366 p = vim_strchr(p, '(');
4367 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004369 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4370 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004371 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004372 goto ret_free;
4373 }
4374
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004375 // In Vim9 script only global functions can be redefined.
4376 if (vim9script && eap->forceit && !is_global)
4377 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004378 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004379 goto ret_free;
4380 }
4381
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004382 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383
Bram Moolenaar04b12692020-05-04 23:24:44 +02004384 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004385 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004386 // Check the name of the function. Unless it's a dictionary function
4387 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004388 if (name != NULL)
4389 arg = name;
4390 else
4391 arg = fudi.fd_newkey;
4392 if (arg != NULL && (fudi.fd_di == NULL
4393 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4394 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4395 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004396 char_u *name_base = arg;
4397 int i;
4398
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004400 {
4401 name_base = vim_strchr(arg, '_');
4402 if (name_base == NULL)
4403 name_base = arg + 3;
4404 else
4405 ++name_base;
4406 }
4407 for (i = 0; name_base[i] != NUL && (i == 0
4408 ? eval_isnamec1(name_base[i])
4409 : eval_isnamec(name_base[i])); ++i)
4410 ;
4411 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004412 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004413
4414 // In Vim9 script a function cannot have the same name as a
4415 // variable.
4416 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004417 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4418 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004419 + EVAL_VAR_NO_FUNC) == OK)
4420 {
4421 semsg(_(e_redefining_script_item_str), name_base);
4422 goto ret_free;
4423 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004425 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004427 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004428 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004429 goto ret_free;
4430 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 }
4432
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004433 // This may get more lines and make the pointers into the first line
4434 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004435 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004436 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004437 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004438 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004439 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004441 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004442
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004443 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004444 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004445 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004446 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004448 if (*p != ':')
4449 {
4450 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4451 p = skipwhite(p);
4452 }
4453 else if (!IS_WHITE_OR_NUL(p[1]))
4454 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004455 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004456 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004457 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004458 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004459 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004460 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004461 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004462 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004463 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004464 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004465 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004466 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004467 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004469 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004471 else
4472 // find extra arguments "range", "dict", "abort" and "closure"
4473 for (;;)
4474 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004475 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004476 p = skipwhite(p);
4477 if (STRNCMP(p, "range", 5) == 0)
4478 {
4479 flags |= FC_RANGE;
4480 p += 5;
4481 }
4482 else if (STRNCMP(p, "dict", 4) == 0)
4483 {
4484 flags |= FC_DICT;
4485 p += 4;
4486 }
4487 else if (STRNCMP(p, "abort", 5) == 0)
4488 {
4489 flags |= FC_ABORT;
4490 p += 5;
4491 }
4492 else if (STRNCMP(p, "closure", 7) == 0)
4493 {
4494 flags |= FC_CLOSURE;
4495 p += 7;
4496 if (current_funccal == NULL)
4497 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004498 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004499 name == NULL ? (char_u *)"" : name);
4500 goto erret;
4501 }
4502 }
4503 else
4504 break;
4505 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506
Bram Moolenaare38eab22019-12-05 21:50:01 +01004507 // When there is a line break use what follows for the function body.
4508 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 if (*p == '\n')
4510 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004511 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004512 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4513 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004514 && !(VIM_ISWHITE(*whitep) && *p == '#'
4515 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004516 && !eap->skip
4517 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004518 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519
4520 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004521 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4522 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 */
4524 if (KeyTyped)
4525 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004526 // Check if the function already exists, don't let the user type the
4527 // whole function before telling him it doesn't work! For a script we
4528 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004529 if (!eap->skip && !eap->forceit)
4530 {
4531 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004532 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004533 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004534 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 }
4536
4537 if (!eap->skip && did_emsg)
4538 goto erret;
4539
Bram Moolenaare38eab22019-12-05 21:50:01 +01004540 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 cmdline_row = msg_row;
4542 }
4543
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004544 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004545 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004546
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004547 // Do not define the function when getting the body fails and when
4548 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004549 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004550 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004551 goto erret;
4552
4553 /*
4554 * If there are no errors, add the function
4555 */
4556 if (fudi.fd_dict == NULL)
4557 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004558 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004559 char_u *find_name = name;
4560 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004561 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004562
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004563 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004564 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004565 var_conflict = TRUE;
4566
4567 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4568 {
4569 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4570
4571 if (si->sn_autoload_prefix != NULL)
4572 {
4573 if (is_export)
4574 {
4575 find_name = name + STRLEN(si->sn_autoload_prefix);
4576 v = find_var(find_name, &ht, TRUE);
4577 if (v != NULL)
4578 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004579 // Only check if the function already exists in the script,
4580 // global functions can be shadowed.
4581 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004582 }
4583 else
4584 {
4585 char_u *prefixed = may_prefix_autoload(name);
4586
4587 if (prefixed != NULL)
4588 {
4589 v = find_var(prefixed, &ht, TRUE);
4590 if (v != NULL)
4591 var_conflict = TRUE;
4592 vim_free(prefixed);
4593 }
4594 }
4595 }
4596 }
4597 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004599 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 goto erret;
4601 }
4602
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004603 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004604 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004605 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004606 char_u *uname = untrans_function_name(name);
4607
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004608 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004609 }
4610
4611 if (fp != NULL || import != NULL)
4612 {
4613 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004614
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004615 // Function can be replaced with "function!" and when sourcing the
4616 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004617 // A name that is used by an import can not be overruled.
4618 if (import != NULL
4619 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004620 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004621 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004623 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004624 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004625 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004626 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004627 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004628 goto erret;
4629 }
4630 if (fp->uf_calls > 0)
4631 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004632 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004633 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634 goto erret;
4635 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004636 if (fp->uf_refcount > 1)
4637 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004638 // This function is referenced somewhere, don't redefine it but
4639 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004640 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004641 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004642 fp = NULL;
4643 overwrite = TRUE;
4644 }
4645 else
4646 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004647 char_u *exp_name = fp->uf_name_exp;
4648
4649 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004650 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004651 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004652 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004653 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004654 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004655#ifdef FEAT_PROFILE
4656 fp->uf_profiling = FALSE;
4657 fp->uf_prof_initialized = FALSE;
4658#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004659 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004660 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661 }
4662 }
4663 else
4664 {
4665 char numbuf[20];
4666
4667 fp = NULL;
4668 if (fudi.fd_newkey == NULL && !eap->forceit)
4669 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004670 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671 goto erret;
4672 }
4673 if (fudi.fd_di == NULL)
4674 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004675 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004676 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004677 goto erret;
4678 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004679 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004680 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 goto erret;
4682
Bram Moolenaare38eab22019-12-05 21:50:01 +01004683 // Give the function a sequential number. Can only be used with a
4684 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004685 vim_free(name);
4686 sprintf(numbuf, "%d", ++func_nr);
4687 name = vim_strsave((char_u *)numbuf);
4688 if (name == NULL)
4689 goto erret;
4690 }
4691
4692 if (fp == NULL)
4693 {
4694 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4695 {
4696 int slen, plen;
4697 char_u *scriptname;
4698
Bram Moolenaare38eab22019-12-05 21:50:01 +01004699 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004700 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004701 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 {
4703 scriptname = autoload_name(name);
4704 if (scriptname != NULL)
4705 {
4706 p = vim_strchr(scriptname, '/');
4707 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004708 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004710 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 j = OK;
4712 vim_free(scriptname);
4713 }
4714 }
4715 if (j == FAIL)
4716 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004717 linenr_T save_lnum = SOURCING_LNUM;
4718
4719 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004720 semsg(_(e_function_name_does_not_match_script_file_name_str),
4721 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004722 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 goto erret;
4724 }
4725 }
4726
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004727 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004728 if (fp == NULL)
4729 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004730 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731
4732 if (fudi.fd_dict != NULL)
4733 {
4734 if (fudi.fd_di == NULL)
4735 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004736 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004737 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4738 if (fudi.fd_di == NULL)
4739 {
4740 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004741 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004742 goto erret;
4743 }
4744 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4745 {
4746 vim_free(fudi.fd_di);
4747 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004748 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749 goto erret;
4750 }
4751 }
4752 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004753 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 clear_tv(&fudi.fd_di->di_tv);
4755 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757
Bram Moolenaare38eab22019-12-05 21:50:01 +01004758 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004759 flags |= FC_DICT;
4760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761 }
4762 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004763 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004764 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004765 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004766
4767 if (eap->cmdidx == CMD_def)
4768 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004769 int lnum_save = SOURCING_LNUM;
4770 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004771
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004772 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004773
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004774 // error messages are for the first function line
4775 SOURCING_LNUM = sourcing_lnum_top;
4776
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004777 // The function may use script variables from the context.
4778 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004779
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004780 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004781 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004782 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004783 free_fp = fp_allocated;
4784 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004785 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004786 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004787
4788 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004789 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004790 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004791 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004792 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004793 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004794 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004795 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004796 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004797 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004798 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004799
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004800 if (fp_allocated)
4801 {
4802 // insert the new function in the function list
4803 set_ufunc_name(fp, name);
4804 if (overwrite)
4805 {
4806 hi = hash_find(&func_hashtab, name);
4807 hi->hi_key = UF2HIKEY(fp);
4808 }
4809 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4810 {
4811 free_fp = TRUE;
4812 goto erret;
4813 }
4814 fp->uf_refcount = 1;
4815 }
4816
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004817 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004818 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004819 if ((flags & FC_CLOSURE) != 0)
4820 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004821 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004822 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004823 }
4824 else
4825 fp->uf_scoped = NULL;
4826
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004828 if (prof_def_func())
4829 func_do_profile(fp);
4830#endif
4831 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004832 if (sandbox)
4833 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004834 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004835 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836 fp->uf_flags = flags;
4837 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004838 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004839 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004840 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004841 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004842 if (is_export)
4843 {
4844 fp->uf_flags |= FC_EXPORT;
4845 // let ex_export() know the export worked.
4846 is_export = FALSE;
4847 }
4848
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004849 if (eap->cmdidx == CMD_def)
4850 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004851 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4852 // :func does not use Vim9 script syntax, even in a Vim9 script file
4853 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004854
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855 goto ret_free;
4856
4857erret:
4858 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004859 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004860 if (fp != NULL)
4861 {
4862 ga_init(&fp->uf_args);
4863 ga_init(&fp->uf_def_args);
4864 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004865errret_2:
4866 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004867 if (fp != NULL)
4868 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004869 if (free_fp)
4870 {
4871 vim_free(fp);
4872 fp = NULL;
4873 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004875 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004876 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004877 if (name != name_arg)
4878 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004879 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004881
4882 return fp;
4883}
4884
4885/*
4886 * ":function"
4887 */
4888 void
4889ex_function(exarg_T *eap)
4890{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004891 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004892
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004893 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4894 (void)define_function(eap, NULL, &lines_to_free);
4895 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004896}
4897
4898/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004899 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004900 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004901 */
4902 void
4903ex_defcompile(exarg_T *eap UNUSED)
4904{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004905 long todo = (long)func_hashtab.ht_used;
4906 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004907 hashitem_T *hi;
4908 ufunc_T *ufunc;
4909
4910 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4911 {
4912 if (!HASHITEM_EMPTY(hi))
4913 {
4914 --todo;
4915 ufunc = HI2UF(hi);
4916 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004917 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4918 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004919 {
Bram Moolenaare99d4222021-06-13 14:01:26 +02004920 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004921
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004922 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004923 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004924 // a function has been added or removed, need to start over
4925 todo = (long)func_hashtab.ht_used;
4926 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004927 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004928 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004929 }
4930 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004931 }
4932 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004933}
4934
4935/*
4936 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4937 * Return 2 if "p" starts with "s:".
4938 * Return 0 otherwise.
4939 */
4940 int
4941eval_fname_script(char_u *p)
4942{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004943 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4944 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4946 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4947 return 5;
4948 if (p[0] == 's' && p[1] == ':')
4949 return 2;
4950 return 0;
4951}
4952
4953 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004954translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955{
4956 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004957 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004958 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004959}
4960
4961/*
4962 * Return TRUE when "ufunc" has old-style "..." varargs
4963 * or named varargs "...name: type".
4964 */
4965 int
4966has_varargs(ufunc_T *ufunc)
4967{
4968 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969}
4970
4971/*
4972 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004973 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974 */
4975 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004976function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004977{
4978 char_u *nm = name;
4979 char_u *p;
4980 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004981 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004982 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004983
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004984 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4985 if (no_deref)
4986 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004987 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988 nm = skipwhite(nm);
4989
Bram Moolenaare38eab22019-12-05 21:50:01 +01004990 // Only accept "funcname", "funcname ", "funcname (..." and
4991 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004992 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004993 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004994 vim_free(p);
4995 return n;
4996}
4997
Bram Moolenaar113e1072019-01-20 15:30:40 +01004998#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004999 char_u *
5000get_expanded_name(char_u *name, int check)
5001{
5002 char_u *nm = name;
5003 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005004 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005006 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005007 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005008
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005009 if (p != NULL && *nm == NUL
5010 && (!check || translated_function_exists(p, is_global)))
5011 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005012
5013 vim_free(p);
5014 return NULL;
5015}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005016#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005018/*
5019 * Function given to ExpandGeneric() to obtain the list of user defined
5020 * function names.
5021 */
5022 char_u *
5023get_user_func_name(expand_T *xp, int idx)
5024{
5025 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005026 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005027 static hashitem_T *hi;
5028 ufunc_T *fp;
5029
5030 if (idx == 0)
5031 {
5032 done = 0;
5033 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005034 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005035 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005036 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037 {
5038 if (done++ > 0)
5039 ++hi;
5040 while (HASHITEM_EMPTY(hi))
5041 ++hi;
5042 fp = HI2UF(hi);
5043
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005044 // don't show dead, dict and lambda functions
5045 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005046 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005047 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005048
5049 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005050 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005051
5052 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005053 if (xp->xp_context != EXPAND_USER_FUNC
5054 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005055 {
5056 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005057 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005058 STRCAT(IObuff, ")");
5059 }
5060 return IObuff;
5061 }
5062 return NULL;
5063}
5064
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065/*
5066 * ":delfunction {name}"
5067 */
5068 void
5069ex_delfunction(exarg_T *eap)
5070{
5071 ufunc_T *fp = NULL;
5072 char_u *p;
5073 char_u *name;
5074 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005075 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005076
5077 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005078 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5079 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080 vim_free(fudi.fd_newkey);
5081 if (name == NULL)
5082 {
5083 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005084 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085 return;
5086 }
5087 if (!ends_excmd(*skipwhite(p)))
5088 {
5089 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005090 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005091 return;
5092 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005093 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005094 if (eap->nextcmd != NULL)
5095 *p = NUL;
5096
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005097 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005098 {
5099 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005100 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005101 vim_free(name);
5102 return;
5103 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005104 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005105 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106 vim_free(name);
5107
5108 if (!eap->skip)
5109 {
5110 if (fp == NULL)
5111 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005112 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005113 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005114 return;
5115 }
5116 if (fp->uf_calls > 0)
5117 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005118 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005119 return;
5120 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005121 if (fp->uf_flags & FC_VIM9)
5122 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005123 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005124 return;
5125 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126
5127 if (fudi.fd_dict != NULL)
5128 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005129 // Delete the dict item that refers to the function, it will
5130 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005131 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5132 }
5133 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005134 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005135 // A normal function (not a numbered function or lambda) has a
5136 // refcount of 1 for the entry in the hashtable. When deleting
5137 // it and the refcount is more than one, it should be kept.
5138 // A numbered function and lambda should be kept if the refcount is
5139 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005140 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005141 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005142 // Function is still referenced somewhere. Don't free it but
5143 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005144 if (func_remove(fp))
5145 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005146 }
5147 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005148 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005149 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150 }
5151}
5152
5153/*
5154 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005155 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156 */
5157 void
5158func_unref(char_u *name)
5159{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005160 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005161
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005162 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005163 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005164 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005165 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005166 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005167#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005168 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005170 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005172 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005173}
5174
5175/*
5176 * Unreference a Function: decrement the reference count and free it when it
5177 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005178 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005179 */
5180 void
5181func_ptr_unref(ufunc_T *fp)
5182{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005183 if (fp != NULL && (--fp->uf_refcount <= 0
5184 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5185 && fp->uf_partial->pt_refcount <= 1
5186 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005187 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005188 // Only delete it when it's not being used. Otherwise it's done
5189 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005190 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005191 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192 }
5193}
5194
5195/*
5196 * Count a reference to a Function.
5197 */
5198 void
5199func_ref(char_u *name)
5200{
5201 ufunc_T *fp;
5202
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005203 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005204 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005205 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005206 if (fp != NULL)
5207 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005208 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005209 // Only give an error for a numbered function.
5210 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005211 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005212}
5213
5214/*
5215 * Count a reference to a Function.
5216 */
5217 void
5218func_ptr_ref(ufunc_T *fp)
5219{
5220 if (fp != NULL)
5221 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005222}
5223
5224/*
5225 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5226 * referenced from anywhere that is in use.
5227 */
5228 static int
5229can_free_funccal(funccall_T *fc, int copyID)
5230{
5231 return (fc->l_varlist.lv_copyID != copyID
5232 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005233 && fc->l_avars.dv_copyID != copyID
5234 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005235}
5236
5237/*
5238 * ":return [expr]"
5239 */
5240 void
5241ex_return(exarg_T *eap)
5242{
5243 char_u *arg = eap->arg;
5244 typval_T rettv;
5245 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005246 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247
5248 if (current_funccal == NULL)
5249 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005250 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005251 return;
5252 }
5253
Bram Moolenaar844fb642021-10-23 13:32:30 +01005254 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005255 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5256
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257 if (eap->skip)
5258 ++emsg_skip;
5259
5260 eap->nextcmd = NULL;
5261 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005262 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005263 {
5264 if (!eap->skip)
5265 returning = do_return(eap, FALSE, TRUE, &rettv);
5266 else
5267 clear_tv(&rettv);
5268 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005269 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005270 else if (!eap->skip)
5271 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005272 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005273 update_force_abort();
5274
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005275 /*
5276 * Return unless the expression evaluation has been cancelled due to an
5277 * aborting error, an interrupt, or an exception.
5278 */
5279 if (!aborting())
5280 returning = do_return(eap, FALSE, TRUE, NULL);
5281 }
5282
Bram Moolenaare38eab22019-12-05 21:50:01 +01005283 // When skipping or the return gets pending, advance to the next command
5284 // in this line (!returning). Otherwise, ignore the rest of the line.
5285 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005286 if (returning)
5287 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005288 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005289 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005290
5291 if (eap->skip)
5292 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005293 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005294}
5295
5296/*
5297 * ":1,25call func(arg1, arg2)" function call.
5298 */
5299 void
5300ex_call(exarg_T *eap)
5301{
5302 char_u *arg = eap->arg;
5303 char_u *startarg;
5304 char_u *name;
5305 char_u *tofree;
5306 int len;
5307 typval_T rettv;
5308 linenr_T lnum;
5309 int doesrange;
5310 int failed = FALSE;
5311 funcdict_T fudi;
5312 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005313 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005314 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005315 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005316 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005317
Bram Moolenaare6b53242020-07-01 17:28:33 +02005318 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005319 if (eap->skip)
5320 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005321 // trans_function_name() doesn't work well when skipping, use eval0()
5322 // instead to skip to any following command, e.g. for:
5323 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005324 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005325 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005326 clear_tv(&rettv);
5327 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005328 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329 return;
5330 }
5331
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005332 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005333 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005334 if (fudi.fd_newkey != NULL)
5335 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005336 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005337 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005338 vim_free(fudi.fd_newkey);
5339 }
5340 if (tofree == NULL)
5341 return;
5342
Bram Moolenaare38eab22019-12-05 21:50:01 +01005343 // Increase refcount on dictionary, it could get deleted when evaluating
5344 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005345 if (fudi.fd_dict != NULL)
5346 ++fudi.fd_dict->dv_refcount;
5347
Bram Moolenaare38eab22019-12-05 21:50:01 +01005348 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5349 // contents. For VAR_PARTIAL get its partial, unless we already have one
5350 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005352 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005353 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005354 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005355
Bram Moolenaare38eab22019-12-05 21:50:01 +01005356 // Skip white space to allow ":call func ()". Not good, but required for
5357 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005358 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359 if (*startarg != '(')
5360 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005361 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005362 goto end;
5363 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005364 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005365 {
5366 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5367 goto end;
5368 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005369
5370 /*
5371 * When skipping, evaluate the function once, to find the end of the
5372 * arguments.
5373 * When the function takes a range, this is discovered after the first
5374 * call, and the loop is broken.
5375 */
5376 if (eap->skip)
5377 {
5378 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005379 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005380 }
5381 else
5382 lnum = eap->line1;
5383 for ( ; lnum <= eap->line2; ++lnum)
5384 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005385 funcexe_T funcexe;
5386
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005387 if (!eap->skip && eap->addr_count > 0)
5388 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005389 if (lnum > curbuf->b_ml.ml_line_count)
5390 {
5391 // If the function deleted lines or switched to another buffer
5392 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005393 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005394 break;
5395 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005396 curwin->w_cursor.lnum = lnum;
5397 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005398 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399 }
5400 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005401
Bram Moolenaara80faa82020-04-12 19:37:17 +02005402 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005403 funcexe.fe_firstline = eap->line1;
5404 funcexe.fe_lastline = eap->line2;
5405 funcexe.fe_doesrange = &doesrange;
5406 funcexe.fe_evaluate = !eap->skip;
5407 funcexe.fe_partial = partial;
5408 funcexe.fe_selfdict = fudi.fd_dict;
5409 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005410 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005411 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005412 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005413 {
5414 failed = TRUE;
5415 break;
5416 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005417 if (has_watchexpr())
5418 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005419
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005420 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005421 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005422 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005423 {
5424 failed = TRUE;
5425 break;
5426 }
5427
5428 clear_tv(&rettv);
5429 if (doesrange || eap->skip)
5430 break;
5431
Bram Moolenaare38eab22019-12-05 21:50:01 +01005432 // Stop when immediately aborting on error, or when an interrupt
5433 // occurred or an exception was thrown but not caught.
5434 // get_func_tv() returned OK, so that the check for trailing
5435 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005436 if (aborting())
5437 break;
5438 }
5439 if (eap->skip)
5440 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005441 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442
Bram Moolenaar1d341892021-09-18 15:25:52 +02005443 // When inside :try we need to check for following "| catch" or "| endtry".
5444 // Not when there was an error, but do check if an exception was thrown.
5445 if ((!aborting() || did_throw)
5446 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005447 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005448 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005449 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005450 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005451 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005452 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005453 {
5454 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005455 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005456 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005457 }
5458 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005459 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005460 }
5461
5462end:
5463 dict_unref(fudi.fd_dict);
5464 vim_free(tofree);
5465}
5466
5467/*
5468 * Return from a function. Possibly makes the return pending. Also called
5469 * for a pending return at the ":endtry" or after returning from an extra
5470 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5471 * when called due to a ":return" command. "rettv" may point to a typval_T
5472 * with the return rettv. Returns TRUE when the return can be carried out,
5473 * FALSE when the return gets pending.
5474 */
5475 int
5476do_return(
5477 exarg_T *eap,
5478 int reanimate,
5479 int is_cmd,
5480 void *rettv)
5481{
5482 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005483 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005484
5485 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005486 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005487 current_funccal->returned = FALSE;
5488
5489 /*
5490 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5491 * not in its finally clause (which then is to be executed next) is found.
5492 * In this case, make the ":return" pending for execution at the ":endtry".
5493 * Otherwise, return normally.
5494 */
5495 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5496 if (idx >= 0)
5497 {
5498 cstack->cs_pending[idx] = CSTP_RETURN;
5499
5500 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005501 // A pending return again gets pending. "rettv" points to an
5502 // allocated variable with the rettv of the original ":return"'s
5503 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005504 cstack->cs_rettv[idx] = rettv;
5505 else
5506 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005507 // When undoing a return in order to make it pending, get the stored
5508 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005509 if (reanimate)
5510 rettv = current_funccal->rettv;
5511
5512 if (rettv != NULL)
5513 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005514 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5516 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5517 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005518 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519 }
5520 else
5521 cstack->cs_rettv[idx] = NULL;
5522
5523 if (reanimate)
5524 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005525 // The pending return value could be overwritten by a ":return"
5526 // without argument in a finally clause; reset the default
5527 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005528 current_funccal->rettv->v_type = VAR_NUMBER;
5529 current_funccal->rettv->vval.v_number = 0;
5530 }
5531 }
5532 report_make_pending(CSTP_RETURN, rettv);
5533 }
5534 else
5535 {
5536 current_funccal->returned = TRUE;
5537
Bram Moolenaare38eab22019-12-05 21:50:01 +01005538 // If the return is carried out now, store the return value. For
5539 // a return immediately after reanimation, the value is already
5540 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005541 if (!reanimate && rettv != NULL)
5542 {
5543 clear_tv(current_funccal->rettv);
5544 *current_funccal->rettv = *(typval_T *)rettv;
5545 if (!is_cmd)
5546 vim_free(rettv);
5547 }
5548 }
5549
5550 return idx < 0;
5551}
5552
5553/*
5554 * Free the variable with a pending return value.
5555 */
5556 void
5557discard_pending_return(void *rettv)
5558{
5559 free_tv((typval_T *)rettv);
5560}
5561
5562/*
5563 * Generate a return command for producing the value of "rettv". The result
5564 * is an allocated string. Used by report_pending() for verbose messages.
5565 */
5566 char_u *
5567get_return_cmd(void *rettv)
5568{
5569 char_u *s = NULL;
5570 char_u *tofree = NULL;
5571 char_u numbuf[NUMBUFLEN];
5572
5573 if (rettv != NULL)
5574 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5575 if (s == NULL)
5576 s = (char_u *)"";
5577
5578 STRCPY(IObuff, ":return ");
5579 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5580 if (STRLEN(s) + 8 >= IOSIZE)
5581 STRCPY(IObuff + IOSIZE - 4, "...");
5582 vim_free(tofree);
5583 return vim_strsave(IObuff);
5584}
5585
5586/*
5587 * Get next function line.
5588 * Called by do_cmdline() to get the next line.
5589 * Returns allocated string, or NULL for end of function.
5590 */
5591 char_u *
5592get_func_line(
5593 int c UNUSED,
5594 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005595 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005596 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005597{
5598 funccall_T *fcp = (funccall_T *)cookie;
5599 ufunc_T *fp = fcp->func;
5600 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005601 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005602
Bram Moolenaare38eab22019-12-05 21:50:01 +01005603 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005604 if (fcp->dbg_tick != debug_tick)
5605 {
5606 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005607 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005608 fcp->dbg_tick = debug_tick;
5609 }
5610#ifdef FEAT_PROFILE
5611 if (do_profiling == PROF_YES)
5612 func_line_end(cookie);
5613#endif
5614
5615 gap = &fp->uf_lines;
5616 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5617 || fcp->returned)
5618 retval = NULL;
5619 else
5620 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005621 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005622 while (fcp->linenr < gap->ga_len
5623 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5624 ++fcp->linenr;
5625 if (fcp->linenr >= gap->ga_len)
5626 retval = NULL;
5627 else
5628 {
5629 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005630 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005631#ifdef FEAT_PROFILE
5632 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005633 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005634#endif
5635 }
5636 }
5637
Bram Moolenaare38eab22019-12-05 21:50:01 +01005638 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005639 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005640 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005641 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005642 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005643 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005644 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005645 fcp->dbg_tick = debug_tick;
5646 }
5647
5648 return retval;
5649}
5650
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005651/*
5652 * Return TRUE if the currently active function should be ended, because a
5653 * return was encountered or an error occurred. Used inside a ":while".
5654 */
5655 int
5656func_has_ended(void *cookie)
5657{
5658 funccall_T *fcp = (funccall_T *)cookie;
5659
Bram Moolenaare38eab22019-12-05 21:50:01 +01005660 // Ignore the "abort" flag if the abortion behavior has been changed due to
5661 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005662 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5663 || fcp->returned);
5664}
5665
5666/*
5667 * return TRUE if cookie indicates a function which "abort"s on errors.
5668 */
5669 int
5670func_has_abort(
5671 void *cookie)
5672{
5673 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5674}
5675
5676
5677/*
5678 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5679 * Don't do this when "Func" is already a partial that was bound
5680 * explicitly (pt_auto is FALSE).
5681 * Changes "rettv" in-place.
5682 * Returns the updated "selfdict_in".
5683 */
5684 dict_T *
5685make_partial(dict_T *selfdict_in, typval_T *rettv)
5686{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005687 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005688 char_u *tofree = NULL;
5689 ufunc_T *fp;
5690 char_u fname_buf[FLEN_FIXED + 1];
5691 int error;
5692 dict_T *selfdict = selfdict_in;
5693
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005694 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5695 fp = rettv->vval.v_partial->pt_func;
5696 else
5697 {
5698 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5699 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005700 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005701 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005702 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005703 vim_free(tofree);
5704 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005705
5706 if (fp != NULL && (fp->uf_flags & FC_DICT))
5707 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005708 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005709
5710 if (pt != NULL)
5711 {
5712 pt->pt_refcount = 1;
5713 pt->pt_dict = selfdict;
5714 pt->pt_auto = TRUE;
5715 selfdict = NULL;
5716 if (rettv->v_type == VAR_FUNC)
5717 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005718 // Just a function: Take over the function name and use
5719 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005720 pt->pt_name = rettv->vval.v_string;
5721 }
5722 else
5723 {
5724 partial_T *ret_pt = rettv->vval.v_partial;
5725 int i;
5726
Bram Moolenaare38eab22019-12-05 21:50:01 +01005727 // Partial: copy the function name, use selfdict and copy
5728 // args. Can't take over name or args, the partial might
5729 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005730 if (ret_pt->pt_name != NULL)
5731 {
5732 pt->pt_name = vim_strsave(ret_pt->pt_name);
5733 func_ref(pt->pt_name);
5734 }
5735 else
5736 {
5737 pt->pt_func = ret_pt->pt_func;
5738 func_ptr_ref(pt->pt_func);
5739 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005740 if (ret_pt->pt_argc > 0)
5741 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005742 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005743 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005744 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005745 pt->pt_argc = 0;
5746 else
5747 {
5748 pt->pt_argc = ret_pt->pt_argc;
5749 for (i = 0; i < pt->pt_argc; i++)
5750 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5751 }
5752 }
5753 partial_unref(ret_pt);
5754 }
5755 rettv->v_type = VAR_PARTIAL;
5756 rettv->vval.v_partial = pt;
5757 }
5758 }
5759 return selfdict;
5760}
5761
5762/*
5763 * Return the name of the executed function.
5764 */
5765 char_u *
5766func_name(void *cookie)
5767{
5768 return ((funccall_T *)cookie)->func->uf_name;
5769}
5770
5771/*
5772 * Return the address holding the next breakpoint line for a funccall cookie.
5773 */
5774 linenr_T *
5775func_breakpoint(void *cookie)
5776{
5777 return &((funccall_T *)cookie)->breakpoint;
5778}
5779
5780/*
5781 * Return the address holding the debug tick for a funccall cookie.
5782 */
5783 int *
5784func_dbg_tick(void *cookie)
5785{
5786 return &((funccall_T *)cookie)->dbg_tick;
5787}
5788
5789/*
5790 * Return the nesting level for a funccall cookie.
5791 */
5792 int
5793func_level(void *cookie)
5794{
5795 return ((funccall_T *)cookie)->level;
5796}
5797
5798/*
5799 * Return TRUE when a function was ended by a ":return" command.
5800 */
5801 int
5802current_func_returned(void)
5803{
5804 return current_funccal->returned;
5805}
5806
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005807 int
5808free_unref_funccal(int copyID, int testing)
5809{
5810 int did_free = FALSE;
5811 int did_free_funccal = FALSE;
5812 funccall_T *fc, **pfc;
5813
5814 for (pfc = &previous_funccal; *pfc != NULL; )
5815 {
5816 if (can_free_funccal(*pfc, copyID))
5817 {
5818 fc = *pfc;
5819 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005820 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005821 did_free = TRUE;
5822 did_free_funccal = TRUE;
5823 }
5824 else
5825 pfc = &(*pfc)->caller;
5826 }
5827 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005828 // When a funccal was freed some more items might be garbage
5829 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005830 (void)garbage_collect(testing);
5831
5832 return did_free;
5833}
5834
5835/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005836 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005837 */
5838 static funccall_T *
5839get_funccal(void)
5840{
5841 int i;
5842 funccall_T *funccal;
5843 funccall_T *temp_funccal;
5844
5845 funccal = current_funccal;
5846 if (debug_backtrace_level > 0)
5847 {
5848 for (i = 0; i < debug_backtrace_level; i++)
5849 {
5850 temp_funccal = funccal->caller;
5851 if (temp_funccal)
5852 funccal = temp_funccal;
5853 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005854 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005855 debug_backtrace_level = i;
5856 }
5857 }
5858 return funccal;
5859}
5860
5861/*
5862 * Return the hashtable used for local variables in the current funccal.
5863 * Return NULL if there is no current funccal.
5864 */
5865 hashtab_T *
5866get_funccal_local_ht()
5867{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005868 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005869 return NULL;
5870 return &get_funccal()->l_vars.dv_hashtab;
5871}
5872
5873/*
5874 * Return the l: scope variable.
5875 * Return NULL if there is no current funccal.
5876 */
5877 dictitem_T *
5878get_funccal_local_var()
5879{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005880 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005881 return NULL;
5882 return &get_funccal()->l_vars_var;
5883}
5884
5885/*
5886 * Return the hashtable used for argument in the current funccal.
5887 * Return NULL if there is no current funccal.
5888 */
5889 hashtab_T *
5890get_funccal_args_ht()
5891{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005892 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005893 return NULL;
5894 return &get_funccal()->l_avars.dv_hashtab;
5895}
5896
5897/*
5898 * Return the a: scope variable.
5899 * Return NULL if there is no current funccal.
5900 */
5901 dictitem_T *
5902get_funccal_args_var()
5903{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005904 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005905 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005906 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005907}
5908
5909/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005910 * List function variables, if there is a function.
5911 */
5912 void
5913list_func_vars(int *first)
5914{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005915 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005916 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005917 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005918}
5919
5920/*
5921 * If "ht" is the hashtable for local variables in the current funccal, return
5922 * the dict that contains it.
5923 * Otherwise return NULL.
5924 */
5925 dict_T *
5926get_current_funccal_dict(hashtab_T *ht)
5927{
5928 if (current_funccal != NULL
5929 && ht == &current_funccal->l_vars.dv_hashtab)
5930 return &current_funccal->l_vars;
5931 return NULL;
5932}
5933
5934/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005935 * Search hashitem in parent scope.
5936 */
5937 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005938find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005939{
5940 funccall_T *old_current_funccal = current_funccal;
5941 hashtab_T *ht;
5942 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005943 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005944
5945 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5946 return NULL;
5947
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005948 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005949 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005950 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005951 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005952 ht = find_var_ht(name, &varname);
5953 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005954 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005955 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005956 if (!HASHITEM_EMPTY(hi))
5957 {
5958 *pht = ht;
5959 break;
5960 }
5961 }
5962 if (current_funccal == current_funccal->func->uf_scoped)
5963 break;
5964 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005965 }
5966 current_funccal = old_current_funccal;
5967
5968 return hi;
5969}
5970
5971/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005972 * Search variable in parent scope.
5973 */
5974 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005975find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005976{
5977 dictitem_T *v = NULL;
5978 funccall_T *old_current_funccal = current_funccal;
5979 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005980 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005981
5982 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5983 return NULL;
5984
Bram Moolenaare38eab22019-12-05 21:50:01 +01005985 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005986 current_funccal = current_funccal->func->uf_scoped;
5987 while (current_funccal)
5988 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005989 ht = find_var_ht(name, &varname);
5990 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005991 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005992 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005993 if (v != NULL)
5994 break;
5995 }
5996 if (current_funccal == current_funccal->func->uf_scoped)
5997 break;
5998 current_funccal = current_funccal->func->uf_scoped;
5999 }
6000 current_funccal = old_current_funccal;
6001
6002 return v;
6003}
6004
6005/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006006 * Set "copyID + 1" in previous_funccal and callers.
6007 */
6008 int
6009set_ref_in_previous_funccal(int copyID)
6010{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006011 funccall_T *fc;
6012
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006013 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006014 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006015 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006016 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6017 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6018 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6019 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006020 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006021 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006022}
6023
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006024 static int
6025set_ref_in_funccal(funccall_T *fc, int copyID)
6026{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006027 if (fc->fc_copyID != copyID)
6028 {
6029 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006030 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6031 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6032 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6033 || set_ref_in_func(NULL, fc->func, copyID))
6034 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006035 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006036 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006037}
6038
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006039/*
6040 * Set "copyID" in all local vars and arguments in the call stack.
6041 */
6042 int
6043set_ref_in_call_stack(int copyID)
6044{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006045 funccall_T *fc;
6046 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006047
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006048 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6049 if (set_ref_in_funccal(fc, copyID))
6050 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006051
6052 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006053 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6054 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6055 if (set_ref_in_funccal(fc, copyID))
6056 return TRUE;
6057 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006058}
6059
6060/*
6061 * Set "copyID" in all functions available by name.
6062 */
6063 int
6064set_ref_in_functions(int copyID)
6065{
6066 int todo;
6067 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006068 ufunc_T *fp;
6069
6070 todo = (int)func_hashtab.ht_used;
6071 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006072 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006073 if (!HASHITEM_EMPTY(hi))
6074 {
6075 --todo;
6076 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006077 if (!func_name_refcount(fp->uf_name)
6078 && set_ref_in_func(NULL, fp, copyID))
6079 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006080 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006081 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006082 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006083}
6084
6085/*
6086 * Set "copyID" in all function arguments.
6087 */
6088 int
6089set_ref_in_func_args(int copyID)
6090{
6091 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006092
6093 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006094 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6095 copyID, NULL, NULL))
6096 return TRUE;
6097 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006098}
6099
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006100/*
6101 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006102 * Returns TRUE if setting references failed somehow.
6103 */
6104 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006105set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006106{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006107 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006108 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006109 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006110 char_u fname_buf[FLEN_FIXED + 1];
6111 char_u *tofree = NULL;
6112 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006113 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006114
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006115 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006116 return FALSE;
6117
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006118 if (fp_in == NULL)
6119 {
6120 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006121 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006122 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006123 if (fp != NULL)
6124 {
6125 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006126 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006127 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006128
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006129 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006130 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006131}
6132
Bram Moolenaare38eab22019-12-05 21:50:01 +01006133#endif // FEAT_EVAL