blob: d5dd3698983496c25b60bdcbed731da5f2dae275 [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);
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +010035static char_u *untrans_function_name(char_u *name);
Bram Moolenaar58779852022-09-06 18:31:14 +010036static void handle_defer_one(funccall_T *funccal);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020037
38 void
39func_init()
40{
41 hash_init(&func_hashtab);
42}
43
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020044/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020045 * Return the function hash table
46 */
47 hashtab_T *
48func_tbl_get(void)
49{
50 return &func_hashtab;
51}
52
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
Bram Moolenaarffdaca92022-12-09 21:41:48 +0000191 && eap->cmdlinep != NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000192 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
193 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000194 *eap->cmdlinep = theline;
Bram Moolenaarb5820102023-01-25 12:27:13 +0000195 (void)ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000196 }
197
198 return theline;
199}
200
201/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200202 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100203 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100204 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200205 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100206 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200207get_function_args(
208 char_u **argp,
209 char_u endchar,
210 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100211 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100212 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100213 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200214 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200215 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200216 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000217 exarg_T *eap, // can be NULL
Bram Moolenaar554d0312023-01-05 19:59:18 +0000218 int in_class, // non-zero when inside a class or interface
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000219 garray_T *newlines, // function body lines
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000220 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200221{
222 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100223 char_u *arg;
224 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200225 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200226 int any_default = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100227 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200228
229 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000230 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100231 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000232 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200233 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000234 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200235
236 if (varargs != NULL)
237 *varargs = FALSE;
238
239 /*
240 * Isolate the arguments: "arg1, arg2, ...)"
241 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100242 arg = skipwhite(*argp);
243 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200244 while (*p != endchar)
245 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200246 while (eap != NULL && eap->getline != NULL
247 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200248 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200249 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000250 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000251 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000252
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200253 if (theline == NULL)
254 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200255 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200256 p = skipwhite(theline);
257 }
258
259 if (mustend && *p != endchar)
260 {
261 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000262 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100263 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200264 }
265 if (*p == endchar)
266 break;
267
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200268 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
269 {
270 if (varargs != NULL)
271 *varargs = TRUE;
272 p += 3;
273 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100274
275 if (argtypes != NULL)
276 {
277 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200278 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100279 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100280 if (!skip)
281 emsg(_(e_missing_name_after_dots));
282 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100283 }
284
285 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100286 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000287 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100288 if (p == arg)
289 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100290 if (*skipwhite(p) == '=')
291 {
292 emsg(_(e_cannot_use_default_for_variable_arguments));
293 break;
294 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100295 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200296 }
Bram Moolenaarffdaca92022-12-09 21:41:48 +0000297 else if (in_class && STRNCMP(p, "this.", 5) == 0)
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000298 {
299 // this.memberName
300 p += 5;
301 arg = p;
302 while (ASCII_ISALNUM(*p) || *p == '_')
303 ++p;
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000304 char_u *argend = p;
305
306 if (*skipwhite(p) == '=')
307 {
308 char_u *defval = skipwhite(skipwhite(p) + 1);
309 if (STRNCMP(defval, "v:none", 6) != 0)
310 {
311 semsg(_(e_constructor_default_value_must_be_vnone_str), p);
312 goto err_ret;
313 }
314 any_default = TRUE;
315 p = defval + 6;
316
317 if (ga_grow(default_args, 1) == FAIL)
318 goto err_ret;
319
320 char_u *expr = vim_strsave((char_u *)"v:none");
321 if (expr == NULL)
322 goto err_ret;
323 ((char_u **)(default_args->ga_data))
324 [default_args->ga_len] = expr;
325 default_args->ga_len++;
326 }
327 else if (any_default)
328 {
329 emsg(_(e_non_default_argument_follows_default_argument));
330 goto err_ret;
331 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000332
333 // TODO: check the argument is indeed a member
334 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
335 return FAIL;
336 if (newargs != NULL)
337 {
338 ((char_u **)(newargs->ga_data))[newargs->ga_len] =
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000339 vim_strnsave(arg, argend - arg);
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000340 newargs->ga_len++;
341
342 if (argtypes != NULL && ga_grow(argtypes, 1) == OK)
343 {
344 // TODO: use the actual type
345 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] =
346 vim_strsave((char_u *)"any");
347
348 // Add a line to the function body for the assignment.
349 if (ga_grow(newlines, 1) == OK)
350 {
351 // "this.name = name"
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000352 int len = 5 + (argend - arg) + 3 + (argend - arg) + 1;
353 if (any_default)
354 len += 14 + 10;
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000355 char_u *assignment = alloc(len);
356 if (assignment != NULL)
357 {
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000358 c = *argend;
359 *argend = NUL;
360 if (any_default)
361 vim_snprintf((char *)assignment, len,
362 "ifargisset %d this.%s = %s",
363 default_args->ga_len - 1, arg, arg);
364 else
365 vim_snprintf((char *)assignment, len,
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000366 "this.%s = %s", arg, arg);
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000367 *argend = c;
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000368 ((char_u **)(newlines->ga_data))[
369 newlines->ga_len++] = assignment;
370 }
371 }
372 }
373 }
374 if (*p == ',')
375 ++p;
376 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 else
378 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200379 char_u *np;
380
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200381 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100382 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000383 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100384 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200385 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200386
Bram Moolenaar015cf102021-06-26 21:52:02 +0200387 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200388 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200389 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200390 if (*np == '=' && np[1] != '=' && np[1] != '~'
391 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200392 {
393 typval_T rettv;
394
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100395 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200396 any_default = TRUE;
Bram Moolenaareb5adf12022-09-04 13:41:37 +0100397 p = skipwhite(np + 1);
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000398 char_u *expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200399 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200400 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200401 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200402 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200403 if (ga_grow(default_args, 1) == FAIL)
404 goto err_ret;
405
406 // trim trailing whitespace
407 while (p > expr && VIM_ISWHITE(p[-1]))
408 p--;
409 c = *p;
410 *p = NUL;
411 expr = vim_strsave(expr);
412 if (expr == NULL)
413 {
414 *p = c;
415 goto err_ret;
416 }
417 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200418 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200419 default_args->ga_len++;
420 *p = c;
421 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200422 }
423 else
424 mustend = TRUE;
425 }
426 else if (any_default)
427 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000428 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200429 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200430 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200431
432 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
433 {
434 // Be tolerant when skipping
435 if (!skip)
436 {
437 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
438 goto err_ret;
439 }
440 p = skipwhite(p);
441 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200442 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200443 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200444 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200445 // Don't give this error when skipping, it makes the "->" not
446 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100447 // Allow missing space after comma in legacy functions.
448 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200449 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
450 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100451 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200452 goto err_ret;
453 }
454 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200455 else
456 mustend = TRUE;
457 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200458 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200459 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200460 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200461
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200462 if (*p != endchar)
463 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100464 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200465
466 *argp = p;
467 return OK;
468
469err_ret:
470 if (newargs != NULL)
471 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200472 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200473 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200474 return FAIL;
475}
476
477/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100478 * Parse the argument types, filling "fp->uf_arg_types".
479 * Return OK or FAIL.
480 */
481 static int
482parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
483{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200484 int len = 0;
485
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100486 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
487 if (argtypes->ga_len > 0)
488 {
489 // When "varargs" is set the last name/type goes into uf_va_name
490 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200491 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100492
493 if (len > 0)
494 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
495 if (fp->uf_arg_types != NULL)
496 {
497 int i;
498 type_T *type;
499
500 for (i = 0; i < len; ++ i)
501 {
502 char_u *p = ((char_u **)argtypes->ga_data)[i];
503
504 if (p == NULL)
505 // will get the type from the default value
506 type = &t_unknown;
507 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100508 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100509 if (type == NULL)
510 return FAIL;
511 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000512 if (i < fp->uf_args.ga_len
513 && (type->tt_type == VAR_FUNC
514 || type->tt_type == VAR_PARTIAL)
515 && var_wrong_func_name(
516 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
517 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100518 }
519 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100520 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200521
522 if (varargs)
523 {
524 char_u *p;
525
526 // Move the last argument "...name: type" to uf_va_name and
527 // uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200528 --fp->uf_args.ga_len;
Bram Moolenaarf0571712023-01-04 13:16:20 +0000529 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)[fp->uf_args.ga_len];
530 ((char_u **)fp->uf_args.ga_data)[fp->uf_args.ga_len] = NULL;
Bram Moolenaar2a389082021-04-09 20:24:31 +0200531 p = ((char_u **)argtypes->ga_data)[len];
532 if (p == NULL)
533 // TODO: get type from default value
534 fp->uf_va_type = &t_list_any;
535 else
536 {
537 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
538 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
539 {
540 semsg(_(e_variable_arguments_type_must_be_list_str),
541 ((char_u **)argtypes->ga_data)[len]);
542 return FAIL;
543 }
544 }
545 if (fp->uf_va_type == NULL)
546 return FAIL;
547 }
548
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100549 return OK;
550}
551
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100552 static int
553parse_return_type(ufunc_T *fp, char_u *ret_type)
554{
555 if (ret_type == NULL)
556 fp->uf_ret_type = &t_void;
557 else
558 {
559 char_u *p = ret_type;
560
561 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
562 if (fp->uf_ret_type == NULL)
563 {
564 fp->uf_ret_type = &t_void;
565 return FAIL;
566 }
567 }
568 return OK;
569}
570
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100571/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200572 * Register function "fp" as using "current_funccal" as its scope.
573 */
574 static int
575register_closure(ufunc_T *fp)
576{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200577 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100578 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200579 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200580 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200581 fp->uf_scoped = current_funccal;
582 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200583
Bram Moolenaarca16c602022-09-06 18:57:08 +0100584 if (ga_grow(&current_funccal->fc_ufuncs, 1) == FAIL)
Bram Moolenaar58016442016-07-31 18:30:22 +0200585 return FAIL;
Bram Moolenaarca16c602022-09-06 18:57:08 +0100586 ((ufunc_T **)current_funccal->fc_ufuncs.ga_data)
587 [current_funccal->fc_ufuncs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200588 return OK;
589}
590
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100591 static void
592set_ufunc_name(ufunc_T *fp, char_u *name)
593{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100594 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
595 // actually extends beyond the struct.
596 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100597
598 if (name[0] == K_SPECIAL)
599 {
600 fp->uf_name_exp = alloc(STRLEN(name) + 3);
601 if (fp->uf_name_exp != NULL)
602 {
603 STRCPY(fp->uf_name_exp, "<SNR>");
604 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
605 }
606 }
607}
608
Bram Moolenaar58016442016-07-31 18:30:22 +0200609/*
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100610 * If "name" starts with K_SPECIAL and "buf[bufsize]" is big enough
611 * return "buf" filled with a readable function name.
612 * Otherwise just return "name", thus the return value can always be used.
613 * "name" and "buf" may be equal.
614 */
615 char_u *
616make_ufunc_name_readable(char_u *name, char_u *buf, size_t bufsize)
617{
618 size_t len;
619
620 if (name[0] != K_SPECIAL)
621 return name;
622 len = STRLEN(name);
623 if (len + 3 > bufsize)
624 return name;
625
Bram Moolenaar96e08e02022-03-31 21:40:33 +0100626 mch_memmove(buf + 5, name + 3, len - 2); // Include trailing NUL
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100627 mch_memmove(buf, "<SNR>", 5);
628 return buf;
629}
630
631/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200632 * Get a name for a lambda. Returned in static memory.
633 */
634 char_u *
635get_lambda_name(void)
636{
637 static char_u name[30];
638 static int lambda_no = 0;
639
640 sprintf((char*)name, "<lambda>%d", ++lambda_no);
641 return name;
642}
643
Bram Moolenaare01e5212023-01-08 20:31:18 +0000644/*
645 * Allocate a "ufunc_T" for a function called "name".
646 * Makes sure the size is right.
647 */
648 static ufunc_T *
649alloc_ufunc(char_u *name)
650{
651 // When the name is short we need to make sure we allocate enough bytes for
652 // the whole struct, including any padding.
653 size_t len = offsetof(ufunc_T, uf_name) + STRLEN(name) + 1;
654 return alloc_clear(len < sizeof(ufunc_T) ? sizeof(ufunc_T) : len);
655}
656
Bram Moolenaar801ab062020-06-25 19:27:56 +0200657#if defined(FEAT_LUA) || defined(PROTO)
658/*
659 * Registers a native C callback which can be called from Vim script.
660 * Returns the name of the Vim script function.
661 */
662 char_u *
663register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
664{
665 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200666 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200667
Bram Moolenaare01e5212023-01-08 20:31:18 +0000668 fp = alloc_ufunc(name);
Bram Moolenaar801ab062020-06-25 19:27:56 +0200669 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200670 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200671
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200672 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200673 fp->uf_refcount = 1;
674 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000675 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200676 fp->uf_calls = 0;
677 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200678 fp->uf_cb = cb;
679 fp->uf_cb_free = cb_free;
680 fp->uf_cb_state = state;
681
682 set_ufunc_name(fp, name);
Bram Moolenaaref2c3252022-11-25 16:31:51 +0000683 hash_add(&func_hashtab, UF2HIKEY(fp), "add C function");
Bram Moolenaar801ab062020-06-25 19:27:56 +0200684
685 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200686}
687#endif
688
Bram Moolenaar04b12692020-05-04 23:24:44 +0200689/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100690 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100691 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100692 * If "white_error" is not NULL check for correct use of white space and set
693 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100694 * Return NULL if no valid arrow found.
695 */
696 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100697skip_arrow(
698 char_u *start,
699 int equal_arrow,
700 char_u **ret_type,
701 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100702{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100703 char_u *s = start;
704 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100705
706 if (equal_arrow)
707 {
708 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100709 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100710 if (white_error != NULL && !VIM_ISWHITE(s[1]))
711 {
712 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100713 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100714 return NULL;
715 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100716 s = skipwhite(s + 1);
717 *ret_type = s;
718 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100719 if (s == *ret_type)
720 {
721 emsg(_(e_missing_return_type));
722 return NULL;
723 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100724 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100725 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100726 s = skipwhite(s);
727 if (*s != '=')
728 return NULL;
729 ++s;
730 }
731 if (*s != '>')
732 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100733 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
734 || !IS_WHITE_OR_NUL(s[1])))
735 {
736 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100737 semsg(_(e_white_space_required_before_and_after_str_at_str),
738 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100739 return NULL;
740 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100741 return skipwhite(s + 1);
742}
743
744/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100745 * Check if "*cmd" points to a function command and if so advance "*cmd" and
746 * return TRUE.
747 * Otherwise return FALSE;
748 * Do not consider "function(" to be a command.
749 */
750 static int
751is_function_cmd(char_u **cmd)
752{
753 char_u *p = *cmd;
754
755 if (checkforcmd(&p, "function", 2))
756 {
757 if (*p == '(')
758 return FALSE;
759 *cmd = p;
760 return TRUE;
761 }
762 return FALSE;
763}
764
765/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200766 * Called when defining a function: The context may be needed for script
767 * variables declared in a block that is visible now but not when the function
768 * is compiled or called later.
769 */
770 static void
771function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
772{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000773 if (cstack == NULL || cstack->cs_idx < 0)
774 return;
775
776 int count = cstack->cs_idx + 1;
777 int i;
778
779 fp->uf_block_ids = ALLOC_MULT(int, count);
780 if (fp->uf_block_ids != NULL)
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200781 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000782 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
783 sizeof(int) * count);
784 fp->uf_block_depth = count;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200785 }
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000786
787 // Set flag in each block to indicate a function was defined. This
788 // is used to keep the variable when leaving the block, see
789 // hide_script_var().
790 for (i = 0; i <= cstack->cs_idx; ++i)
791 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200792}
793
794/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100795 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200796 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100797 * "newlines" must already have been initialized.
798 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
799 */
800 static int
801get_function_body(
802 exarg_T *eap,
803 garray_T *newlines,
804 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000805 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100806{
807 linenr_T sourcing_lnum_top = SOURCING_LNUM;
808 linenr_T sourcing_lnum_off;
809 int saved_wait_return = need_wait_return;
810 char_u *line_arg = line_arg_in;
811 int vim9_function = eap->cmdidx == CMD_def
812 || eap->cmdidx == CMD_block;
813#define MAX_FUNC_NESTING 50
814 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200815 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100816 int nesting = 0;
817 getline_opt_T getline_options;
818 int indent = 2;
819 char_u *skip_until = NULL;
820 int ret = FAIL;
821 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200822 int heredoc_concat_len = 0;
823 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100824 char_u *heredoc_trimmed = NULL;
825
Bram Moolenaar20677332021-06-06 17:02:53 +0200826 ga_init2(&heredoc_ga, 1, 500);
827
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100828 // Detect having skipped over comment lines to find the return
829 // type. Add NULL lines to keep the line count correct.
830 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
831 if (SOURCING_LNUM < sourcing_lnum_off)
832 {
833 sourcing_lnum_off -= SOURCING_LNUM;
834 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
835 goto theend;
836 while (sourcing_lnum_off-- > 0)
837 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
838 }
839
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200840 nesting_def[0] = vim9_function;
841 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100842 getline_options = vim9_function
843 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
844 for (;;)
845 {
846 char_u *theline;
847 char_u *p;
848 char_u *arg;
849
850 if (KeyTyped)
851 {
852 msg_scroll = TRUE;
853 saved_wait_return = FALSE;
854 }
855 need_wait_return = FALSE;
856
857 if (line_arg != NULL)
858 {
859 // Use eap->arg, split up in parts by line breaks.
860 theline = line_arg;
861 p = vim_strchr(theline, '\n');
862 if (p == NULL)
863 line_arg += STRLEN(line_arg);
864 else
865 {
866 *p = NUL;
867 line_arg = p + 1;
868 }
869 }
870 else
871 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000872 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100873 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100874 }
875 if (KeyTyped)
876 lines_left = Rows - 1;
877 if (theline == NULL)
878 {
879 // Use the start of the function for the line number.
880 SOURCING_LNUM = sourcing_lnum_top;
881 if (skip_until != NULL)
882 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200883 else if (nesting_inline[nesting])
884 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100885 else if (eap->cmdidx == CMD_def)
886 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100887 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000888 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100889 goto theend;
890 }
891
892 // Detect line continuation: SOURCING_LNUM increased more than one.
893 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
894 if (SOURCING_LNUM < sourcing_lnum_off)
895 sourcing_lnum_off -= SOURCING_LNUM;
896 else
897 sourcing_lnum_off = 0;
898
899 if (skip_until != NULL)
900 {
901 // Don't check for ":endfunc"/":enddef" between
902 // * ":append" and "."
903 // * ":python <<EOF" and "EOF"
904 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
905 if (heredoc_trimmed == NULL
906 || (is_heredoc && skipwhite(theline) == theline)
907 || STRNCMP(theline, heredoc_trimmed,
908 STRLEN(heredoc_trimmed)) == 0)
909 {
910 if (heredoc_trimmed == NULL)
911 p = theline;
912 else if (is_heredoc)
913 p = skipwhite(theline) == theline
914 ? theline : theline + STRLEN(heredoc_trimmed);
915 else
916 p = theline + STRLEN(heredoc_trimmed);
917 if (STRCMP(p, skip_until) == 0)
918 {
919 VIM_CLEAR(skip_until);
920 VIM_CLEAR(heredoc_trimmed);
921 getline_options = vim9_function
922 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
923 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200924
925 if (heredoc_concat_len > 0)
926 {
927 // Replace the starting line with all the concatenated
928 // lines.
929 ga_concat(&heredoc_ga, theline);
930 vim_free(((char_u **)(newlines->ga_data))[
931 heredoc_concat_len - 1]);
932 ((char_u **)(newlines->ga_data))[
933 heredoc_concat_len - 1] = heredoc_ga.ga_data;
934 ga_init(&heredoc_ga);
935 heredoc_concat_len = 0;
936 theline += STRLEN(theline); // skip the "EOF"
937 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100938 }
939 }
940 }
941 else
942 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200943 int c;
944 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000945 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100946
947 // skip ':' and blanks
948 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
949 ;
950
951 // Check for "endfunction", "enddef" or "}".
952 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000953 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200954 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100955 ? *p == '}'
956 : (checkforcmd(&p, nesting_def[nesting]
957 ? "enddef" : "endfunction", 4)
958 && *p != ':'))
959 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000960 if (!nesting_inline[nesting] && nesting_def[nesting]
961 && p < cmd + 6)
962 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100963 if (nesting-- == 0)
964 {
965 char_u *nextcmd = NULL;
966
967 if (*p == '|' || *p == '}')
968 nextcmd = p + 1;
969 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
970 nextcmd = line_arg;
971 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100972 && (vim9_function || p_verbose > 0))
973 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200974 SOURCING_LNUM = sourcing_lnum_top
975 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100976 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000977 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100978 else
979 give_warning2((char_u *)
980 _("W22: Text found after :endfunction: %s"),
981 p, TRUE);
982 }
983 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100984 {
985 // Another command follows. If the line came from "eap"
986 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000987 // change "eap->cmdlinep" to point to the last fetched
988 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100989 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000990 if (lines_to_free->ga_len > 0
991 && *eap->cmdlinep !=
992 ((char_u **)lines_to_free->ga_data)
993 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100994 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000995 // *cmdlinep will be freed later, thus remove the
996 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000998 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
999 [lines_to_free->ga_len - 1];
1000 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001001 }
1002 }
1003 break;
1004 }
1005 }
1006
1007 // Check for mismatched "endfunc" or "enddef".
1008 // We don't check for "def" inside "func" thus we also can't check
1009 // for "enddef".
1010 // We continue to find the end of the function, although we might
1011 // not find it.
1012 else if (nesting_def[nesting])
1013 {
1014 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
1015 emsg(_(e_mismatched_endfunction));
1016 }
1017 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
1018 emsg(_(e_mismatched_enddef));
1019
1020 // Increase indent inside "if", "while", "for" and "try", decrease
1021 // at "end".
1022 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
1023 indent -= 2;
1024 else if (STRNCMP(p, "if", 2) == 0
1025 || STRNCMP(p, "wh", 2) == 0
1026 || STRNCMP(p, "for", 3) == 0
1027 || STRNCMP(p, "try", 3) == 0)
1028 indent += 2;
1029
1030 // Check for defining a function inside this function.
1031 // Only recognize "def" inside "def", not inside "function",
1032 // For backwards compatibility, see Test_function_python().
1033 c = *p;
1034 if (is_function_cmd(&p)
1035 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
1036 {
1037 if (*p == '!')
1038 p = skipwhite(p + 1);
1039 p += eval_fname_script(p);
1040 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
1041 NULL, NULL));
1042 if (*skipwhite(p) == '(')
1043 {
1044 if (nesting == MAX_FUNC_NESTING - 1)
1045 emsg(_(e_function_nesting_too_deep));
1046 else
1047 {
1048 ++nesting;
1049 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001050 nesting_inline[nesting] = FALSE;
1051 indent += 2;
1052 }
1053 }
1054 }
1055
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001056 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001057 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001058 // Not a comment line: check for nested inline function.
1059 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001060 while (end > p && VIM_ISWHITE(*end))
1061 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +02001062 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001063 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001064 int is_block;
1065
1066 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001067 --end;
1068 while (end > p && VIM_ISWHITE(*end))
1069 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001070 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
1071 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001072 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001073 char_u *s = p;
1074
1075 // check for line starting with "au" for :autocmd or
1076 // "com" for :command, these can use a {} block
1077 is_block = checkforcmd_noparen(&s, "autocmd", 2)
1078 || checkforcmd_noparen(&s, "command", 3);
1079 }
1080
1081 if (is_block)
1082 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001083 if (nesting == MAX_FUNC_NESTING - 1)
1084 emsg(_(e_function_nesting_too_deep));
1085 else
1086 {
1087 ++nesting;
1088 nesting_def[nesting] = TRUE;
1089 nesting_inline[nesting] = TRUE;
1090 indent += 2;
1091 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001092 }
1093 }
1094 }
1095
1096 // Check for ":append", ":change", ":insert". Not for :def.
1097 p = skip_range(p, FALSE, NULL);
1098 if (!vim9_function
1099 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1100 || (p[0] == 'c'
1101 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1102 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1103 && (STRNCMP(&p[3], "nge", 3) != 0
1104 || !ASCII_ISALPHA(p[6])))))))
1105 || (p[0] == 'i'
1106 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1107 && (!ASCII_ISALPHA(p[2])
1108 || (p[2] == 's'
1109 && (!ASCII_ISALPHA(p[3])
1110 || p[3] == 'e'))))))))
1111 skip_until = vim_strsave((char_u *)".");
1112
1113 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1114 arg = skipwhite(skiptowhite(p));
1115 if (arg[0] == '<' && arg[1] =='<'
1116 && ((p[0] == 'p' && p[1] == 'y'
1117 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1118 || ((p[2] == '3' || p[2] == 'x')
1119 && !ASCII_ISALPHA(p[3]))))
1120 || (p[0] == 'p' && p[1] == 'e'
1121 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1122 || (p[0] == 't' && p[1] == 'c'
1123 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1124 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1125 && !ASCII_ISALPHA(p[3]))
1126 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1127 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1128 || (p[0] == 'm' && p[1] == 'z'
1129 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1130 ))
1131 {
1132 // ":python <<" continues until a dot, like ":append"
1133 p = skipwhite(arg + 2);
1134 if (STRNCMP(p, "trim", 4) == 0)
1135 {
1136 // Ignore leading white space.
1137 p = skipwhite(p + 4);
1138 heredoc_trimmed = vim_strnsave(theline,
1139 skipwhite(theline) - theline);
1140 }
1141 if (*p == NUL)
1142 skip_until = vim_strsave((char_u *)".");
1143 else
1144 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1145 getline_options = GETLINE_NONE;
1146 is_heredoc = TRUE;
Bram Moolenaard881d152022-05-13 13:50:36 +01001147 if (eap->cmdidx == CMD_def && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001148 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001149 }
1150
Bram Moolenaard881d152022-05-13 13:50:36 +01001151 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001152 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001153 // Check for ":cmd v =<< [trim] EOF"
1154 // and ":cmd [a, b] =<< [trim] EOF"
1155 // and "lines =<< [trim] EOF" for Vim9
1156 // Where "cmd" can be "let", "var", "final" or "const".
1157 arg = skipwhite(skiptowhite(p));
1158 if (*arg == '[')
1159 arg = vim_strchr(arg, ']');
1160 if (arg != NULL)
1161 {
1162 int found = (eap->cmdidx == CMD_def && arg[0] == '='
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001163 && arg[1] == '<' && arg[2] =='<');
1164
Bram Moolenaard881d152022-05-13 13:50:36 +01001165 if (!found)
1166 // skip over the argument after "cmd"
1167 arg = skipwhite(skiptowhite(arg));
1168 if (found || (arg[0] == '=' && arg[1] == '<'
1169 && arg[2] =='<'
1170 && (checkforcmd(&p, "let", 2)
1171 || checkforcmd(&p, "var", 3)
1172 || checkforcmd(&p, "final", 5)
1173 || checkforcmd(&p, "const", 5))))
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001174 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001175 p = skipwhite(arg + 3);
1176 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001177 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001178 if (STRNCMP(p, "trim", 4) == 0)
1179 {
1180 // Ignore leading white space.
1181 p = skipwhite(p + 4);
1182 heredoc_trimmed = vim_strnsave(theline,
1183 skipwhite(theline) - theline);
1184 continue;
1185 }
1186 if (STRNCMP(p, "eval", 4) == 0)
1187 {
1188 // Ignore leading white space.
1189 p = skipwhite(p + 4);
1190 continue;
1191 }
1192 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001193 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001194 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1195 getline_options = GETLINE_NONE;
1196 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001197 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001198 }
1199 }
1200 }
1201
1202 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001203 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001204 goto theend;
1205
Bram Moolenaar20677332021-06-06 17:02:53 +02001206 if (heredoc_concat_len > 0)
1207 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001208 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001209 // to be used for the instruction later.
1210 ga_concat(&heredoc_ga, theline);
1211 ga_concat(&heredoc_ga, (char_u *)"\n");
1212 p = vim_strsave((char_u *)"");
1213 }
1214 else
1215 {
1216 // Copy the line to newly allocated memory. get_one_sourceline()
1217 // allocates 250 bytes per line, this saves 80% on average. The
1218 // cost is an extra alloc/free.
1219 p = vim_strsave(theline);
1220 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001221 if (p == NULL)
1222 goto theend;
1223 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1224
1225 // Add NULL lines for continuation lines, so that the line count is
1226 // equal to the index in the growarray.
1227 while (sourcing_lnum_off-- > 0)
1228 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1229
1230 // Check for end of eap->arg.
1231 if (line_arg != NULL && *line_arg == NUL)
1232 line_arg = NULL;
1233 }
1234
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001235 // Return OK when no error was detected.
1236 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001237 ret = OK;
1238
1239theend:
1240 vim_free(skip_until);
1241 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001242 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001243 need_wait_return |= saved_wait_return;
1244 return ret;
1245}
1246
1247/*
1248 * Handle the body of a lambda. *arg points to the "{", process statements
1249 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001250 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001251 * When successful "rettv" is set to a funcref.
1252 */
1253 static int
1254lambda_function_body(
1255 char_u **arg,
1256 typval_T *rettv,
1257 evalarg_T *evalarg,
1258 garray_T *newargs,
1259 garray_T *argtypes,
1260 int varargs,
1261 garray_T *default_args,
1262 char_u *ret_type)
1263{
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001264 char_u *start = *arg;
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001265 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001266 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001267 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001268 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001269 exarg_T eap;
1270 garray_T newlines;
1271 char_u *cmdline = NULL;
1272 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001273 partial_T *pt;
1274 char_u *name;
1275 int lnum_save = -1;
1276 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1277
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001278 *arg = skipwhite(*arg + 1);
1279 if (**arg == '|' || !ends_excmd2(start, *arg))
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001280 {
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001281 semsg(_(e_trailing_characters_str), *arg);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001282 return FAIL;
1283 }
1284
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 CLEAR_FIELD(eap);
1286 eap.cmdidx = CMD_block;
1287 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001288 eap.cmdlinep = &cmdline;
1289 eap.skip = !evaluate;
1290 if (evalarg->eval_cctx != NULL)
1291 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1292 else
1293 {
1294 eap.getline = evalarg->eval_getline;
1295 eap.cookie = evalarg->eval_cookie;
1296 }
1297
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001298 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001299 if (get_function_body(&eap, &newlines, NULL,
1300 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001301 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001302
1303 // When inside a lambda must add the function lines to evalarg.eval_ga.
1304 evalarg->eval_break_count += newlines.ga_len;
1305 if (gap->ga_itemsize > 0)
1306 {
1307 int idx;
1308 char_u *last;
1309 size_t plen;
1310 char_u *pnl;
1311
1312 for (idx = 0; idx < newlines.ga_len; ++idx)
1313 {
1314 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1315
Bram Moolenaarecb66452021-05-18 15:09:18 +02001316 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001317 goto erret;
1318
1319 // Going to concatenate the lines after parsing. For an empty or
1320 // comment line use an empty string.
1321 // Insert NL characters at the start of each line, the string will
1322 // be split again later in .get_lambda_tv().
1323 if (*p == NUL || vim9_comment_start(p))
1324 p = (char_u *)"";
1325 plen = STRLEN(p);
1326 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1327 if (pnl != NULL)
1328 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001329 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1330 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001331 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001332 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001333 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001334 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001335 // more is following after the "}", which was skipped
1336 last = cmdline;
1337 else
1338 // nothing is following the "}"
1339 last = (char_u *)"}";
1340 plen = STRLEN(last);
1341 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1342 if (pnl != NULL)
1343 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001344 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1345 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001346 }
1347
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001348 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001349 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001350 garray_T *tfgap = &evalarg->eval_tofree_ga;
1351
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001352 // Something comes after the "}".
1353 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001354
1355 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001356 if (ga_grow(tfgap, 1) == OK)
1357 {
1358 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1359 evalarg->eval_using_cmdline = TRUE;
1360 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001361 }
1362 else
1363 *arg = (char_u *)"";
1364
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001365 if (!evaluate)
1366 {
1367 ret = OK;
1368 goto erret;
1369 }
1370
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001371 name = get_lambda_name();
Bram Moolenaare01e5212023-01-08 20:31:18 +00001372 ufunc = alloc_ufunc(name);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001373 if (ufunc == NULL)
1374 goto erret;
1375 set_ufunc_name(ufunc, name);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001376 if (hash_add(&func_hashtab, UF2HIKEY(ufunc), "add function") == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001377 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001378 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001379 ufunc->uf_refcount = 1;
1380 ufunc->uf_args = *newargs;
1381 newargs->ga_data = NULL;
1382 ufunc->uf_def_args = *default_args;
1383 default_args->ga_data = NULL;
1384 ufunc->uf_func_type = &t_func_any;
1385
1386 // error messages are for the first function line
1387 lnum_save = SOURCING_LNUM;
1388 SOURCING_LNUM = sourcing_lnum_top;
1389
1390 // parse argument types
1391 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1392 {
1393 SOURCING_LNUM = lnum_save;
1394 goto erret;
1395 }
1396
1397 // parse the return type, if any
1398 if (parse_return_type(ufunc, ret_type) == FAIL)
1399 goto erret;
1400
1401 pt = ALLOC_CLEAR_ONE(partial_T);
1402 if (pt == NULL)
1403 goto erret;
1404 pt->pt_func = ufunc;
1405 pt->pt_refcount = 1;
1406
1407 ufunc->uf_lines = newlines;
1408 newlines.ga_data = NULL;
1409 if (sandbox)
1410 ufunc->uf_flags |= FC_SANDBOX;
1411 if (!ASCII_ISUPPER(*ufunc->uf_name))
1412 ufunc->uf_flags |= FC_VIM9;
1413 ufunc->uf_script_ctx = current_sctx;
1414 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1415 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1416 set_function_type(ufunc);
1417
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001418 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1419
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001420 rettv->vval.v_partial = pt;
1421 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001422 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001423 ret = OK;
1424
1425erret:
1426 if (lnum_save >= 0)
1427 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001428 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001429 if (newargs != NULL)
1430 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001431 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001432 if (ufunc != NULL)
1433 {
1434 func_clear(ufunc, TRUE);
1435 func_free(ufunc, TRUE);
1436 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001437 return ret;
1438}
1439
1440/*
1441 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001442 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001443 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1445 */
1446 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001447get_lambda_tv(
1448 char_u **arg,
1449 typval_T *rettv,
1450 int types_optional,
1451 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001453 int evaluate = evalarg != NULL
1454 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 garray_T newargs;
1456 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001457 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001458 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001459 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001461 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001463 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001464 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001465 char_u *s;
1466 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001467 int *old_eval_lavars = eval_lavars_used;
1468 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001469 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001470 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001471 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001472 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001473 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001474 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001475
Bram Moolenaar4525a572022-02-13 11:57:33 +00001476 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001477 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478
1479 ga_init(&newargs);
1480 ga_init(&newlines);
1481
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001482 // First, check if this is really a lambda expression. "->" or "=>" must
1483 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001484 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001485 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001486 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001487 NULL, &default_args, TRUE, NULL, FALSE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001488 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001489 {
1490 if (types_optional)
1491 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001492 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001493 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001494
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001495 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001496 if (evaluate)
1497 pnewargs = &newargs;
1498 else
1499 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001500 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001501 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001502 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001503 &varargs, &default_args,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001504 FALSE, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001505 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001506 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001507 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001508 {
1509 if (types_optional)
1510 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001511 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001512 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001513 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001514 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001516 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1517 if (ret_type != NULL)
1518 {
1519 ret_type = vim_strsave(ret_type);
1520 tofree2 = ret_type;
1521 }
1522
Bram Moolenaare38eab22019-12-05 21:50:01 +01001523 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001524 if (evaluate)
1525 eval_lavars_used = &eval_lavars;
1526
Bram Moolenaar65c44152020-12-24 15:14:01 +01001527 *arg = skipwhite_and_linebreak(*arg, evalarg);
1528
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001529 // Recognize "{" as the start of a function body.
1530 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001531 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001532 if (evalarg == NULL)
1533 // cannot happen?
1534 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001535 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001536 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1537 types_optional ? &argtypes : NULL, varargs,
1538 &default_args, ret_type) == FAIL)
1539 goto errret;
1540 goto theend;
1541 }
1542 if (default_args.ga_len > 0)
1543 {
1544 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001545 goto errret;
1546 }
1547
Bram Moolenaare38eab22019-12-05 21:50:01 +01001548 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001549 start = *arg;
1550 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001551 if (ret == FAIL)
1552 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001553
Bram Moolenaar65c44152020-12-24 15:14:01 +01001554 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001555 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001556 *arg = skipwhite_and_linebreak(*arg, evalarg);
1557 if (**arg != '}')
1558 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001559 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001560 goto errret;
1561 }
1562 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001563 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564
1565 if (evaluate)
1566 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001567 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001568 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001569 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001570 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001571 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001572
Bram Moolenaare01e5212023-01-08 20:31:18 +00001573 fp = alloc_ufunc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 if (fp == NULL)
1575 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001576 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001577 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001578 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001579 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001581 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 if (ga_grow(&newlines, 1) == FAIL)
1583 goto errret;
1584
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001585 // If there are line breaks, we need to split up the string.
1586 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001587 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001588 line_end = end;
1589
1590 // Add "return " before the expression (or the first line).
1591 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001592 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593 if (p == NULL)
1594 goto errret;
1595 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1596 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001597 vim_strncpy(p + 7, start, line_end - start);
1598
1599 if (line_end != end)
1600 {
1601 // Add more lines, split by line breaks. Thus is used when a
1602 // lambda with { cmds } is encountered.
1603 while (*line_end == '\n')
1604 {
1605 if (ga_grow(&newlines, 1) == FAIL)
1606 goto errret;
1607 start = line_end + 1;
1608 line_end = vim_strchr(start, '\n');
1609 if (line_end == NULL)
1610 line_end = end;
1611 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1612 vim_strnsave(start, line_end - start);
1613 }
1614 }
1615
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001616 if (strstr((char *)p + 7, "a:") == NULL)
1617 // No a: variables are used for sure.
1618 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619
1620 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001621 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001623 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001624 if (types_optional)
1625 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001626 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001627 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001628 goto errret;
1629 if (ret_type != NULL)
1630 {
1631 fp->uf_ret_type = parse_type(&ret_type,
1632 &fp->uf_type_list, TRUE);
1633 if (fp->uf_ret_type == NULL)
1634 goto errret;
1635 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001636 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001637 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001638 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001639
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001641 if (current_funccal != NULL && eval_lavars)
1642 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001643 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001644 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001645 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001646 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647
1648#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 if (prof_def_func())
1650 func_do_profile(fp);
1651#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001652 if (sandbox)
1653 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001654 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001655 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001656 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001657 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001659 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001660 // Use the line number of the arguments.
1661 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001662
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001663 function_using_block_scopes(fp, evalarg->eval_cstack);
1664
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001665 pt->pt_func = fp;
1666 pt->pt_refcount = 1;
1667 rettv->vval.v_partial = pt;
1668 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001669
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001670 hash_add(&func_hashtab, UF2HIKEY(fp), "add lambda");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001671 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001673theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001674 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001675 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001676 if (types_optional)
1677 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001678
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679 return OK;
1680
1681errret:
1682 ga_clear_strings(&newargs);
1683 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001684 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001685 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001686 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001687 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001688 if (fp != NULL)
1689 vim_free(fp->uf_arg_types);
1690 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001692 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001693 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001694 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001695 return FAIL;
1696}
1697
1698/*
1699 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1700 * name it contains, otherwise return "name".
1701 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1702 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001703 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1704 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001705 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001706 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707 */
1708 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001709deref_func_name(
1710 char_u *name,
1711 int *lenp,
1712 partial_T **partialp,
1713 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001714 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001715 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001716 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717{
1718 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001719 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001721 char_u *s = NULL;
1722 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001723 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001724
1725 if (partialp != NULL)
1726 *partialp = NULL;
1727
1728 cc = name[*lenp];
1729 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001730
Bram Moolenaar71f21932022-01-07 18:20:55 +00001731 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001733 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001735 tv = &v->di_tv;
1736 }
1737 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1738 {
1739 imported_T *import;
1740 char_u *p = name;
1741 int len = *lenp;
1742
1743 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001744 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001745 p = name + 2;
1746 len -= 2;
1747 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001748 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001749
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001750 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001751 if (import != NULL)
1752 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001753 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001754 if (new_function)
1755 semsg(_(e_redefining_imported_item_str), name);
1756 else
1757 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001758 name[len] = cc;
1759 *lenp = 0;
1760 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001761 }
1762 }
1763
1764 if (tv != NULL)
1765 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001766 if (found_var != NULL)
1767 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001768 if (tv->v_type == VAR_FUNC)
1769 {
1770 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001771 {
1772 *lenp = 0;
1773 return (char_u *)""; // just in case
1774 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001775 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001776 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001779 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001781 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001782
1783 if (pt == NULL)
1784 {
1785 *lenp = 0;
1786 return (char_u *)""; // just in case
1787 }
1788 if (partialp != NULL)
1789 *partialp = pt;
1790 s = partial_name(pt);
1791 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001793
1794 if (s != NULL)
1795 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001796 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001797 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001798 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001799
1800 if (sv != NULL)
1801 *type = sv->sv_type;
1802 }
1803 return s;
1804 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805 }
1806
1807 return name;
1808}
1809
1810/*
1811 * Give an error message with a function name. Handle <SNR> things.
1812 * "ermsg" is to be passed without translation, use N_() instead of _().
1813 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001814 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001815emsg_funcname(char *ermsg, char_u *name)
1816{
Bram Moolenaar54598062022-01-13 12:05:09 +00001817 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818
Bram Moolenaar54598062022-01-13 12:05:09 +00001819 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001821 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 if (p != name)
1823 vim_free(p);
1824}
1825
1826/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001827 * Get function arguments at "*arg" and advance it.
1828 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001829 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830 */
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001831 int
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001832get_func_arguments(
1833 char_u **arg,
1834 evalarg_T *evalarg,
1835 int partial_argc,
1836 typval_T *argvars,
1837 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001839 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001840 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001841 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001842 int evaluate = evalarg == NULL
1843 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001844
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001845 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001846 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001847 // skip the '(' or ',' and possibly line breaks
1848 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1849
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 if (*argp == ')' || *argp == ',' || *argp == NUL)
1851 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001852 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 {
1854 ret = FAIL;
1855 break;
1856 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001857 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001858 // The comma should come right after the argument, but this wasn't
1859 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001860 if (vim9script)
1861 {
1862 if (*argp != ',' && *skipwhite(argp) == ',')
1863 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001864 if (evaluate)
1865 semsg(_(e_no_white_space_allowed_before_str_str),
1866 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001867 ret = FAIL;
1868 break;
1869 }
1870 }
1871 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001872 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 if (*argp != ',')
1874 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001875 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1876 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001877 if (evaluate)
1878 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001879 ret = FAIL;
1880 break;
1881 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001882 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001883
Bram Moolenaare6b53242020-07-01 17:28:33 +02001884 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885 if (*argp == ')')
1886 ++argp;
1887 else
1888 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001889 *arg = argp;
1890 return ret;
1891}
1892
1893/*
1894 * Call a function and put the result in "rettv".
1895 * Return OK or FAIL.
1896 */
1897 int
1898get_func_tv(
1899 char_u *name, // name of the function
1900 int len, // length of "name" or -1 to use strlen()
1901 typval_T *rettv,
1902 char_u **arg, // argument, pointing to the '('
1903 evalarg_T *evalarg, // for line continuation
1904 funcexe_T *funcexe) // various values
1905{
1906 char_u *argp;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001907 int ret;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001908 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1909 int argcount = 0; // number of arguments found
1910 int vim9script = in_vim9script();
1911 int evaluate = evalarg == NULL
1912 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1913
1914 argp = *arg;
1915 ret = get_func_arguments(&argp, evalarg,
1916 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1917 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918
1919 if (ret == OK)
1920 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001921 int i = 0;
1922 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001923
1924 if (get_vim_var_nr(VV_TESTING))
1925 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001926 // Prepare for calling test_garbagecollect_now(), need to know
1927 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001928 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001929 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001930 for (i = 0; i < argcount; ++i)
1931 if (ga_grow(&funcargs, 1) == OK)
1932 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1933 &argvars[i];
1934 }
1935
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001936 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001937 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001938 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001939 // An error in a builtin function does not return FAIL, but we do
1940 // want to abort further processing if an error was given.
1941 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001942 clear_tv(rettv);
1943 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001944
1945 funcargs.ga_len -= i;
1946 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001947 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001948 {
1949 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001950 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001952 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001953 }
1954
1955 while (--argcount >= 0)
1956 clear_tv(&argvars[argcount]);
1957
Bram Moolenaar4525a572022-02-13 11:57:33 +00001958 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001959 *arg = argp;
1960 else
1961 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001962 return ret;
1963}
1964
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965/*
1966 * Return TRUE if "p" starts with "<SID>" or "s:".
1967 * Only works if eval_fname_script() returned non-zero for "p"!
1968 */
1969 static int
1970eval_fname_sid(char_u *p)
1971{
1972 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1973}
1974
1975/*
1976 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1977 * Change <SNR>123_name() to K_SNR 123_name().
1978 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001979 * and set "tofree".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001980 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001981 char_u *
Bram Moolenaar0917e862023-02-18 14:42:44 +00001982fname_trans_sid(
1983 char_u *name,
1984 char_u *fname_buf,
1985 char_u **tofree,
1986 funcerror_T *error)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001987{
1988 int llen;
1989 char_u *fname;
1990 int i;
1991
1992 llen = eval_fname_script(name);
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001993 if (llen == 0)
1994 return name; // no prefix
1995
1996 fname_buf[0] = K_SPECIAL;
1997 fname_buf[1] = KS_EXTRA;
1998 fname_buf[2] = (int)KE_SNR;
1999 i = 3;
2000 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002001 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01002002 if (current_sctx.sc_sid <= 0)
2003 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002004 else
2005 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01002006 sprintf((char *)fname_buf + 3, "%ld_",
2007 (long)current_sctx.sc_sid);
2008 i = (int)STRLEN(fname_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002009 }
2010 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01002011 if (i + STRLEN(name + llen) < FLEN_FIXED)
2012 {
2013 STRCPY(fname_buf + i, name + llen);
2014 fname = fname_buf;
2015 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 else
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01002017 {
2018 fname = alloc(i + STRLEN(name + llen) + 1);
2019 if (fname == NULL)
2020 *error = FCERR_OTHER;
2021 else
2022 {
2023 *tofree = fname;
2024 mch_memmove(fname, fname_buf, (size_t)i);
2025 STRCPY(fname + i, name + llen);
2026 }
2027 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 return fname;
2029}
2030
2031/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002032 * Concatenate the script ID and function name into "<SNR>99_name".
2033 * "buffer" must have size MAX_FUNC_NAME_LEN.
2034 */
2035 void
2036func_name_with_sid(char_u *name, int sid, char_u *buffer)
2037{
2038 // A script-local function is stored as "<SNR>99_name".
2039 buffer[0] = K_SPECIAL;
2040 buffer[1] = KS_EXTRA;
2041 buffer[2] = (int)KE_SNR;
2042 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
2043 (long)sid, name);
2044}
2045
2046/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002047 * Find a function "name" in script "sid".
2048 */
2049 static ufunc_T *
2050find_func_with_sid(char_u *name, int sid)
2051{
Bram Moolenaarb8822442022-01-11 15:24:05 +00002052 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002053 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002054
Bram Moolenaarb8822442022-01-11 15:24:05 +00002055 if (!SCRIPT_ID_VALID(sid))
2056 return NULL; // not in a script
2057
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002058 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002059 hi = hash_find(&func_hashtab, buffer);
2060 if (!HASHITEM_EMPTY(hi))
2061 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002062 return NULL;
2063}
2064
2065/*
2066 * Find a function "name" in script "sid" prefixing the autoload prefix.
2067 */
2068 static ufunc_T *
2069find_func_with_prefix(char_u *name, int sid)
2070{
2071 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002072 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00002073 scriptitem_T *si;
2074
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002075 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00002076 return NULL; // already has the prefix
2077 if (!SCRIPT_ID_VALID(sid))
2078 return NULL; // not in a script
2079 si = SCRIPT_ITEM(sid);
2080 if (si->sn_autoload_prefix != NULL)
2081 {
2082 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
2083 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002084 char_u *namep;
2085
2086 // skip a "<SNR>99_" prefix
2087 namep = untrans_function_name(name);
2088 if (namep == NULL)
2089 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00002090
2091 // An exported function in an autoload script is stored as
2092 // "dir#path#name".
2093 if (len < sizeof(buffer))
2094 auto_name = buffer;
2095 else
2096 auto_name = alloc(len);
2097 if (auto_name != NULL)
2098 {
2099 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002100 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002101 hi = hash_find(&func_hashtab, auto_name);
2102 if (auto_name != buffer)
2103 vim_free(auto_name);
2104 if (!HASHITEM_EMPTY(hi))
2105 return HI2UF(hi);
2106 }
2107 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002108
2109 return NULL;
2110}
2111
2112/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002113 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002114 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2115 * functions.
2116 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002117 * Return NULL for unknown function.
2118 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002119 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002120find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002121{
2122 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002123 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002124
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002125 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002126 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002127 // Find script-local function before global one.
2128 if (in_vim9script() && eval_isnamec1(*name)
2129 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002130 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002131 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2132 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002133 if (func != NULL)
2134 return func;
2135 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002136 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2137 {
2138 char_u *p = name + 5;
2139 long sid;
2140
2141 // printable "<SNR>123_Name" form
2142 sid = getdigits(&p);
2143 if (*p == '_')
2144 {
2145 func = find_func_with_sid(p + 1, (int)sid);
2146 if (func != NULL)
2147 return func;
2148 }
2149 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002150 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002151
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002152 if ((flags & FFED_NO_GLOBAL) == 0)
2153 {
2154 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002155 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002156 if (!HASHITEM_EMPTY(hi))
2157 return HI2UF(hi);
2158 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002159
Bram Moolenaarb8822442022-01-11 15:24:05 +00002160 // Find autoload function if this is an autoload script.
2161 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2162 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002163}
2164
2165/*
2166 * Find a function by name, return pointer to it in ufuncs.
2167 * "cctx" is passed in a :def function to find imported functions.
2168 * Return NULL for unknown or dead function.
2169 */
2170 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002171find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002172{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002173 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002174
2175 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2176 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002177 return NULL;
2178}
2179
2180/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002181 * Return TRUE if "ufunc" is a global function.
2182 */
2183 int
2184func_is_global(ufunc_T *ufunc)
2185{
2186 return ufunc->uf_name[0] != K_SPECIAL;
2187}
2188
2189/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002190 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2191 */
2192 int
2193func_requires_g_prefix(ufunc_T *ufunc)
2194{
2195 return ufunc->uf_name[0] != K_SPECIAL
2196 && (ufunc->uf_flags & FC_LAMBDA) == 0
Bram Moolenaarcfb4d4f2022-09-30 19:19:04 +01002197 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL
2198 && !isdigit(ufunc->uf_name[0]);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002199}
2200
2201/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002202 * Copy the function name of "fp" to buffer "buf".
2203 * "buf" must be able to hold the function name plus three bytes.
2204 * Takes care of script-local function names.
2205 */
2206 static void
2207cat_func_name(char_u *buf, ufunc_T *fp)
2208{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002209 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002210 {
2211 STRCPY(buf, "<SNR>");
2212 STRCAT(buf, fp->uf_name + 3);
2213 }
2214 else
2215 STRCPY(buf, fp->uf_name);
2216}
2217
2218/*
2219 * Add a number variable "name" to dict "dp" with value "nr".
2220 */
2221 static void
2222add_nr_var(
2223 dict_T *dp,
2224 dictitem_T *v,
2225 char *name,
2226 varnumber_T nr)
2227{
2228 STRCPY(v->di_key, name);
2229 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002230 hash_add(&dp->dv_hashtab, DI2HIKEY(v), "add variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231 v->di_tv.v_type = VAR_NUMBER;
2232 v->di_tv.v_lock = VAR_FIXED;
2233 v->di_tv.vval.v_number = nr;
2234}
2235
2236/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002237 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002238 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002239 static void
2240free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002242 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002243
Bram Moolenaarca16c602022-09-06 18:57:08 +01002244 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002245 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002246 ufunc_T *fp = ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002247
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002248 // When garbage collecting a funccall_T may be freed before the
2249 // function that references it, clear its uf_scoped field.
2250 // The function may have been redefined and point to another
2251 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002252 if (fp != NULL && fp->uf_scoped == fc)
2253 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002254 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002255 ga_clear(&fc->fc_ufuncs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002256
Bram Moolenaarca16c602022-09-06 18:57:08 +01002257 func_ptr_unref(fc->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002258 vim_free(fc);
2259}
2260
2261/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002262 * Free "fc" and what it contains.
2263 * Can be called only when "fc" is kept beyond the period of it called,
2264 * i.e. after cleanup_function_call(fc).
2265 */
2266 static void
2267free_funccal_contents(funccall_T *fc)
2268{
2269 listitem_T *li;
2270
2271 // Free all l: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002272 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002273
2274 // Free all a: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002275 vars_clear(&fc->fc_l_avars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002276
2277 // Free the a:000 variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002278 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002279 clear_tv(&li->li_tv);
2280
2281 free_funccal(fc);
2282}
2283
2284/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002285 * Handle the last part of returning from a function: free the local hashtable.
2286 * Unless it is still in use by a closure.
2287 */
2288 static void
2289cleanup_function_call(funccall_T *fc)
2290{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002291 int may_free_fc = fc->fc_refcount <= 0;
2292 int free_fc = TRUE;
2293
Bram Moolenaarca16c602022-09-06 18:57:08 +01002294 current_funccal = fc->fc_caller;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002295
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002296 // Free all l: variables if not referred.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002297 if (may_free_fc && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT)
2298 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002299 else
2300 free_fc = FALSE;
2301
2302 // If the a:000 list and the l: and a: dicts are not referenced and
2303 // there is no closure using it, we can free the funccall_T and what's
2304 // in it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002305 if (may_free_fc && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)
2306 vars_clear_ext(&fc->fc_l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002307 else
2308 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002309 int todo;
2310 hashitem_T *hi;
2311 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002312
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002313 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002314
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002315 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002316 todo = (int)fc->fc_l_avars.dv_hashtab.ht_used;
2317 for (hi = fc->fc_l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002318 {
2319 if (!HASHITEM_EMPTY(hi))
2320 {
2321 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002322 di = HI2DI(hi);
2323 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002324 }
2325 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002326 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002327
Bram Moolenaarca16c602022-09-06 18:57:08 +01002328 if (may_free_fc && fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2329 fc->fc_l_varlist.lv_first = NULL;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002330 else
2331 {
2332 listitem_T *li;
2333
2334 free_fc = FALSE;
2335
2336 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002337 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002338 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002339 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002340
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002341 if (free_fc)
2342 free_funccal(fc);
2343 else
2344 {
2345 static int made_copy = 0;
2346
2347 // "fc" is still in use. This can happen when returning "a:000",
2348 // assigning "l:" to a global variable or defining a closure.
2349 // Link "fc" in the list for garbage collection later.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002350 fc->fc_caller = previous_funccal;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002351 previous_funccal = fc;
2352
2353 if (want_garbage_collect)
2354 // If garbage collector is ready, clear count.
2355 made_copy = 0;
2356 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002357 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002358 // We have made a lot of copies, worth 4 Mbyte. This can happen
2359 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002360 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002361 // too much memory.
2362 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002363 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002364 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002365 }
2366}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002367
2368/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002369 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2370 */
2371 static int
2372numbered_function(char_u *name)
2373{
2374 return isdigit(*name)
2375 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2376}
2377
2378/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002379 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002380 * 1. ordinary names, function defined with :function or :def;
2381 * can start with "<SNR>123_" literally or with K_SPECIAL.
2382 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002383 * For the first we only count the name stored in func_hashtab as a reference,
2384 * using function() does not count as a reference, because the function is
2385 * looked up by name.
2386 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002387 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002388func_name_refcount(char_u *name)
2389{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002390 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002391}
2392
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002393/*
2394 * Unreference "fc": decrement the reference count and free it when it
2395 * becomes zero. "fp" is detached from "fc".
2396 * When "force" is TRUE we are exiting.
2397 */
2398 static void
2399funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2400{
2401 funccall_T **pfc;
2402 int i;
2403
2404 if (fc == NULL)
2405 return;
2406
2407 if (--fc->fc_refcount <= 0 && (force || (
Bram Moolenaarca16c602022-09-06 18:57:08 +01002408 fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT
2409 && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT
2410 && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2411 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->fc_caller)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002412 {
2413 if (fc == *pfc)
2414 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002415 *pfc = fc->fc_caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002416 free_funccal_contents(fc);
2417 return;
2418 }
2419 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002420 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
2421 if (((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] == fp)
2422 ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002423}
2424
2425/*
2426 * Remove the function from the function hashtable. If the function was
2427 * deleted while it still has references this was already done.
2428 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2429 */
2430 static int
2431func_remove(ufunc_T *fp)
2432{
2433 hashitem_T *hi;
2434
2435 // Return if it was already virtually deleted.
2436 if (fp->uf_flags & FC_DEAD)
2437 return FALSE;
2438
2439 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00002440 if (HASHITEM_EMPTY(hi))
2441 return FALSE;
2442
2443 // When there is a def-function index do not actually remove the
2444 // function, so we can find the index when defining the function again.
2445 // Do remove it when it's a copy.
2446 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002447 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00002448 fp->uf_flags |= FC_DEAD;
2449 return FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002450 }
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00002451 hash_remove(&func_hashtab, hi, "remove function");
2452 fp->uf_flags |= FC_DELETED;
2453 return TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002454}
2455
2456 static void
2457func_clear_items(ufunc_T *fp)
2458{
2459 ga_clear_strings(&(fp->uf_args));
2460 ga_clear_strings(&(fp->uf_def_args));
2461 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002462 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002463 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002464 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002465 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002466
2467 // Increment the refcount of this function to avoid it being freed
2468 // recursively when the partial is freed.
2469 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002470 partial_unref(fp->uf_partial);
2471 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002472 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002473
2474#ifdef FEAT_LUA
2475 if (fp->uf_cb_free != NULL)
2476 {
2477 fp->uf_cb_free(fp->uf_cb_state);
2478 fp->uf_cb_free = NULL;
2479 }
2480
2481 fp->uf_cb_state = NULL;
2482 fp->uf_cb = NULL;
2483#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002484#ifdef FEAT_PROFILE
2485 VIM_CLEAR(fp->uf_tml_count);
2486 VIM_CLEAR(fp->uf_tml_total);
2487 VIM_CLEAR(fp->uf_tml_self);
2488#endif
2489}
2490
2491/*
2492 * Free all things that a function contains. Does not free the function
2493 * itself, use func_free() for that.
2494 * When "force" is TRUE we are exiting.
2495 */
2496 static void
2497func_clear(ufunc_T *fp, int force)
2498{
2499 if (fp->uf_cleared)
2500 return;
2501 fp->uf_cleared = TRUE;
2502
2503 // clear this function
2504 func_clear_items(fp);
2505 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002506 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002507}
2508
2509/*
2510 * Free a function and remove it from the list of functions. Does not free
2511 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002512 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002513 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002514 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002515 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002516func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002517{
2518 // Only remove it when not done already, otherwise we would remove a newer
2519 // version of the function with the same name.
2520 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2521 func_remove(fp);
2522
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002523 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002524 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002525 if (fp->uf_dfunc_idx > 0)
2526 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002527 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002528 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002529 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002530 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002531 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002532}
2533
2534/*
2535 * Free all things that a function contains and free the function itself.
2536 * When "force" is TRUE we are exiting.
2537 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002538 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002539func_clear_free(ufunc_T *fp, int force)
2540{
2541 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002542 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2543 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002544 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002545 else
2546 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002547}
2548
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002549/*
2550 * Copy already defined function "lambda" to a new function with name "global".
2551 * This is for when a compiled function defines a global function.
2552 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002553 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002554copy_lambda_to_global_func(
Bram Moolenaarcc341812022-09-19 15:54:34 +01002555 char_u *lambda,
2556 char_u *global,
2557 loopvarinfo_T *loopvarinfo,
2558 ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002559{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002560 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002561 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002562
2563 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002564 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002565 semsg(_(e_lambda_function_not_found_str), lambda);
2566 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002567 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002568
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002569 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002570 if (fp != NULL)
2571 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002572 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002573 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002574 return FAIL;
2575 }
2576
Bram Moolenaare01e5212023-01-08 20:31:18 +00002577 fp = alloc_ufunc(global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002578 if (fp == NULL)
2579 return FAIL;
2580
2581 fp->uf_varargs = ufunc->uf_varargs;
2582 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2583 fp->uf_def_status = ufunc->uf_def_status;
2584 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2585 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2586 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2587 == FAIL
2588 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2589 goto failed;
2590
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002591 if (ufunc->uf_arg_types != NULL)
2592 {
2593 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2594 if (fp->uf_arg_types == NULL)
2595 goto failed;
2596 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2597 sizeof(type_T *) * fp->uf_args.ga_len);
2598 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002599 if (ufunc->uf_va_name != NULL)
2600 {
2601 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2602 if (fp->uf_va_name == NULL)
2603 goto failed;
2604 }
2605 fp->uf_ret_type = ufunc->uf_ret_type;
2606
2607 fp->uf_refcount = 1;
Bram Moolenaarc8ab30a2023-01-09 11:35:47 +00002608
2609 fp->uf_name_exp = NULL;
2610 set_ufunc_name(fp, global);
2611
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002612 hash_add(&func_hashtab, UF2HIKEY(fp), "copy lambda");
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002613
2614 // the referenced dfunc_T is now used one more time
2615 link_def_function(fp);
2616
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002617 // Create a partial to store the context of the function where it was
2618 // instantiated. Only needs to be done once. Do this on the original
2619 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002620 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2621 {
2622 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2623
2624 if (pt == NULL)
2625 goto failed;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002626 if (fill_partial_and_closure(pt, ufunc, loopvarinfo, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002627 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002628 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002629 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002630 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002631 ufunc->uf_partial = pt;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002632 }
2633
2634 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002635
2636failed:
2637 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002638 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002639}
2640
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002641static int funcdepth = 0;
2642
2643/*
2644 * Increment the function call depth count.
2645 * Return FAIL when going over 'maxfuncdepth'.
2646 * Otherwise return OK, must call funcdepth_decrement() later!
2647 */
2648 int
2649funcdepth_increment(void)
2650{
2651 if (funcdepth >= p_mfd)
2652 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002653 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002654 return FAIL;
2655 }
2656 ++funcdepth;
2657 return OK;
2658}
2659
2660 void
2661funcdepth_decrement(void)
2662{
2663 --funcdepth;
2664}
2665
2666/*
2667 * Get the current function call depth.
2668 */
2669 int
2670funcdepth_get(void)
2671{
2672 return funcdepth;
2673}
2674
2675/*
2676 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002677 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002678 * times as funcdepth_increment().
2679 */
2680 void
2681funcdepth_restore(int depth)
2682{
2683 funcdepth = depth;
2684}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002685
2686/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002687 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2688 * "rettv".
2689 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2690 * Returns NULL when allocation fails.
2691 */
2692 funccall_T *
2693create_funccal(ufunc_T *fp, typval_T *rettv)
2694{
2695 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2696
2697 if (fc == NULL)
2698 return NULL;
2699 fc->fc_caller = current_funccal;
2700 current_funccal = fc;
2701 fc->fc_func = fp;
2702 func_ptr_ref(fp);
2703 fc->fc_rettv = rettv;
2704 return fc;
2705}
2706
2707/*
2708 * To be called when returning from a compiled function; restores
2709 * current_funccal.
2710 */
2711 void
2712remove_funccal()
2713{
2714 funccall_T *fc = current_funccal;
2715
2716 current_funccal = fc->fc_caller;
2717 free_funccal(fc);
2718}
2719
2720/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 * Call a user function.
2722 */
Bram Moolenaar0917e862023-02-18 14:42:44 +00002723 static funcerror_T
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002725 ufunc_T *fp, // pointer to function
2726 int argcount, // nr of args
2727 typval_T *argvars, // arguments
2728 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002729 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002730 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002732 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002733 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002734 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002735 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736 funccall_T *fc;
2737 int save_did_emsg;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002738 funcerror_T retval = FCERR_NONE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002739 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002740 dictitem_T *v;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002741 int fixvar_idx = 0; // index in fc_fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 int i;
2743 int ai;
2744 int islambda = FALSE;
2745 char_u numbuf[NUMBUFLEN];
2746 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002747 typval_T *tv_to_free[MAX_FUNC_ARGS];
2748 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002749#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002750 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002752 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753
Bram Moolenaarb2049902021-01-24 12:53:53 +01002754#ifdef FEAT_PROFILE
2755 CLEAR_FIELD(profile_info);
2756#endif
2757
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002758 // If depth of calling is getting too high, don't execute the function.
2759 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761 rettv->v_type = VAR_NUMBER;
2762 rettv->vval.v_number = -1;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002763 return FCERR_FAILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002764 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765
Bram Moolenaare38eab22019-12-05 21:50:01 +01002766 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002768 fc = create_funccal(fp, rettv);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002769 if (fc == NULL)
Bram Moolenaar0917e862023-02-18 14:42:44 +00002770 return FCERR_OTHER;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002771 fc->fc_level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002772 // Check if this function has a breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002773 fc->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2774 fc->fc_dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002775 // Set up fields for closure.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002776 ga_init2(&fc->fc_ufuncs, sizeof(ufunc_T *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002778 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002779 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002780#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01002781 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002782#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002783 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002784#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002785 if (do_profiling == PROF_YES)
2786 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002787#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002788 sticky_cmdmod_flags = 0;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002789 if (call_def_function(fp, argcount, argvars, 0,
2790 funcexe->fe_partial, funcexe->fe_object, fc, rettv) == FAIL)
2791 retval = FCERR_FAILED;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002792 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002793#ifdef FEAT_PROFILE
2794 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002795 || (caller != NULL && caller->uf_profiling)))
2796 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002797#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002798 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002799 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002800 return retval;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002801 }
2802
Bram Moolenaar38453522021-11-28 22:00:12 +00002803 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804
2805 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002806 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2807 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2808 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 */
2810 /*
2811 * Init l: variables.
2812 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002813 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 if (selfdict != NULL)
2815 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002816 // Set l:self to "selfdict". Use "name" to avoid a warning from
2817 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002818 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 name = v->di_key;
2820 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002821 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002822 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v), "set self dictionary");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002823 v->di_tv.v_type = VAR_DICT;
2824 v->di_tv.v_lock = 0;
2825 v->di_tv.vval.v_dict = selfdict;
2826 ++selfdict->dv_refcount;
2827 }
2828
2829 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002830 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002831 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 * Set a:000 to a list with room for the "..." arguments.
2833 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002834 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002835 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002836 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002837 (varnumber_T)(argcount >= fp->uf_args.ga_len
2838 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002839 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002840 if ((fp->uf_flags & FC_NOARGS) == 0)
2841 {
2842 // Use "name" to avoid a warning from some compiler that checks the
2843 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002844 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002845 name = v->di_key;
2846 STRCPY(name, "000");
2847 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002848 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v), "function argument");
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002849 v->di_tv.v_type = VAR_LIST;
2850 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002851 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002852 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002853 CLEAR_FIELD(fc->fc_l_varlist);
2854 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2855 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856
2857 /*
2858 * Set a:firstline to "firstline" and a:lastline to "lastline".
2859 * Set a:name to named arguments.
2860 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002861 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002863 if ((fp->uf_flags & FC_NOARGS) == 0)
2864 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002865 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2866 "firstline", (varnumber_T)funcexe->fe_firstline);
2867 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2868 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002869 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002870 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 {
2872 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002873 typval_T def_rettv;
2874 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875
2876 ai = i - fp->uf_args.ga_len;
2877 if (ai < 0)
2878 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002879 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880 name = FUNCARG(fp, i);
2881 if (islambda)
2882 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002883
2884 // evaluate named argument default expression
2885 isdefault = ai + fp->uf_def_args.ga_len >= 0
2886 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2887 && argvars[i].vval.v_number == VVAL_NONE));
2888 if (isdefault)
2889 {
2890 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002891
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002892 def_rettv.v_type = VAR_NUMBER;
2893 def_rettv.vval.v_number = -1;
2894
2895 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2896 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002897 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002898 {
2899 default_arg_err = 1;
2900 break;
2901 }
2902 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903 }
2904 else
2905 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002906 if ((fp->uf_flags & FC_NOARGS) != 0)
2907 // Bail out if no a: arguments used (in lambda).
2908 break;
2909
Bram Moolenaare38eab22019-12-05 21:50:01 +01002910 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 sprintf((char *)numbuf, "%d", ai + 1);
2912 name = numbuf;
2913 }
2914 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2915 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002916 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002918 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002919 }
2920 else
2921 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002922 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923 if (v == NULL)
2924 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002925 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002926 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002928 // Note: the values are copied directly to avoid alloc/free.
2929 // "argvars" must have VAR_FIXED for v_lock.
2930 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002931 v->di_tv.v_lock = VAR_FIXED;
2932
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002933 if (isdefault)
2934 // Need to free this later, no matter where it's stored.
2935 tv_to_free[tv_to_free_len++] = &v->di_tv;
2936
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002937 if (addlocal)
2938 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002939 // Named arguments should be accessed without the "a:" prefix in
2940 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002941 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002942 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v), "local variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002943 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002944 else
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002945 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v), "add variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946
2947 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2948 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002949 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002950
2951 li->li_tv = argvars[i];
2952 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002953 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954 }
2955 }
2956
Bram Moolenaare38eab22019-12-05 21:50:01 +01002957 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002958 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002959
2960 if (fp->uf_flags & FC_SANDBOX)
2961 {
2962 using_sandbox = TRUE;
2963 ++sandbox;
2964 }
2965
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002966 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002967 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002968 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002970 ++no_wait_return;
2971 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002973 smsg(_("calling %s"), SOURCING_NAME);
2974 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002975 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002976 char_u buf[MSG_BUF_LEN];
2977 char_u numbuf2[NUMBUFLEN];
2978 char_u *tofree;
2979 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002981 msg_puts("(");
2982 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002983 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002984 if (i > 0)
2985 msg_puts(", ");
2986 if (argvars[i].v_type == VAR_NUMBER)
2987 msg_outnum((long)argvars[i].vval.v_number);
2988 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002989 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002990 // Do not want errors such as E724 here.
2991 ++emsg_off;
2992 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2993 --emsg_off;
2994 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002996 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002997 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002998 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2999 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003001 msg_puts((char *)s);
3002 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 }
3004 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003006 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003008 msg_puts("\n"); // don't overwrite this either
3009
3010 verbose_leave_scroll();
3011 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 }
3013#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01003014 if (do_profiling == PROF_YES)
3015 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01003016 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017#endif
3018
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003019 // "legacy" does not apply to commands in the function
3020 sticky_cmdmod_flags = 0;
3021
Bram Moolenaar98aff652022-09-06 21:02:35 +01003022 // If called from a compiled :def function the execution context must be
3023 // hidden, any deferred functions need to be added to the function being
3024 // executed here.
dundargocc57b5bc2022-11-02 13:30:51 +00003025 save_current_ectx = clear_current_ectx();
Bram Moolenaar98aff652022-09-06 21:02:35 +01003026
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003027 save_current_sctx = current_sctx;
3028 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 save_did_emsg = did_emsg;
3030 did_emsg = FALSE;
3031
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003032 if (default_arg_err && (fp->uf_flags & FC_ABORT))
Bram Moolenaar0917e862023-02-18 14:42:44 +00003033 {
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003034 did_emsg = TRUE;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003035 retval = FCERR_FAILED;
3036 }
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003037 else if (islambda)
3038 {
3039 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
3040
3041 // A Lambda always has the command "return {expr}". It is much faster
3042 // to evaluate {expr} directly.
3043 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003044 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003045 --ex_nesting_level;
3046 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003047 else
3048 // call do_cmdline() to execute the lines
3049 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003050 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
3051
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003052 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01003053 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003054
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055 --RedrawingDisabled;
3056
Bram Moolenaare38eab22019-12-05 21:50:01 +01003057 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003058 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
3059 {
3060 clear_tv(rettv);
3061 rettv->v_type = VAR_NUMBER;
3062 rettv->vval.v_number = -1;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003063 retval = FCERR_FAILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003064 }
3065
3066#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01003067 if (do_profiling == PROF_YES)
3068 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003069 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01003070
3071 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
3072 profile_may_end_func(&profile_info, fp, caller);
3073 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003074#endif
3075
Bram Moolenaare38eab22019-12-05 21:50:01 +01003076 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077 if (p_verbose >= 12)
3078 {
3079 ++no_wait_return;
3080 verbose_enter_scroll();
3081
3082 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003083 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaarca16c602022-09-06 18:57:08 +01003084 else if (fc->fc_rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003085 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaarca16c602022-09-06 18:57:08 +01003086 (long)fc->fc_rettv->vval.v_number);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 else
3088 {
3089 char_u buf[MSG_BUF_LEN];
3090 char_u numbuf2[NUMBUFLEN];
3091 char_u *tofree;
3092 char_u *s;
3093
Bram Moolenaare38eab22019-12-05 21:50:01 +01003094 // The value may be very long. Skip the middle part, so that we
3095 // have some idea how it starts and ends. smsg() would always
3096 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003097 ++emsg_off;
Bram Moolenaarca16c602022-09-06 18:57:08 +01003098 s = tv2string(fc->fc_rettv, &tofree, numbuf2, 0);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 --emsg_off;
3100 if (s != NULL)
3101 {
3102 if (vim_strsize(s) > MSG_BUF_CLEN)
3103 {
3104 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
3105 s = buf;
3106 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003107 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 vim_free(tofree);
3109 }
3110 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003111 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112
3113 verbose_leave_scroll();
3114 --no_wait_return;
3115 }
3116
Bram Moolenaare31ee862020-01-07 20:59:34 +01003117 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003118 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003119 current_sctx = save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01003120 restore_current_ectx(save_current_ectx);
3121
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122#ifdef FEAT_PROFILE
3123 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003124 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02003126 if (using_sandbox)
3127 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003128 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003130 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 {
3132 ++no_wait_return;
3133 verbose_enter_scroll();
3134
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003135 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003136 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003137
3138 verbose_leave_scroll();
3139 --no_wait_return;
3140 }
3141
3142 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01003143 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02003144 for (i = 0; i < tv_to_free_len; ++i)
3145 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003146 cleanup_function_call(fc);
Bram Moolenaar0917e862023-02-18 14:42:44 +00003147
3148 return retval;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003149}
3150
3151/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003152 * Check the argument count for user function "fp".
3153 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3154 */
Bram Moolenaar0917e862023-02-18 14:42:44 +00003155 funcerror_T
Bram Moolenaar50824712020-12-20 21:10:17 +01003156check_user_func_argcount(ufunc_T *fp, int argcount)
3157{
3158 int regular_args = fp->uf_args.ga_len;
3159
3160 if (argcount < regular_args - fp->uf_def_args.ga_len)
3161 return FCERR_TOOFEW;
3162 else if (!has_varargs(fp) && argcount > regular_args)
3163 return FCERR_TOOMANY;
3164 return FCERR_UNKNOWN;
3165}
3166
3167/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003168 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003169 */
Bram Moolenaar0917e862023-02-18 14:42:44 +00003170 funcerror_T
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003171call_user_func_check(
3172 ufunc_T *fp,
3173 int argcount,
3174 typval_T *argvars,
3175 typval_T *rettv,
3176 funcexe_T *funcexe,
3177 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003178{
Bram Moolenaar0917e862023-02-18 14:42:44 +00003179 funcerror_T error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003180
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003181#ifdef FEAT_LUA
3182 if (fp->uf_flags & FC_CFUNC)
3183 {
3184 cfunc_T cb = fp->uf_cb;
3185
3186 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3187 }
3188#endif
3189
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003190 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3191 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003192 error = check_user_func_argcount(fp, argcount);
3193 if (error != FCERR_UNKNOWN)
3194 return error;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003195
Bram Moolenaar50824712020-12-20 21:10:17 +01003196 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar0917e862023-02-18 14:42:44 +00003197 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003198 error = FCERR_DICT;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003199 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003200 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003201 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 int did_save_redo = FALSE;
3203 save_redo_T save_redo;
3204
3205 /*
3206 * Call the user function.
3207 * Save and restore search patterns, script variables and
3208 * redo buffer.
3209 */
3210 save_search_patterns();
3211 if (!ins_compl_active())
3212 {
3213 saveRedobuff(&save_redo);
3214 did_save_redo = TRUE;
3215 }
3216 ++fp->uf_calls;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003217 error = call_user_func(fp, argcount, argvars, rettv, funcexe,
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003218 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003219 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3220 // Function was unreferenced while being used, free it now.
3221 func_clear_free(fp, FALSE);
3222 if (did_save_redo)
3223 restoreRedobuff(&save_redo);
3224 restore_search_patterns();
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003225 }
Bram Moolenaar0917e862023-02-18 14:42:44 +00003226
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003227 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003228}
3229
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003230static funccal_entry_T *funccal_stack = NULL;
3231
3232/*
3233 * Save the current function call pointer, and set it to NULL.
3234 * Used when executing autocommands and for ":source".
3235 */
3236 void
3237save_funccal(funccal_entry_T *entry)
3238{
3239 entry->top_funccal = current_funccal;
3240 entry->next = funccal_stack;
3241 funccal_stack = entry;
3242 current_funccal = NULL;
3243}
3244
3245 void
3246restore_funccal(void)
3247{
3248 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003249 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003250 else
3251 {
3252 current_funccal = funccal_stack->top_funccal;
3253 funccal_stack = funccal_stack->next;
3254 }
3255}
3256
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003257 funccall_T *
3258get_current_funccal(void)
3259{
3260 return current_funccal;
3261}
3262
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003263/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003264 * Return TRUE when currently at the script level:
3265 * - not in a function
3266 * - not executing an autocommand
3267 * Note that when an autocommand sources a script the result is FALSE;
3268 */
3269 int
3270at_script_level(void)
3271{
3272 return current_funccal == NULL && autocmd_match == NULL;
3273}
3274
3275/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003276 * Mark all functions of script "sid" as deleted.
3277 */
3278 void
3279delete_script_functions(int sid)
3280{
3281 hashitem_T *hi;
3282 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003283 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003284 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003285 size_t len;
3286
3287 buf[0] = K_SPECIAL;
3288 buf[1] = KS_EXTRA;
3289 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003290 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003291 len = STRLEN(buf);
3292
Bram Moolenaarce658352020-07-31 23:47:12 +02003293 while (todo > 0)
3294 {
3295 todo = func_hashtab.ht_used;
3296 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3297 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003298 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003299 fp = HI2UF(hi);
3300 if (STRNCMP(fp->uf_name, buf, len) == 0)
3301 {
3302 int changed = func_hashtab.ht_changed;
3303
3304 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003305
3306 if (fp->uf_calls > 0)
3307 {
3308 // Function is executing, don't free it but do remove
3309 // it from the hashtable.
3310 if (func_remove(fp))
3311 fp->uf_refcount--;
3312 }
3313 else
3314 {
3315 func_clear(fp, TRUE);
3316 // When clearing a function another function can be
3317 // cleared as a side effect. When that happens start
3318 // over.
3319 if (changed != func_hashtab.ht_changed)
3320 break;
3321 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003322 }
3323 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003324 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003325 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003326}
3327
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003328#if defined(EXITFREE) || defined(PROTO)
3329 void
3330free_all_functions(void)
3331{
3332 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003333 ufunc_T *fp;
3334 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003335 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003336 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337
Bram Moolenaare38eab22019-12-05 21:50:01 +01003338 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003339 while (current_funccal != NULL)
3340 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003341 clear_tv(current_funccal->fc_rettv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003342 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003343 if (current_funccal == NULL && funccal_stack != NULL)
3344 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003345 }
3346
Bram Moolenaare38eab22019-12-05 21:50:01 +01003347 // First clear what the functions contain. Since this may lower the
3348 // reference count of a function, it may also free a function and change
3349 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003350 while (todo > 0)
3351 {
3352 todo = func_hashtab.ht_used;
3353 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3354 if (!HASHITEM_EMPTY(hi))
3355 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003356 // clear the def function index now
3357 fp = HI2UF(hi);
3358 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003359 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003360
Bram Moolenaare38eab22019-12-05 21:50:01 +01003361 // Only free functions that are not refcounted, those are
3362 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003363 if (func_name_refcount(fp->uf_name))
3364 ++skipped;
3365 else
3366 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003367 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003368 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003369 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003370 {
3371 skipped = 0;
3372 break;
3373 }
3374 }
3375 --todo;
3376 }
3377 }
3378
Bram Moolenaare38eab22019-12-05 21:50:01 +01003379 // Now actually free the functions. Need to start all over every time,
3380 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003381 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003382 while (func_hashtab.ht_used > skipped)
3383 {
3384 todo = func_hashtab.ht_used;
3385 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 if (!HASHITEM_EMPTY(hi))
3387 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003388 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003389 // Only free functions that are not refcounted, those are
3390 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003391 fp = HI2UF(hi);
3392 if (func_name_refcount(fp->uf_name))
3393 ++skipped;
3394 else
3395 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003396 if (func_free(fp, FALSE) == OK)
3397 {
3398 skipped = 0;
3399 break;
3400 }
3401 // did not actually free it
3402 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003403 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003405 }
3406 if (skipped == 0)
3407 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408
3409 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003410}
3411#endif
3412
3413/*
3414 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003415 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3416 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 * "len" is the length of "name", or -1 for NUL terminated.
3418 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003419 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420builtin_function(char_u *name, int len)
3421{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003422 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423
Bram Moolenaara26b9702020-04-18 19:53:28 +02003424 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003426 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3427 {
3428 if (name[i] == AUTOLOAD_CHAR)
3429 return FALSE;
3430 if (!eval_isnamec(name[i]))
3431 {
3432 // "name.something" is not a builtin function
3433 if (name[i] == '.')
3434 return FALSE;
3435 break;
3436 }
3437 }
3438 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439}
3440
3441 int
3442func_call(
3443 char_u *name,
3444 typval_T *args,
3445 partial_T *partial,
3446 dict_T *selfdict,
3447 typval_T *rettv)
3448{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003449 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 listitem_T *item;
3451 typval_T argv[MAX_FUNC_ARGS + 1];
3452 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453 int r = 0;
3454
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003455 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003456 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 {
3458 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3459 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003460 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 break;
3462 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003463 // Make a copy of each argument. This is needed to be able to set
3464 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003465 copy_tv(&item->li_tv, &argv[argc++]);
3466 }
3467
3468 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003469 {
3470 funcexe_T funcexe;
3471
Bram Moolenaara80faa82020-04-12 19:37:17 +02003472 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003473 funcexe.fe_firstline = curwin->w_cursor.lnum;
3474 funcexe.fe_lastline = curwin->w_cursor.lnum;
3475 funcexe.fe_evaluate = TRUE;
3476 funcexe.fe_partial = partial;
3477 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003478 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3479 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480
Bram Moolenaare38eab22019-12-05 21:50:01 +01003481 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 while (argc > 0)
3483 clear_tv(&argv[--argc]);
3484
3485 return r;
3486}
3487
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003488static int callback_depth = 0;
3489
3490 int
3491get_callback_depth(void)
3492{
3493 return callback_depth;
3494}
3495
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003497 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003498 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003499 */
3500 int
3501call_callback(
3502 callback_T *callback,
3503 int len, // length of "name" or -1 to use strlen()
3504 typval_T *rettv, // return value goes here
3505 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003506 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003507 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003508{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003509 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003510 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003511
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003512 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3513 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003514 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003515 funcexe.fe_evaluate = TRUE;
3516 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003517 ++callback_depth;
3518 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3519 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003520
3521 // When a :def function was called that uses :try an error would be turned
3522 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003523 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003524 {
3525 need_rethrow = FALSE;
3526 handle_did_throw();
3527 }
3528
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003529 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003530}
3531
3532/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003533 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003534 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003535 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3536 */
3537 varnumber_T
3538call_callback_retnr(
3539 callback_T *callback,
3540 int argcount, // number of "argvars"
3541 typval_T *argvars) // vars for arguments, must have "argcount"
3542 // PLUS ONE elements!
3543{
3544 typval_T rettv;
3545 varnumber_T retval;
3546
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003547 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003548 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003549
3550 retval = tv_get_number_chk(&rettv, NULL);
3551 clear_tv(&rettv);
3552 return retval;
3553}
3554
3555/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003556 * Give an error message for the result of a function.
3557 * Nothing if "error" is FCERR_NONE.
3558 */
3559 void
Bram Moolenaar0917e862023-02-18 14:42:44 +00003560user_func_error(funcerror_T error, char_u *name, int found_var)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003561{
3562 switch (error)
3563 {
3564 case FCERR_UNKNOWN:
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003565 if (found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003566 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003567 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003568 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003569 break;
3570 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003571 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003572 break;
3573 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003574 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003575 break;
3576 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003577 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003578 break;
3579 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003580 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003581 break;
3582 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003583 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003584 break;
3585 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003586 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3587 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003588 break;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003589 case FCERR_OTHER:
3590 case FCERR_FAILED:
3591 // assume the error message was already given
3592 break;
3593 case FCERR_NONE:
3594 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003595 }
3596}
3597
3598/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003600 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601 * Return FAIL when the function can't be called, OK otherwise.
3602 * Also returns OK when an error was encountered while executing the function.
3603 */
3604 int
3605call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003606 char_u *funcname, // name of the function
3607 int len, // length of "name" or -1 to use strlen()
3608 typval_T *rettv, // return value goes here
3609 int argcount_in, // number of "argvars"
3610 typval_T *argvars_in, // vars for arguments, must have "argcount"
3611 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003612 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003613{
3614 int ret = FAIL;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003615 funcerror_T error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003617 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 char_u fname_buf[FLEN_FIXED + 1];
3619 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003620 char_u *fname = NULL;
3621 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 int argcount = argcount_in;
3623 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003624 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003625 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003626 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003628 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003629 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003630 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003631 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003632
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003633 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3634 // even when call_func() returns FAIL.
3635 rettv->v_type = VAR_UNKNOWN;
3636
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003637 if (partial != NULL)
3638 fp = partial->pt_func;
3639 if (fp == NULL)
3640 {
3641 // Make a copy of the name, if it comes from a funcref variable it
3642 // could be changed or deleted in the called function.
3643 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3644 if (name == NULL)
3645 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003647 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3648 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003650 if (funcexe->fe_doesrange != NULL)
3651 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652
3653 if (partial != NULL)
3654 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003655 // When the function has a partial with a dict and there is a dict
3656 // argument, use the dict argument. That is backwards compatible.
3657 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003658 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003660 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 {
3662 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003663 {
3664 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3665 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003666 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003667 goto theend;
3668 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003670 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 for (i = 0; i < argcount_in; ++i)
3672 argv[i + argv_clear] = argvars_in[i];
3673 argvars = argv;
3674 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003675
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003676 if (funcexe->fe_check_type != NULL
3677 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003678 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003679 // Now funcexe->fe_check_type is missing the added arguments,
3680 // make a copy of the type with the correction.
3681 check_type = *funcexe->fe_check_type;
3682 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003683 check_type.tt_args = check_type_args;
3684 CLEAR_FIELD(check_type_args);
3685 for (i = 0; i < check_type.tt_argcount; ++i)
3686 check_type_args[i + partial->pt_argc] =
3687 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003688 check_type.tt_argcount += partial->pt_argc;
3689 check_type.tt_min_argcount += partial->pt_argc;
3690 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003691 }
3692 }
3693
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003694 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3695 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003696 {
3697 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003698 if (check_argument_types(funcexe->fe_check_type,
3699 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003700 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003701 error = FCERR_OTHER;
3702 }
3703
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003704 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705 {
3706 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003707 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708
Bram Moolenaar333894b2020-08-01 18:53:07 +02003709 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003710 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003711 {
3712 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003714 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715
Bram Moolenaare38eab22019-12-05 21:50:01 +01003716 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003718 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003720 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 {
3722 /*
3723 * User defined function.
3724 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003725 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003726 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003727 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003728 if (fp != NULL && !is_global && in_vim9script()
3729 && func_requires_g_prefix(fp))
3730 // In Vim9 script g: is required to find a global
3731 // non-autoload function.
3732 fp = NULL;
3733 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734
Bram Moolenaare38eab22019-12-05 21:50:01 +01003735 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003736 if (fp == NULL
3737 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003738 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 && !aborting())
3740 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003741 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003742 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003744 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003745 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3746 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003747 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003748 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003750 if (fp == NULL)
3751 {
3752 char_u *p = untrans_function_name(rfname);
3753
3754 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003755 // Don't do this if the name starts with "s:".
3756 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003757 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003758 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003760 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003761 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003762 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003763 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003764 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003765 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003766 argcount = funcexe->fe_argv_func(argcount, argvars,
zeertzjq48db5da2022-09-16 12:10:03 +01003767 argv_clear, fp);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003768
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003769 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003770 {
3771 // Method call: base->Method()
3772 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003773 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003774 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003775 argvars = argv;
3776 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003777 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003778
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003779 error = call_user_func_check(fp, argcount, argvars, rettv,
3780 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 }
3782 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003783 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003784 {
3785 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003786 * expr->method(): Find the method name in the table, call its
3787 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003788 */
3789 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003790 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003791 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 else
3793 {
3794 /*
3795 * Find the function name in the table, call its implementation.
3796 */
3797 error = call_internal_func(fname, argcount, argvars, rettv);
3798 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003799
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 /*
3801 * The function call (or "FuncUndefined" autocommand sequence) might
3802 * have been aborted by an error, an interrupt, or an explicitly thrown
3803 * exception that has not been caught so far. This situation can be
3804 * tested for by calling aborting(). For an error in an internal
3805 * function or for the "E132" error in call_user_func(), however, the
3806 * throw point at which the "force_abort" flag (temporarily reset by
3807 * emsg()) is normally updated has not been reached yet. We need to
3808 * update that flag first to make aborting() reliable.
3809 */
3810 update_force_abort();
3811 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003812 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813 ret = OK;
3814
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003815theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 /*
3817 * Report an error unless the argument evaluation or function call has been
3818 * cancelled due to an aborting error, an interrupt, or an exception.
3819 */
3820 if (!aborting())
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003821 user_func_error(error, (name != NULL) ? name : funcname,
3822 funcexe->fe_found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003824 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003826 clear_tv(&argv[--argv_clear + argv_base]);
3827
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 vim_free(tofree);
3829 vim_free(name);
3830
3831 return ret;
3832}
3833
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003834/*
3835 * Call a function without arguments, partial or dict.
3836 * This is like call_func() when the call is only "FuncName()".
3837 * To be used by "expr" options.
3838 * Returns NOTDONE when the function could not be found.
3839 */
3840 int
3841call_simple_func(
3842 char_u *funcname, // name of the function
3843 int len, // length of "name" or -1 to use strlen()
3844 typval_T *rettv) // return value goes here
3845{
3846 int ret = FAIL;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003847 funcerror_T error = FCERR_NONE;
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003848 char_u fname_buf[FLEN_FIXED + 1];
3849 char_u *tofree = NULL;
3850 char_u *name;
3851 char_u *fname;
3852 char_u *rfname;
3853 int is_global = FALSE;
3854 ufunc_T *fp;
3855
3856 rettv->v_type = VAR_NUMBER; // default rettv is number zero
3857 rettv->vval.v_number = 0;
3858
3859 // Make a copy of the name, an option can be changed in the function.
3860 name = vim_strnsave(funcname, len);
3861 if (name == NULL)
3862 return ret;
3863
3864 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3865
3866 // Skip "g:" before a function name.
3867 if (fname[0] == 'g' && fname[1] == ':')
3868 {
3869 is_global = TRUE;
3870 rfname = fname + 2;
3871 }
3872 else
3873 rfname = fname;
3874 fp = find_func(rfname, is_global);
3875 if (fp != NULL && !is_global && in_vim9script()
3876 && func_requires_g_prefix(fp))
3877 // In Vim9 script g: is required to find a global non-autoload
3878 // function.
3879 fp = NULL;
3880 if (fp == NULL)
3881 ret = NOTDONE;
3882 else if (fp != NULL && (fp->uf_flags & FC_DELETED))
3883 error = FCERR_DELETED;
3884 else if (fp != NULL)
3885 {
3886 typval_T argvars[1];
3887 funcexe_T funcexe;
3888
3889 argvars[0].v_type = VAR_UNKNOWN;
3890 CLEAR_FIELD(funcexe);
3891 funcexe.fe_evaluate = TRUE;
3892
3893 error = call_user_func_check(fp, 0, argvars, rettv, &funcexe, NULL);
3894 if (error == FCERR_NONE)
3895 ret = OK;
3896 }
3897
3898 user_func_error(error, name, FALSE);
3899 vim_free(tofree);
3900 vim_free(name);
3901
3902 return ret;
3903}
3904
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003905 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003906printable_func_name(ufunc_T *fp)
3907{
3908 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3909}
3910
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911/*
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003912 * When "prev_ht_changed" does not equal "ht_changed" give an error and return
3913 * TRUE. Otherwise return FALSE.
3914 */
3915 static int
3916function_list_modified(int prev_ht_changed)
3917{
3918 if (prev_ht_changed != func_hashtab.ht_changed)
3919 {
3920 emsg(_(e_function_list_was_modified));
3921 return TRUE;
3922 }
3923 return FALSE;
3924}
3925
3926/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003927 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003928 */
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003929 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930list_func_head(ufunc_T *fp, int indent)
3931{
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003932 int prev_ht_changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 int j;
3934
3935 msg_start();
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003936
3937 // a timer at the more prompt may have deleted the function
3938 if (function_list_modified(prev_ht_changed))
3939 return FAIL;
3940
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003942 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003943 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003944 msg_puts("def ");
3945 else
3946 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003947 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 msg_putchar('(');
3949 for (j = 0; j < fp->uf_args.ga_len; ++j)
3950 {
3951 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003952 msg_puts(", ");
3953 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003954 if (fp->uf_arg_types != NULL)
3955 {
3956 char *tofree;
3957
3958 msg_puts(": ");
3959 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3960 vim_free(tofree);
3961 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003962 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3963 {
3964 msg_puts(" = ");
3965 msg_puts(((char **)(fp->uf_def_args.ga_data))
3966 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3967 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 }
3969 if (fp->uf_varargs)
3970 {
3971 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003972 msg_puts(", ");
3973 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003974 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003975 if (fp->uf_va_name != NULL)
3976 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003977 if (!fp->uf_varargs)
3978 {
3979 if (j)
3980 msg_puts(", ");
3981 msg_puts("...");
3982 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003983 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003984 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003985 {
3986 char *tofree;
3987
3988 msg_puts(": ");
3989 msg_puts(type_name(fp->uf_va_type, &tofree));
3990 vim_free(tofree);
3991 }
3992 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003994
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003995 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003996 {
3997 if (fp->uf_ret_type != &t_void)
3998 {
3999 char *tofree;
4000
4001 msg_puts(": ");
4002 msg_puts(type_name(fp->uf_ret_type, &tofree));
4003 vim_free(tofree);
4004 }
4005 }
4006 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004007 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004009 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004011 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004012 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004013 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 msg_clr_eos();
4015 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004016 last_set_msg(fp->uf_script_ctx);
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004017
4018 return OK;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004019}
4020
4021/*
4022 * Get a function name, translating "<SID>" and "<SNR>".
4023 * Also handles a Funcref in a List or Dictionary.
4024 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004025 * Set "*is_global" to TRUE when the function must be global, unless
4026 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027 * flags:
4028 * TFN_INT: internal function name OK
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004029 * TFN_IN_CLASS: function in a class
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030 * TFN_QUIET: be quiet
4031 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004032 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 * Advances "pp" to just after the function name (if no error).
4034 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004035 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036trans_function_name(
4037 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004038 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01004039 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01004041 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004042 partial_T **partial, // return: partial of a FuncRef
4043 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044{
4045 char_u *name = NULL;
4046 char_u *start;
4047 char_u *end;
4048 int lead;
4049 char_u sid_buf[20];
4050 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004051 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004052 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004054 int vim9script = in_vim9script();
4055 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056
4057 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02004058 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 start = *pp;
4060
Bram Moolenaare38eab22019-12-05 21:50:01 +01004061 // Check for hard coded <SNR>: already translated function ID (from a user
4062 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
4064 && (*pp)[2] == (int)KE_SNR)
4065 {
4066 *pp += 3;
4067 len = get_id_len(pp) + 3;
4068 return vim_strnsave(start, len);
4069 }
4070
Bram Moolenaare38eab22019-12-05 21:50:01 +01004071 // A name starting with "<SID>" or "<SNR>" is local to a script. But
4072 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 lead = eval_fname_script(start);
4074 if (lead > 2)
4075 start += lead;
4076
Bram Moolenaare38eab22019-12-05 21:50:01 +01004077 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01004078 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004080 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00004081 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082 {
4083 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004084 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085 goto theend;
4086 }
4087 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
4088 {
4089 /*
4090 * Report an invalid expression in braces, unless the expression
4091 * evaluation has been cancelled due to an aborting error, an
4092 * interrupt, or an exception.
4093 */
4094 if (!aborting())
4095 {
4096 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004097 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098 }
4099 else
4100 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
4101 goto theend;
4102 }
4103
4104 if (lv.ll_tv != NULL)
4105 {
4106 if (fdp != NULL)
4107 {
4108 fdp->fd_dict = lv.ll_dict;
4109 fdp->fd_newkey = lv.ll_newkey;
4110 lv.ll_newkey = NULL;
4111 fdp->fd_di = lv.ll_di;
4112 }
4113 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
4114 {
4115 name = vim_strsave(lv.ll_tv->vval.v_string);
4116 *pp = end;
4117 }
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004118 else if (lv.ll_tv->v_type == VAR_CLASS
4119 && lv.ll_tv->vval.v_class != NULL)
4120 {
4121 name = vim_strsave(lv.ll_tv->vval.v_class->class_name);
4122 *pp = end;
4123 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 else if (lv.ll_tv->v_type == VAR_PARTIAL
4125 && lv.ll_tv->vval.v_partial != NULL)
4126 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004127 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128 *pp = end;
4129 if (partial != NULL)
4130 *partial = lv.ll_tv->vval.v_partial;
4131 }
4132 else
4133 {
4134 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
4135 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00004136 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004137 else
4138 *pp = end;
4139 name = NULL;
4140 }
4141 goto theend;
4142 }
4143
4144 if (lv.ll_name == NULL)
4145 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004146 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004147 *pp = end;
4148 goto theend;
4149 }
4150
Bram Moolenaare38eab22019-12-05 21:50:01 +01004151 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004152 if (lv.ll_exp_name != NULL)
4153 {
4154 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004155 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004156 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004157 if (name == lv.ll_exp_name)
4158 name = NULL;
4159 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004160 else if (lv.ll_sid > 0)
4161 {
4162 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
4163 int cc = *lv.ll_name_end;
4164
4165 // function in another script. Prefix <SNR>99_ or the autoload prefix.
4166 *lv.ll_name_end = NUL;
4167 if (si->sn_autoload_prefix != NULL)
4168 {
4169 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
4170 }
4171 else
4172 {
4173 sid_buf[0] = K_SPECIAL;
4174 sid_buf[1] = KS_EXTRA;
4175 sid_buf[2] = (int)KE_SNR;
4176 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00004177 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004178 name = concat_str(sid_buf, lv.ll_name);
4179 }
4180 *lv.ll_name_end = cc;
4181 *pp = end;
4182 goto theend;
4183 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004184 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 {
4186 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004187 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004188 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 if (name == *pp)
4190 name = NULL;
4191 }
4192 if (name != NULL)
4193 {
4194 name = vim_strsave(name);
4195 *pp = end;
4196 if (STRNCMP(name, "<SNR>", 5) == 0)
4197 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004198 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199 name[0] = K_SPECIAL;
4200 name[1] = KS_EXTRA;
4201 name[2] = (int)KE_SNR;
4202 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
4203 }
4204 goto theend;
4205 }
4206
4207 if (lv.ll_exp_name != NULL)
4208 {
4209 len = (int)STRLEN(lv.ll_exp_name);
4210 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
4211 && STRNCMP(lv.ll_name, "s:", 2) == 0)
4212 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004213 // When there was "s:" already or the name expanded to get a
4214 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004215 lv.ll_name += 2;
4216 len -= 2;
4217 lead = 2;
4218 }
4219 }
4220 else
4221 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004222 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004223 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004224 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004225 if (lv.ll_name[0] == 'g')
4226 {
4227 if (is_global != NULL)
4228 {
4229 *is_global = TRUE;
4230 }
4231 else
4232 {
4233 // dropping "g:" without setting "is_global" won't work in
4234 // Vim9script, put it back later
4235 prefix_g = TRUE;
4236 extra = 2;
4237 }
4238 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004240 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 len = (int)(end - lv.ll_name);
4242 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004243 if (len <= 0)
4244 {
4245 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004246 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004247 goto theend;
4248 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004249
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004250 // In Vim9 script a user function is script-local by default, unless it
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004251 // starts with a lower case character: dict.func(). Or when in a class.
4252 vim9_local = ASCII_ISUPPER(*start) && vim9script
4253 && (flags & TFN_IN_CLASS) == 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004254
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004255 /*
4256 * Copy the function name to allocated memory.
4257 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4258 * Accept <SNR>123_name() outside a script.
4259 */
4260 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004261 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004262 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004264 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004265 {
Kota Kato948a3892022-08-16 16:09:59 +01004266 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4267 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004268 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004269 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004270 goto theend;
4271 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004272 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004273 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004274 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004275 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276 || eval_fname_sid(*pp))
4277 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004278 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004279 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004281 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 goto theend;
4283 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004284 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004285 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004286 extra = 3 + (int)STRLEN(sid_buf);
4287 else
4288 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 }
4290 }
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004291 else if (!(flags & TFN_INT)
4292 && (builtin_function(lv.ll_name, len)
4293 || (vim9script && *lv.ll_name == '_'))
4294 && !((flags & TFN_IN_CLASS) && STRNCMP(lv.ll_name, "new", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004295 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004296 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004297 : e_function_name_must_start_with_capital_or_s_str),
4298 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 goto theend;
4300 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004301 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004302 {
4303 char_u *cp = vim_strchr(lv.ll_name, ':');
4304
4305 if (cp != NULL && cp < end)
4306 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004307 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 goto theend;
4309 }
4310 }
4311
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004312 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313 if (name != NULL)
4314 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004315 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004316 {
4317 name[0] = K_SPECIAL;
4318 name[1] = KS_EXTRA;
4319 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004320 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321 STRCPY(name + 3, sid_buf);
4322 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004323 else if (prefix_g)
4324 {
4325 name[0] = 'g';
4326 name[1] = ':';
4327 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004328 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4329 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004330 }
4331 *pp = end;
4332
4333theend:
4334 clear_lval(&lv);
4335 return name;
4336}
4337
4338/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004339 * Assuming "name" is the result of trans_function_name() and it was prefixed
4340 * to use the script-local name, return the unmodified name (points into
4341 * "name"). Otherwise return NULL.
4342 * This can be used to first search for a script-local function and fall back
4343 * to the global function if not found.
4344 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004345 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004346untrans_function_name(char_u *name)
4347{
4348 char_u *p;
4349
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004350 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004351 {
4352 p = vim_strchr(name, '_');
4353 if (p != NULL)
4354 return p + 1;
4355 }
4356 return NULL;
4357}
4358
4359/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004360 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4361 * current script ID and returns the expanded function name. The caller should
4362 * free the returned name. If not called from a script context or the function
4363 * name doesn't start with these prefixes, then returns NULL.
4364 * This doesn't check whether the script-local function exists or not.
4365 */
4366 char_u *
4367get_scriptlocal_funcname(char_u *funcname)
4368{
4369 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004370 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004371 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004372 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004373
4374 if (funcname == NULL)
4375 return NULL;
4376
4377 if (STRNCMP(funcname, "s:", 2) != 0
4378 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004379 {
4380 ufunc_T *ufunc;
4381
4382 // The function name does not have a script-local prefix. Try finding
4383 // it when in a Vim9 script and there is no "g:" prefix.
4384 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4385 return NULL;
4386 ufunc = find_func(funcname, FALSE);
4387 if (ufunc == NULL || func_is_global(ufunc)
4388 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4389 return NULL;
4390 ++p;
4391 off = 0;
4392 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004393 else
4394 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004395
4396 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4397 {
4398 emsg(_(e_using_sid_not_in_script_context));
4399 return NULL;
4400 }
4401 // Expand s: prefix into <SNR>nr_<name>
4402 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4403 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004404 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004405 if (newname == NULL)
4406 return NULL;
4407 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004408 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004409
4410 return newname;
4411}
4412
4413/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004414 * Return script-local "fname" with the 3-byte sequence replaced by
4415 * printable <SNR> in allocated memory.
4416 */
4417 char_u *
4418alloc_printable_func_name(char_u *fname)
4419{
4420 char_u *n = alloc(STRLEN(fname + 3) + 6);
4421
4422 if (n != NULL)
4423 {
4424 STRCPY(n, "<SNR>");
4425 STRCPY(n + 5, fname + 3);
4426 }
4427 return n;
4428}
4429
4430/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004431 * Call trans_function_name(), except that a lambda is returned as-is.
4432 * Returns the name in allocated memory.
4433 */
4434 char_u *
4435save_function_name(
4436 char_u **name,
4437 int *is_global,
4438 int skip,
4439 int flags,
4440 funcdict_T *fudi)
4441{
4442 char_u *p = *name;
4443 char_u *saved;
4444
4445 if (STRNCMP(p, "<lambda>", 8) == 0)
4446 {
4447 p += 8;
4448 (void)getdigits(&p);
4449 saved = vim_strnsave(*name, p - *name);
4450 if (fudi != NULL)
4451 CLEAR_POINTER(fudi);
4452 }
4453 else
4454 saved = trans_function_name(&p, is_global, skip,
4455 flags, fudi, NULL, NULL);
4456 *name = p;
4457 return saved;
4458}
4459
4460/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004461 * List functions. When "regmatch" is NULL all of then.
4462 * Otherwise functions matching "regmatch".
4463 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004464 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004465list_functions(regmatch_T *regmatch)
4466{
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004467 int prev_ht_changed = func_hashtab.ht_changed;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004468 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004469 hashitem_T *hi;
4470
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004471 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004472 {
4473 if (!HASHITEM_EMPTY(hi))
4474 {
4475 ufunc_T *fp = HI2UF(hi);
4476
4477 --todo;
4478 if ((fp->uf_flags & FC_DEAD) == 0
4479 && (regmatch == NULL
4480 ? !message_filtered(fp->uf_name)
4481 && !func_name_refcount(fp->uf_name)
4482 : !isdigit(*fp->uf_name)
4483 && vim_regexec(regmatch, fp->uf_name, 0)))
4484 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004485 if (list_func_head(fp, FALSE) == FAIL)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004486 return;
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004487 if (function_list_modified(prev_ht_changed))
4488 return;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004489 }
4490 }
4491 }
4492}
4493
4494/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004495 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004496 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4497 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004498 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar554d0312023-01-05 19:59:18 +00004499 * If "class_flags" has CF_CLASS then the function is defined inside a class.
4500 * With CF_INTERFACE the function is define inside an interface, only the
4501 * ":def"/":function" line is expected, no function body.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004502 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004503 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004504 ufunc_T *
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004505define_function(
4506 exarg_T *eap,
4507 char_u *name_arg,
4508 garray_T *lines_to_free,
Bram Moolenaar554d0312023-01-05 19:59:18 +00004509 int class_flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 int j;
4512 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004513 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004514 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004515 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 char_u *p;
4517 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004518 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 char_u *line_arg = NULL;
4520 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004521 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004522 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 garray_T newlines;
4524 int varargs = FALSE;
4525 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004526 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004527 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004528 int fp_allocated = FALSE;
4529 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004530 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004531 dictitem_T *v;
4532 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004533 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004536 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004537 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004538 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539
4540 /*
4541 * ":function" without argument: list functions.
4542 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004543 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004544 {
4545 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004546 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004547 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004548 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 }
4550
4551 /*
4552 * ":function /pat": list functions matching pattern.
4553 */
4554 if (*eap->arg == '/')
4555 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004556 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557 if (!eap->skip)
4558 {
4559 regmatch_T regmatch;
4560
4561 c = *p;
4562 *p = NUL;
4563 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4564 *p = c;
4565 if (regmatch.regprog != NULL)
4566 {
4567 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004568 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 vim_regfree(regmatch.regprog);
4570 }
4571 }
4572 if (*p == '/')
4573 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004574 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004575 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 }
4577
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004578 ga_init(&newargs);
4579 ga_init(&argtypes);
4580 ga_init(&default_args);
4581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582 /*
4583 * Get the function name. There are these situations:
Bram Moolenaar554d0312023-01-05 19:59:18 +00004584 * func normal function name, also when "class_flags" is non-zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 * "name" == func, "fudi.fd_dict" == NULL
4586 * dict.func new dictionary entry
4587 * "name" == NULL, "fudi.fd_dict" set,
4588 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4589 * dict.func existing dict entry with a Funcref
4590 * "name" == func, "fudi.fd_dict" set,
4591 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4592 * dict.func existing dict entry that's not a Funcref
4593 * "name" == NULL, "fudi.fd_dict" set,
4594 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4595 * s:func script-local function name
4596 * g:func global function name, same as "func"
4597 */
4598 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004599 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004601 // nested function, argument is (args).
4602 paren = TRUE;
4603 CLEAR_FIELD(fudi);
4604 }
4605 else
4606 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004607 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004608 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004609 if (p[0] == 's' && p[1] == ':')
4610 {
4611 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4612 return NULL;
4613 }
4614 p = to_name_end(p, TRUE);
4615 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4616 {
4617 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4618 eap->arg);
4619 return NULL;
4620 }
4621 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004622 }
4623
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004624 int tfn_flags = TFN_NO_AUTOLOAD | TFN_NEW_FUNC
Bram Moolenaar554d0312023-01-05 19:59:18 +00004625 | (class_flags != 0 ? TFN_IN_CLASS : 0);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004626 name = save_function_name(&p, &is_global, eap->skip, tfn_flags, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004627 paren = (vim_strchr(p, '(') != NULL);
4628 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004629 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004630 /*
4631 * Return on an invalid expression in braces, unless the expression
4632 * evaluation has been cancelled due to an aborting error, an
4633 * interrupt, or an exception.
4634 */
4635 if (!aborting())
4636 {
4637 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00004638 semsg(_(e_key_not_present_in_dictionary_str),
4639 fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004640 vim_free(fudi.fd_newkey);
4641 return NULL;
4642 }
4643 else
4644 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004646
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004647 // For "export def FuncName()" in an autoload script the function name
4648 // is stored with the legacy autoload name "dir#script#FuncName" so
4649 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004650 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004651 {
4652 char_u *prefixed = may_prefix_autoload(name);
4653
4654 if (prefixed != NULL && prefixed != name)
4655 {
4656 vim_free(name);
4657 name = prefixed;
4658 }
4659 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004660 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004661 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004662 {
4663 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4664 goto ret_free;
4665 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004666 }
4667
Bram Moolenaare38eab22019-12-05 21:50:01 +01004668 // An error in a function call during evaluation of an expression in magic
4669 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670 saved_did_emsg = did_emsg;
4671 did_emsg = FALSE;
4672
4673 /*
4674 * ":function func" with only function name: list function.
4675 */
4676 if (!paren)
4677 {
4678 if (!ends_excmd(*skipwhite(p)))
4679 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004680 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 goto ret_free;
4682 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004683 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 if (eap->nextcmd != NULL)
4685 *p = NUL;
4686 if (!eap->skip && !got_int)
4687 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004688 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004689 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4690 {
4691 char_u *up = untrans_function_name(name);
4692
4693 // With Vim9 script the name was made script-local, if not
4694 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004695 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004696 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004697 }
4698
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 if (fp != NULL)
4700 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004701 // Check no function was added or removed from a timer, e.g. at
4702 // the more prompt. "fp" may then be invalid.
4703 int prev_ht_changed = func_hashtab.ht_changed;
4704
4705 if (list_func_head(fp, TRUE) == OK)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004706 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004707 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4708 {
4709 if (FUNCLINE(fp, j) == NULL)
4710 continue;
4711 msg_putchar('\n');
4712 msg_outnum((long)(j + 1));
4713 if (j < 9)
4714 msg_putchar(' ');
4715 if (j < 99)
4716 msg_putchar(' ');
4717 if (function_list_modified(prev_ht_changed))
4718 break;
4719 msg_prt_line(FUNCLINE(fp, j), FALSE);
4720 out_flush(); // show a line at a time
4721 ui_breakcheck();
4722 }
4723 if (!got_int)
4724 {
4725 msg_putchar('\n');
4726 if (!function_list_modified(prev_ht_changed))
4727 {
4728 if (fp->uf_def_status != UF_NOT_COMPILED)
4729 msg_puts(" enddef");
4730 else
4731 msg_puts(" endfunction");
4732 }
4733 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004734 }
4735 }
4736 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004737 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 }
4739 goto ret_free;
4740 }
4741
4742 /*
4743 * ":function name(arg1, arg2)" Define function.
4744 */
4745 p = skipwhite(p);
4746 if (*p != '(')
4747 {
4748 if (!eap->skip)
4749 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004750 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 goto ret_free;
4752 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004753 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 if (vim_strchr(p, '(') != NULL)
4755 p = vim_strchr(p, '(');
4756 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004758 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4759 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004760 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004761 goto ret_free;
4762 }
4763
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004764 // In Vim9 script only global functions can be redefined.
4765 if (vim9script && eap->forceit && !is_global)
4766 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004767 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004768 goto ret_free;
4769 }
4770
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004771 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004772
Bram Moolenaar04b12692020-05-04 23:24:44 +02004773 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004775 // Check the name of the function. Unless it's a dictionary function
4776 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777 if (name != NULL)
4778 arg = name;
4779 else
4780 arg = fudi.fd_newkey;
4781 if (arg != NULL && (fudi.fd_di == NULL
4782 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4783 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4784 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004785 char_u *name_base = arg;
4786 int i;
4787
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004789 {
4790 name_base = vim_strchr(arg, '_');
4791 if (name_base == NULL)
4792 name_base = arg + 3;
4793 else
4794 ++name_base;
4795 }
4796 for (i = 0; name_base[i] != NUL && (i == 0
4797 ? eval_isnamec1(name_base[i])
4798 : eval_isnamec(name_base[i])); ++i)
4799 ;
4800 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004801 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004802
4803 // In Vim9 script a function cannot have the same name as a
4804 // variable.
4805 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004806 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4807 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004808 + EVAL_VAR_NO_FUNC) == OK)
4809 {
4810 semsg(_(e_redefining_script_item_str), name_base);
4811 goto ret_free;
4812 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004814 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004815 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004816 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004817 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004818 goto ret_free;
4819 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820 }
4821
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004822 // This may get more lines and make the pointers into the first line
4823 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004824 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004825 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarf0571712023-01-04 13:16:20 +00004826 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004827 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar554d0312023-01-05 19:59:18 +00004828 eap, class_flags, &newlines, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004830 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004831
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004832 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004834 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004835 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004837 if (*p != ':')
4838 {
4839 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4840 p = skipwhite(p);
4841 }
4842 else if (!IS_WHITE_OR_NUL(p[1]))
4843 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004844 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004845 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004846 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004847 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004848 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004849 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004850 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004851 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004852 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004853 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004854 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004855 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004856 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004858 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004859 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004860 else
4861 // find extra arguments "range", "dict", "abort" and "closure"
4862 for (;;)
4863 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004864 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004865 p = skipwhite(p);
4866 if (STRNCMP(p, "range", 5) == 0)
4867 {
4868 flags |= FC_RANGE;
4869 p += 5;
4870 }
4871 else if (STRNCMP(p, "dict", 4) == 0)
4872 {
4873 flags |= FC_DICT;
4874 p += 4;
4875 }
4876 else if (STRNCMP(p, "abort", 5) == 0)
4877 {
4878 flags |= FC_ABORT;
4879 p += 5;
4880 }
4881 else if (STRNCMP(p, "closure", 7) == 0)
4882 {
4883 flags |= FC_CLOSURE;
4884 p += 7;
4885 if (current_funccal == NULL)
4886 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00004887 emsg_funcname(e_closure_function_should_not_be_at_top_level_str,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004888 name == NULL ? (char_u *)"" : name);
4889 goto erret;
4890 }
4891 }
4892 else
4893 break;
4894 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895
Bram Moolenaare38eab22019-12-05 21:50:01 +01004896 // When there is a line break use what follows for the function body.
4897 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 if (*p == '\n')
4899 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004900 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004901 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4902 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004903 && !(VIM_ISWHITE(*whitep) && *p == '#'
4904 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004905 && !eap->skip
4906 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004907 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908
4909 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004910 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4911 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912 */
4913 if (KeyTyped)
4914 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004915 // Check if the function already exists, don't let the user type the
4916 // whole function before telling him it doesn't work! For a script we
4917 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004918 if (!eap->skip && !eap->forceit)
4919 {
4920 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004921 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004922 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004923 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004924 }
4925
4926 if (!eap->skip && did_emsg)
4927 goto erret;
4928
Bram Moolenaare38eab22019-12-05 21:50:01 +01004929 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004930 cmdline_row = msg_row;
4931 }
4932
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004933 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004934 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004935
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004936 // Do not define the function when getting the body fails and when
4937 // skipping.
Bram Moolenaar554d0312023-01-05 19:59:18 +00004938 if (((class_flags & CF_INTERFACE) == 0
4939 && get_function_body(eap, &newlines, line_arg, lines_to_free)
4940 == FAIL)
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004941 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942 goto erret;
4943
4944 /*
4945 * If there are no errors, add the function
4946 */
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004947 if (fudi.fd_dict != NULL)
4948 {
4949 char numbuf[20];
4950
4951 fp = NULL;
4952 if (fudi.fd_newkey == NULL && !eap->forceit)
4953 {
4954 emsg(_(e_dictionary_entry_already_exists));
4955 goto erret;
4956 }
4957 if (fudi.fd_di == NULL)
4958 {
4959 // Can't add a function to a locked dictionary
4960 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
4961 goto erret;
4962 }
4963 // Can't change an existing function if it is locked
4964 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
4965 goto erret;
4966
4967 // Give the function a sequential number. Can only be used with a
4968 // Funcref!
4969 vim_free(name);
4970 sprintf(numbuf, "%d", ++func_nr);
4971 name = vim_strsave((char_u *)numbuf);
4972 if (name == NULL)
4973 goto erret;
4974 }
Bram Moolenaar554d0312023-01-05 19:59:18 +00004975 else if (class_flags == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004976 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004977 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004978 char_u *find_name = name;
4979 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004980 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004981
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004982 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004983 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004984 var_conflict = TRUE;
4985
4986 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4987 {
4988 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4989
4990 if (si->sn_autoload_prefix != NULL)
4991 {
4992 if (is_export)
4993 {
4994 find_name = name + STRLEN(si->sn_autoload_prefix);
4995 v = find_var(find_name, &ht, TRUE);
4996 if (v != NULL)
4997 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004998 // Only check if the function already exists in the script,
4999 // global functions can be shadowed.
5000 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00005001 }
5002 else
5003 {
5004 char_u *prefixed = may_prefix_autoload(name);
5005
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00005006 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00005007 {
5008 v = find_var(prefixed, &ht, TRUE);
5009 if (v != NULL)
5010 var_conflict = TRUE;
5011 vim_free(prefixed);
5012 }
5013 }
5014 }
5015 }
5016 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00005018 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005019 goto erret;
5020 }
5021
Bram Moolenaaracc4b562022-01-24 13:54:45 +00005022 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02005023 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005024 {
Bram Moolenaareef21022020-08-01 22:16:43 +02005025 char_u *uname = untrans_function_name(name);
5026
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00005027 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02005028 }
5029
5030 if (fp != NULL || import != NULL)
5031 {
5032 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005033
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005034 // Function can be replaced with "function!" and when sourcing the
5035 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02005036 // A name that is used by an import can not be overruled.
5037 if (import != NULL
5038 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005039 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02005040 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 {
Bram Moolenaard604d782021-11-20 21:46:20 +00005042 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02005043 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02005044 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02005045 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00005046 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005047 goto erret;
5048 }
5049 if (fp->uf_calls > 0)
5050 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005051 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00005052 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005053 goto erret;
5054 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005055 if (fp->uf_refcount > 1)
5056 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005057 // This function is referenced somewhere, don't redefine it but
5058 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005059 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005060 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005061 fp = NULL;
5062 overwrite = TRUE;
5063 }
5064 else
5065 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005066 char_u *exp_name = fp->uf_name_exp;
5067
5068 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01005069 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005070 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02005071 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005072 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005073 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02005074#ifdef FEAT_PROFILE
5075 fp->uf_profiling = FALSE;
5076 fp->uf_prof_initialized = FALSE;
5077#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005078 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005079 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080 }
5081 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005082
5083 if (fp == NULL)
5084 {
5085 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
5086 {
5087 int slen, plen;
5088 char_u *scriptname;
5089
Bram Moolenaare38eab22019-12-05 21:50:01 +01005090 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005091 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005092 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005093 {
5094 scriptname = autoload_name(name);
5095 if (scriptname != NULL)
5096 {
5097 p = vim_strchr(scriptname, '/');
5098 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005099 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005100 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005101 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102 j = OK;
5103 vim_free(scriptname);
5104 }
5105 }
5106 if (j == FAIL)
5107 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02005108 linenr_T save_lnum = SOURCING_LNUM;
5109
5110 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00005111 semsg(_(e_function_name_does_not_match_script_file_name_str),
5112 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02005113 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005114 goto erret;
5115 }
5116 }
5117
Bram Moolenaare01e5212023-01-08 20:31:18 +00005118 fp = alloc_ufunc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005119 if (fp == NULL)
5120 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005121 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122
5123 if (fudi.fd_dict != NULL)
5124 {
5125 if (fudi.fd_di == NULL)
5126 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005127 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
5129 if (fudi.fd_di == NULL)
5130 {
5131 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02005132 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005133 goto erret;
5134 }
5135 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
5136 {
5137 vim_free(fudi.fd_di);
5138 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02005139 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005140 goto erret;
5141 }
5142 }
5143 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005144 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145 clear_tv(&fudi.fd_di->di_tv);
5146 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005148
Bram Moolenaare38eab22019-12-05 21:50:01 +01005149 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150 flags |= FC_DICT;
5151 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 }
5153 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005154 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005155 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02005156 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005157
5158 if (eap->cmdidx == CMD_def)
5159 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02005160 int lnum_save = SOURCING_LNUM;
5161 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005162
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005163 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02005164
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005165 // error messages are for the first function line
5166 SOURCING_LNUM = sourcing_lnum_top;
5167
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02005168 // The function may use script variables from the context.
5169 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02005170
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005171 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005172 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005173 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005174 free_fp = fp_allocated;
5175 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005176 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005177 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005178
5179 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005180 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005181 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005182 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005183 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005184 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005185 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02005186 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005187 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005188 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005189 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005190
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005191 if (fp_allocated)
5192 {
5193 // insert the new function in the function list
5194 set_ufunc_name(fp, name);
5195 if (overwrite)
5196 {
5197 hi = hash_find(&func_hashtab, name);
5198 hi->hi_key = UF2HIKEY(fp);
5199 }
Bram Moolenaar554d0312023-01-05 19:59:18 +00005200 else if (class_flags == 0 && hash_add(&func_hashtab,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005201 UF2HIKEY(fp), "add function") == FAIL)
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005202 {
5203 free_fp = TRUE;
5204 goto erret;
5205 }
5206 fp->uf_refcount = 1;
5207 }
5208
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005210 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005211 if ((flags & FC_CLOSURE) != 0)
5212 {
Bram Moolenaar58016442016-07-31 18:30:22 +02005213 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005214 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005215 }
5216 else
5217 fp->uf_scoped = NULL;
5218
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005219#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005220 if (prof_def_func())
5221 func_do_profile(fp);
5222#endif
5223 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02005224 if (sandbox)
5225 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02005226 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005227 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005228 fp->uf_flags = flags;
5229 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01005230 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005231 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02005232 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02005233 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005234 if (is_export)
5235 {
5236 fp->uf_flags |= FC_EXPORT;
dundargocc57b5bc2022-11-02 13:30:51 +00005237 // let do_one_cmd() know the export worked.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005238 is_export = FALSE;
5239 }
5240
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005241 if (eap->cmdidx == CMD_def)
5242 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02005243 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
5244 // :func does not use Vim9 script syntax, even in a Vim9 script file
5245 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005246
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247 goto ret_free;
5248
5249erret:
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005250 if (fp != NULL)
5251 {
Bram Moolenaarf0571712023-01-04 13:16:20 +00005252 // these were set to "newargs" and "default_args", which are cleared
5253 // below
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005254 ga_init(&fp->uf_args);
5255 ga_init(&fp->uf_def_args);
5256 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257errret_2:
Bram Moolenaarf0571712023-01-04 13:16:20 +00005258 ga_clear_strings(&newargs);
5259 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005260 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005261 if (fp != NULL)
Bram Moolenaarf0571712023-01-04 13:16:20 +00005262 {
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005263 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarf0571712023-01-04 13:16:20 +00005264 VIM_CLEAR(fp->uf_va_name);
5265 clear_type_list(&fp->uf_type_list);
5266 }
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005267 if (free_fp)
5268 {
5269 vim_free(fp);
5270 fp = NULL;
5271 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005272ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005273 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005274 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005275 if (name != name_arg)
5276 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005277 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005278 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005279
5280 return fp;
5281}
5282
5283/*
5284 * ":function"
5285 */
5286 void
5287ex_function(exarg_T *eap)
5288{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005289 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005290
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005291 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Bram Moolenaar554d0312023-01-05 19:59:18 +00005292 (void)define_function(eap, NULL, &lines_to_free, 0);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005293 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005294}
5295
5296/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005297 * Find a function by name, including "<lambda>123".
5298 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005299 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005300 * Return NULL if not found.
5301 */
5302 ufunc_T *
5303find_func_by_name(char_u *name, compiletype_T *compile_type)
5304{
5305 char_u *arg = name;
5306 char_u *fname;
5307 ufunc_T *ufunc;
5308 int is_global = FALSE;
5309
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005310 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5311 {
5312 *compile_type = CT_PROFILE;
5313 arg = skipwhite(arg + 7);
5314 }
5315 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5316 {
5317 *compile_type = CT_DEBUG;
5318 arg = skipwhite(arg + 5);
5319 }
5320
5321 if (STRNCMP(arg, "<lambda>", 8) == 0)
5322 {
5323 arg += 8;
5324 (void)getdigits(&arg);
5325 fname = vim_strnsave(name, arg - name);
5326 }
5327 else
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005328 {
5329 // First try finding a method in a class, find_func_by_name() will give
5330 // an error if the function is not found.
5331 ufunc = find_class_func(&arg);
5332 if (ufunc != NULL)
5333 return ufunc;
5334
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005335 fname = trans_function_name(&arg, &is_global, FALSE,
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005336 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD | TFN_NO_DECL,
5337 NULL, NULL, NULL);
5338 }
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005339 if (fname == NULL)
5340 {
5341 semsg(_(e_invalid_argument_str), name);
5342 return NULL;
5343 }
5344 if (!ends_excmd2(name, arg))
5345 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005346 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005347 emsg(ex_errmsg(e_trailing_characters_str, arg));
5348 return NULL;
5349 }
5350
5351 ufunc = find_func(fname, is_global);
5352 if (ufunc == NULL)
5353 {
5354 char_u *p = untrans_function_name(fname);
5355
5356 if (p != NULL)
5357 // Try again without making it script-local.
5358 ufunc = find_func(p, FALSE);
5359 }
5360 vim_free(fname);
5361 if (ufunc == NULL)
5362 semsg(_(e_cannot_find_function_str), name);
5363 return ufunc;
5364}
5365
5366/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005367 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005368 * be compiled or the one specified by the argument.
5369 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005370 */
5371 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005372ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005373{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005374 ufunc_T *ufunc;
5375
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005376 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005377 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005378 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005379
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005380 ufunc = find_func_by_name(eap->arg, &compile_type);
5381 if (ufunc != NULL)
5382 {
5383 if (func_needs_compiling(ufunc, compile_type))
5384 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5385 else
5386 smsg(_("Function %s does not need compiling"), eap->arg);
5387 }
5388 }
5389 else
5390 {
5391 long todo = (long)func_hashtab.ht_used;
5392 int changed = func_hashtab.ht_changed;
5393 hashitem_T *hi;
5394
5395 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5396 {
5397 if (!HASHITEM_EMPTY(hi))
5398 {
5399 --todo;
5400 ufunc = HI2UF(hi);
5401 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5402 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5403 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005404 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005405 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5406
5407 if (func_hashtab.ht_changed != changed)
5408 {
5409 // a function has been added or removed, need to start
5410 // over
5411 todo = (long)func_hashtab.ht_used;
5412 changed = func_hashtab.ht_changed;
5413 hi = func_hashtab.ht_array;
5414 --hi;
5415 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005416 }
5417 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005418 }
5419 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005420}
5421
5422/*
5423 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5424 * Return 2 if "p" starts with "s:".
5425 * Return 0 otherwise.
5426 */
5427 int
5428eval_fname_script(char_u *p)
5429{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005430 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5431 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005432 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5433 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5434 return 5;
5435 if (p[0] == 's' && p[1] == ':')
5436 return 2;
5437 return 0;
5438}
5439
5440 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005441translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005442{
5443 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005444 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005445 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005446}
5447
5448/*
5449 * Return TRUE when "ufunc" has old-style "..." varargs
5450 * or named varargs "...name: type".
5451 */
5452 int
5453has_varargs(ufunc_T *ufunc)
5454{
5455 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005456}
5457
5458/*
5459 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005460 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461 */
5462 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005463function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005464{
5465 char_u *nm = name;
5466 char_u *p;
5467 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005468 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005469 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005470
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005471 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5472 if (no_deref)
5473 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005474 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005475 nm = skipwhite(nm);
5476
Bram Moolenaare38eab22019-12-05 21:50:01 +01005477 // Only accept "funcname", "funcname ", "funcname (..." and
5478 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005479 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005480 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005481 vim_free(p);
5482 return n;
5483}
5484
Bram Moolenaar113e1072019-01-20 15:30:40 +01005485#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005486 char_u *
5487get_expanded_name(char_u *name, int check)
5488{
5489 char_u *nm = name;
5490 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005491 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005492
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005493 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005494 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005495
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005496 if (p != NULL && *nm == NUL
5497 && (!check || translated_function_exists(p, is_global)))
5498 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005499
5500 vim_free(p);
5501 return NULL;
5502}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005503#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005504
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005505/*
5506 * Function given to ExpandGeneric() to obtain the list of user defined
5507 * function names.
5508 */
5509 char_u *
5510get_user_func_name(expand_T *xp, int idx)
5511{
5512 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005513 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005514 static hashitem_T *hi;
5515 ufunc_T *fp;
5516
5517 if (idx == 0)
5518 {
5519 done = 0;
5520 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005521 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005522 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005523 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005524 {
5525 if (done++ > 0)
5526 ++hi;
5527 while (HASHITEM_EMPTY(hi))
5528 ++hi;
5529 fp = HI2UF(hi);
5530
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005531 // don't show dead, dict and lambda functions
5532 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005533 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005534 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005535
5536 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005537 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005538
5539 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005540 if (xp->xp_context != EXPAND_USER_FUNC
5541 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005542 {
5543 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005544 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005545 STRCAT(IObuff, ")");
5546 }
5547 return IObuff;
5548 }
5549 return NULL;
5550}
5551
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005552/*
Bram Moolenaar83677162023-01-08 19:54:10 +00005553 * Make a copy of a function.
5554 * Intended to be used for a function defined on a base class that has a copy
5555 * on the child class.
5556 * The copy has uf_refcount set to one.
5557 * Returns NULL when out of memory.
5558 */
5559 ufunc_T *
5560copy_function(ufunc_T *fp)
5561{
Bram Moolenaare01e5212023-01-08 20:31:18 +00005562 ufunc_T *ufunc = alloc_ufunc(fp->uf_name);
Bram Moolenaar83677162023-01-08 19:54:10 +00005563 if (ufunc == NULL)
5564 return NULL;
5565
5566 // Most things can just be copied.
5567 *ufunc = *fp;
5568
5569 ufunc->uf_def_status = UF_TO_BE_COMPILED;
5570 ufunc->uf_dfunc_idx = 0;
5571 ufunc->uf_class = NULL;
5572
5573 ga_copy_strings(&fp->uf_args, &ufunc->uf_args);
5574 ga_copy_strings(&fp->uf_def_args, &ufunc->uf_def_args);
5575
5576 if (ufunc->uf_arg_types != NULL)
5577 {
5578 // "uf_arg_types" is an allocated array, make a copy.
5579 type_T **at = ALLOC_CLEAR_MULT(type_T *, ufunc->uf_args.ga_len);
5580 if (at != NULL)
5581 {
5582 mch_memmove(at, ufunc->uf_arg_types,
5583 sizeof(type_T *) * ufunc->uf_args.ga_len);
5584 ufunc->uf_arg_types = at;
5585 }
5586 }
5587
5588 // TODO: how about the types themselves? they can be freed when the
5589 // original function is freed:
5590 // type_T **uf_arg_types;
5591 // type_T *uf_ret_type;
5592
5593 ufunc->uf_type_list.ga_len = 0;
5594 ufunc->uf_type_list.ga_data = NULL;
5595
5596 // TODO: partial_T *uf_partial;
5597
5598 if (ufunc->uf_va_name != NULL)
5599 ufunc->uf_va_name = vim_strsave(ufunc->uf_va_name);
5600
5601 // TODO:
5602 // type_T *uf_va_type;
5603 // type_T *uf_func_type;
5604
5605 ufunc->uf_block_depth = 0;
5606 ufunc->uf_block_ids = NULL;
5607
5608 ga_copy_strings(&fp->uf_lines, &ufunc->uf_lines);
5609
5610 ufunc->uf_refcount = 1;
5611 ufunc->uf_name_exp = NULL;
5612 STRCPY(ufunc->uf_name, fp->uf_name);
5613
5614 return ufunc;
5615}
5616
5617/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005618 * ":delfunction {name}"
5619 */
5620 void
5621ex_delfunction(exarg_T *eap)
5622{
5623 ufunc_T *fp = NULL;
5624 char_u *p;
5625 char_u *name;
5626 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005627 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005628
5629 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005630 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5631 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005632 vim_free(fudi.fd_newkey);
5633 if (name == NULL)
5634 {
5635 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005636 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005637 return;
5638 }
5639 if (!ends_excmd(*skipwhite(p)))
5640 {
5641 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005642 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005643 return;
5644 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005645 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005646 if (eap->nextcmd != NULL)
5647 *p = NUL;
5648
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005649 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005650 {
5651 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005652 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005653 vim_free(name);
5654 return;
5655 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005656 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005657 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005658 vim_free(name);
5659
5660 if (!eap->skip)
5661 {
5662 if (fp == NULL)
5663 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005664 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005665 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005666 return;
5667 }
5668 if (fp->uf_calls > 0)
5669 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005670 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005671 return;
5672 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005673 if (fp->uf_flags & FC_VIM9)
5674 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005675 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005676 return;
5677 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005678
5679 if (fudi.fd_dict != NULL)
5680 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005681 // Delete the dict item that refers to the function, it will
5682 // invoke func_unref() and possibly delete the function.
Bram Moolenaaref2c3252022-11-25 16:31:51 +00005683 dictitem_remove(fudi.fd_dict, fudi.fd_di, "delfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005684 }
5685 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005686 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005687 // A normal function (not a numbered function or lambda) has a
5688 // refcount of 1 for the entry in the hashtable. When deleting
5689 // it and the refcount is more than one, it should be kept.
5690 // A numbered function and lambda should be kept if the refcount is
5691 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005692 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005693 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005694 // Function is still referenced somewhere. Don't free it but
5695 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005696 if (func_remove(fp))
5697 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005698 }
5699 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005700 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005701 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005702 }
5703}
5704
5705/*
5706 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005707 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005708 */
5709 void
5710func_unref(char_u *name)
5711{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005712 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005713
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005714 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005715 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005716 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005717 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005718 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005719#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005720 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005721#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005722 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005723 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005724 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005725}
5726
5727/*
5728 * Unreference a Function: decrement the reference count and free it when it
5729 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005730 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005731 */
5732 void
5733func_ptr_unref(ufunc_T *fp)
5734{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005735 if (fp != NULL && (--fp->uf_refcount <= 0
5736 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5737 && fp->uf_partial->pt_refcount <= 1
5738 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005739 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005740 // Only delete it when it's not being used. Otherwise it's done
5741 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005742 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005743 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005744 }
5745}
5746
5747/*
5748 * Count a reference to a Function.
5749 */
5750 void
5751func_ref(char_u *name)
5752{
5753 ufunc_T *fp;
5754
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005755 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005756 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005757 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005758 if (fp != NULL)
5759 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005760 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005761 // Only give an error for a numbered function.
5762 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005763 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005764}
5765
5766/*
5767 * Count a reference to a Function.
5768 */
5769 void
5770func_ptr_ref(ufunc_T *fp)
5771{
5772 if (fp != NULL)
5773 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005774}
5775
5776/*
5777 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5778 * referenced from anywhere that is in use.
5779 */
5780 static int
5781can_free_funccal(funccall_T *fc, int copyID)
5782{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005783 return (fc->fc_l_varlist.lv_copyID != copyID
5784 && fc->fc_l_vars.dv_copyID != copyID
5785 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005786 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005787}
5788
5789/*
5790 * ":return [expr]"
5791 */
5792 void
5793ex_return(exarg_T *eap)
5794{
5795 char_u *arg = eap->arg;
5796 typval_T rettv;
5797 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005798 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005799
5800 if (current_funccal == NULL)
5801 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005802 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005803 return;
5804 }
5805
Bram Moolenaar844fb642021-10-23 13:32:30 +01005806 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005807 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5808
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005809 if (eap->skip)
5810 ++emsg_skip;
5811
5812 eap->nextcmd = NULL;
5813 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005814 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005815 {
5816 if (!eap->skip)
5817 returning = do_return(eap, FALSE, TRUE, &rettv);
5818 else
5819 clear_tv(&rettv);
5820 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005821 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005822 else if (!eap->skip)
5823 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005824 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005825 update_force_abort();
5826
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005827 /*
5828 * Return unless the expression evaluation has been cancelled due to an
5829 * aborting error, an interrupt, or an exception.
5830 */
5831 if (!aborting())
5832 returning = do_return(eap, FALSE, TRUE, NULL);
5833 }
5834
Bram Moolenaare38eab22019-12-05 21:50:01 +01005835 // When skipping or the return gets pending, advance to the next command
5836 // in this line (!returning). Otherwise, ignore the rest of the line.
5837 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005838 if (returning)
5839 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005840 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005841 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005842
5843 if (eap->skip)
5844 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005845 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005846}
5847
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005848 static int
5849ex_call_inner(
5850 exarg_T *eap,
5851 char_u *name,
5852 char_u **arg,
5853 char_u *startarg,
5854 funcexe_T *funcexe_init,
5855 evalarg_T *evalarg)
5856{
5857 linenr_T lnum;
5858 int doesrange;
5859 typval_T rettv;
5860 int failed = FALSE;
5861
5862 /*
5863 * When skipping, evaluate the function once, to find the end of the
5864 * arguments.
5865 * When the function takes a range, this is discovered after the first
5866 * call, and the loop is broken.
5867 */
5868 if (eap->skip)
5869 {
5870 ++emsg_skip;
5871 lnum = eap->line2; // do it once, also with an invalid range
5872 }
5873 else
5874 lnum = eap->line1;
5875 for ( ; lnum <= eap->line2; ++lnum)
5876 {
5877 funcexe_T funcexe;
5878
5879 if (!eap->skip && eap->addr_count > 0)
5880 {
5881 if (lnum > curbuf->b_ml.ml_line_count)
5882 {
5883 // If the function deleted lines or switched to another buffer
5884 // the line number may become invalid.
5885 emsg(_(e_invalid_range));
5886 break;
5887 }
5888 curwin->w_cursor.lnum = lnum;
5889 curwin->w_cursor.col = 0;
5890 curwin->w_cursor.coladd = 0;
5891 }
5892 *arg = startarg;
5893
5894 funcexe = *funcexe_init;
5895 funcexe.fe_doesrange = &doesrange;
5896 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5897 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5898 {
5899 failed = TRUE;
5900 break;
5901 }
5902 if (has_watchexpr())
5903 dbg_check_breakpoint(eap);
5904
5905 // Handle a function returning a Funcref, Dictionary or List.
5906 if (handle_subscript(arg, NULL, &rettv,
5907 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5908 {
5909 failed = TRUE;
5910 break;
5911 }
5912
5913 clear_tv(&rettv);
5914 if (doesrange || eap->skip)
5915 break;
5916
5917 // Stop when immediately aborting on error, or when an interrupt
5918 // occurred or an exception was thrown but not caught.
5919 // get_func_tv() returned OK, so that the check for trailing
5920 // characters below is executed.
5921 if (aborting())
5922 break;
5923 }
5924 if (eap->skip)
5925 --emsg_skip;
5926 return failed;
5927}
5928
5929/*
5930 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5931 * Returns FAIL or OK.
5932 */
5933 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005934ex_defer_inner(
5935 char_u *name,
5936 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005937 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005938 partial_T *partial,
5939 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005940{
5941 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005942 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005943 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005944 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005945
5946 if (current_funccal == NULL)
5947 {
5948 semsg(_(e_str_not_inside_function), "defer");
5949 return FAIL;
5950 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005951 if (partial != NULL)
5952 {
5953 if (partial->pt_dict != NULL)
5954 {
5955 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5956 return FAIL;
5957 }
5958 if (partial->pt_argc > 0)
5959 {
5960 int i;
5961
5962 partial_argc = partial->pt_argc;
5963 for (i = 0; i < partial_argc; ++i)
5964 copy_tv(&partial->pt_argv[i], &argvars[i]);
5965 }
5966 }
5967 r = get_func_arguments(arg, evalarg, FALSE,
5968 argvars + partial_argc, &argcount);
5969 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005970
5971 if (r == OK)
5972 {
5973 if (type != NULL)
5974 {
5975 // Check that the arguments are OK for the types of the funcref.
5976 r = check_argument_types(type, argvars, argcount, NULL, name);
5977 }
5978 else if (builtin_function(name, -1))
5979 {
5980 int idx = find_internal_func(name);
5981
5982 if (idx < 0)
5983 {
5984 emsg_funcname(e_unknown_function_str, name);
5985 r = FAIL;
5986 }
5987 else if (check_internal_func(idx, argcount) == -1)
5988 r = FAIL;
5989 }
5990 else
5991 {
5992 ufunc_T *ufunc = find_func(name, FALSE);
5993
5994 // we tolerate an unknown function here, it might be defined later
5995 if (ufunc != NULL)
5996 {
Bram Moolenaar0917e862023-02-18 14:42:44 +00005997 funcerror_T error = check_user_func_argcount(ufunc, argcount);
Bram Moolenaar16900322022-09-08 19:51:45 +01005998 if (error != FCERR_UNKNOWN)
5999 {
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01006000 user_func_error(error, name, FALSE);
Bram Moolenaar16900322022-09-08 19:51:45 +01006001 r = FAIL;
6002 }
6003 }
6004 }
6005 }
6006
Bram Moolenaar86d87252022-09-05 21:21:25 +01006007 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01006008 {
6009 while (--argcount >= 0)
6010 clear_tv(&argvars[argcount]);
6011 return FAIL;
6012 }
6013 return add_defer(name, argcount, argvars);
6014}
6015
6016/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01006017 * Return TRUE if currently inside a function call.
6018 * Give an error message and return FALSE when not.
6019 */
6020 int
6021can_add_defer(void)
6022{
6023 if (!in_def_function() && get_current_funccal() == NULL)
6024 {
6025 semsg(_(e_str_not_inside_function), "defer");
6026 return FALSE;
6027 }
6028 return TRUE;
6029}
6030
6031/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01006032 * Add a deferred call for "name" with arguments "argvars[argcount]".
6033 * Consumes "argvars[]".
6034 * Caller must check that in_def_function() returns TRUE or current_funccal is
6035 * not NULL.
6036 * Returns OK or FAIL.
6037 */
6038 int
6039add_defer(char_u *name, int argcount_arg, typval_T *argvars)
6040{
6041 char_u *saved_name = vim_strsave(name);
6042 int argcount = argcount_arg;
6043 defer_T *dr;
6044 int ret = FAIL;
6045
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006046 if (saved_name == NULL)
6047 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01006048 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006049 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01006050 if (add_defer_function(saved_name, argcount, argvars) == OK)
6051 argcount = 0;
6052 }
6053 else
6054 {
6055 if (current_funccal->fc_defer.ga_itemsize == 0)
6056 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
6057 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
6058 goto theend;
6059 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
6060 + current_funccal->fc_defer.ga_len++;
6061 dr->dr_name = saved_name;
6062 dr->dr_argcount = argcount;
6063 while (argcount > 0)
6064 {
6065 --argcount;
6066 dr->dr_argvars[argcount] = argvars[argcount];
6067 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006068 }
6069 ret = OK;
6070
6071theend:
6072 while (--argcount >= 0)
6073 clear_tv(&argvars[argcount]);
6074 return ret;
6075}
6076
6077/*
6078 * Invoked after a functions has finished: invoke ":defer" functions.
6079 */
Bram Moolenaar58779852022-09-06 18:31:14 +01006080 static void
6081handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006082{
6083 int idx;
6084
Bram Moolenaar58779852022-09-06 18:31:14 +01006085 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006086 {
6087 funcexe_T funcexe;
6088 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01006089 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006090 int i;
6091
6092 CLEAR_FIELD(funcexe);
6093 funcexe.fe_evaluate = TRUE;
6094
6095 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
6096 call_func(dr->dr_name, -1, &rettv,
6097 dr->dr_argcount, dr->dr_argvars, &funcexe);
6098 clear_tv(&rettv);
6099 vim_free(dr->dr_name);
6100 for (i = dr->dr_argcount - 1; i >= 0; --i)
6101 clear_tv(&dr->dr_argvars[i]);
6102 }
Bram Moolenaar58779852022-09-06 18:31:14 +01006103 ga_clear(&funccal->fc_defer);
6104}
6105
6106/*
6107 * Called when exiting: call all defer functions.
6108 */
6109 void
6110invoke_all_defer(void)
6111{
6112 funccall_T *funccal;
6113
Bram Moolenaarca16c602022-09-06 18:57:08 +01006114 for (funccal = current_funccal; funccal != NULL;
6115 funccal = funccal->fc_caller)
Bram Moolenaar58779852022-09-06 18:31:14 +01006116 if (funccal->fc_ectx != NULL)
6117 {
6118 // :def function
6119 unwind_def_callstack(funccal->fc_ectx);
6120 may_invoke_defer_funcs(funccal->fc_ectx);
6121 }
6122 else
6123 {
6124 // legacy function
6125 handle_defer_one(funccal);
6126 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006127}
6128
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006129/*
6130 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006131 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006132 */
6133 void
6134ex_call(exarg_T *eap)
6135{
6136 char_u *arg = eap->arg;
6137 char_u *startarg;
6138 char_u *name;
6139 char_u *tofree;
6140 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006141 int failed = FALSE;
6142 funcdict_T fudi;
6143 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006144 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006145 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00006146 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00006147 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006148
Bram Moolenaare6b53242020-07-01 17:28:33 +02006149 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006150 if (eap->skip)
6151 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006152 typval_T rettv;
6153
Bram Moolenaare38eab22019-12-05 21:50:01 +01006154 // trans_function_name() doesn't work well when skipping, use eval0()
6155 // instead to skip to any following command, e.g. for:
6156 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006157 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006158 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006159 clear_tv(&rettv);
6160 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006161 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006162 return;
6163 }
6164
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006165 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00006166 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006167 if (fudi.fd_newkey != NULL)
6168 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006169 // Still need to give an error message for missing key.
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00006170 semsg(_(e_key_not_present_in_dictionary_str), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006171 vim_free(fudi.fd_newkey);
6172 }
6173 if (tofree == NULL)
6174 return;
6175
Bram Moolenaare38eab22019-12-05 21:50:01 +01006176 // Increase refcount on dictionary, it could get deleted when evaluating
6177 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006178 if (fudi.fd_dict != NULL)
6179 ++fudi.fd_dict->dv_refcount;
6180
Bram Moolenaare38eab22019-12-05 21:50:01 +01006181 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
6182 // contents. For VAR_PARTIAL get its partial, unless we already have one
6183 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006184 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006185 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00006186 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00006187 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006188
Bram Moolenaare38eab22019-12-05 21:50:01 +01006189 // Skip white space to allow ":call func ()". Not good, but required for
6190 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006191 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006192 if (*startarg != '(')
6193 {
Bram Moolenaare1242042021-12-16 20:56:57 +00006194 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006195 goto end;
6196 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00006197 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02006198 {
6199 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
6200 goto end;
6201 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006202
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006203 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006204 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006205 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01006206 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006207 }
6208 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006209 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02006210 funcexe_T funcexe;
6211
Bram Moolenaara80faa82020-04-12 19:37:17 +02006212 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006213 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00006214 funcexe.fe_partial = partial;
6215 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006216 funcexe.fe_firstline = eap->line1;
6217 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00006218 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006219 funcexe.fe_evaluate = !eap->skip;
6220 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006221 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006222
Bram Moolenaar1d341892021-09-18 15:25:52 +02006223 // When inside :try we need to check for following "| catch" or "| endtry".
6224 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006225 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006226 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006227 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02006228 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02006229 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006230 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02006231 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006232 {
6233 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00006234 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006235 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006236 }
6237 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02006238 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006239 }
Bram Moolenaara929c922022-04-18 15:21:17 +01006240 // Must be after using "arg", it may point into memory cleared here.
6241 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006242
6243end:
6244 dict_unref(fudi.fd_dict);
6245 vim_free(tofree);
6246}
6247
6248/*
6249 * Return from a function. Possibly makes the return pending. Also called
6250 * for a pending return at the ":endtry" or after returning from an extra
6251 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
6252 * when called due to a ":return" command. "rettv" may point to a typval_T
6253 * with the return rettv. Returns TRUE when the return can be carried out,
6254 * FALSE when the return gets pending.
6255 */
6256 int
6257do_return(
6258 exarg_T *eap,
6259 int reanimate,
6260 int is_cmd,
6261 void *rettv)
6262{
6263 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01006264 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006265
6266 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006267 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006268 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006269
6270 /*
6271 * Cleanup (and inactivate) conditionals, but stop when a try conditional
6272 * not in its finally clause (which then is to be executed next) is found.
6273 * In this case, make the ":return" pending for execution at the ":endtry".
6274 * Otherwise, return normally.
6275 */
6276 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
6277 if (idx >= 0)
6278 {
6279 cstack->cs_pending[idx] = CSTP_RETURN;
6280
6281 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006282 // A pending return again gets pending. "rettv" points to an
6283 // allocated variable with the rettv of the original ":return"'s
6284 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006285 cstack->cs_rettv[idx] = rettv;
6286 else
6287 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006288 // When undoing a return in order to make it pending, get the stored
6289 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006290 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006291 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006292
6293 if (rettv != NULL)
6294 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006295 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006296 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
6297 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
6298 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02006299 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006300 }
6301 else
6302 cstack->cs_rettv[idx] = NULL;
6303
6304 if (reanimate)
6305 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006306 // The pending return value could be overwritten by a ":return"
6307 // without argument in a finally clause; reset the default
6308 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006309 current_funccal->fc_rettv->v_type = VAR_NUMBER;
6310 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006311 }
6312 }
6313 report_make_pending(CSTP_RETURN, rettv);
6314 }
6315 else
6316 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006317 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006318
Bram Moolenaare38eab22019-12-05 21:50:01 +01006319 // If the return is carried out now, store the return value. For
6320 // a return immediately after reanimation, the value is already
6321 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006322 if (!reanimate && rettv != NULL)
6323 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006324 clear_tv(current_funccal->fc_rettv);
6325 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006326 if (!is_cmd)
6327 vim_free(rettv);
6328 }
6329 }
6330
6331 return idx < 0;
6332}
6333
6334/*
6335 * Free the variable with a pending return value.
6336 */
6337 void
6338discard_pending_return(void *rettv)
6339{
6340 free_tv((typval_T *)rettv);
6341}
6342
6343/*
6344 * Generate a return command for producing the value of "rettv". The result
6345 * is an allocated string. Used by report_pending() for verbose messages.
6346 */
6347 char_u *
6348get_return_cmd(void *rettv)
6349{
6350 char_u *s = NULL;
6351 char_u *tofree = NULL;
6352 char_u numbuf[NUMBUFLEN];
6353
6354 if (rettv != NULL)
6355 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6356 if (s == NULL)
6357 s = (char_u *)"";
6358
6359 STRCPY(IObuff, ":return ");
6360 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6361 if (STRLEN(s) + 8 >= IOSIZE)
6362 STRCPY(IObuff + IOSIZE - 4, "...");
6363 vim_free(tofree);
6364 return vim_strsave(IObuff);
6365}
6366
6367/*
6368 * Get next function line.
6369 * Called by do_cmdline() to get the next line.
6370 * Returns allocated string, or NULL for end of function.
6371 */
6372 char_u *
6373get_func_line(
6374 int c UNUSED,
6375 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006376 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006377 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006378{
6379 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006380 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006381 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006382 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006383
Bram Moolenaare38eab22019-12-05 21:50:01 +01006384 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006385 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006386 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006387 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006388 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006389 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006390 }
6391#ifdef FEAT_PROFILE
6392 if (do_profiling == PROF_YES)
6393 func_line_end(cookie);
6394#endif
6395
6396 gap = &fp->uf_lines;
6397 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006398 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006399 retval = NULL;
6400 else
6401 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006402 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006403 while (fcp->fc_linenr < gap->ga_len
6404 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6405 ++fcp->fc_linenr;
6406 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006407 retval = NULL;
6408 else
6409 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006410 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6411 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006412#ifdef FEAT_PROFILE
6413 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006414 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006415#endif
6416 }
6417 }
6418
Bram Moolenaare38eab22019-12-05 21:50:01 +01006419 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006420 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006421 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006422 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006423 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006424 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006425 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006426 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006427 }
6428
6429 return retval;
6430}
6431
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006432/*
6433 * Return TRUE if the currently active function should be ended, because a
6434 * return was encountered or an error occurred. Used inside a ":while".
6435 */
6436 int
6437func_has_ended(void *cookie)
6438{
6439 funccall_T *fcp = (funccall_T *)cookie;
6440
Bram Moolenaare38eab22019-12-05 21:50:01 +01006441 // Ignore the "abort" flag if the abortion behavior has been changed due to
6442 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006443 return (((fcp->fc_func->uf_flags & FC_ABORT)
6444 && did_emsg && !aborted_in_try())
6445 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006446}
6447
6448/*
6449 * return TRUE if cookie indicates a function which "abort"s on errors.
6450 */
6451 int
6452func_has_abort(
6453 void *cookie)
6454{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006455 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006456}
6457
6458
6459/*
6460 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6461 * Don't do this when "Func" is already a partial that was bound
6462 * explicitly (pt_auto is FALSE).
6463 * Changes "rettv" in-place.
6464 * Returns the updated "selfdict_in".
6465 */
6466 dict_T *
6467make_partial(dict_T *selfdict_in, typval_T *rettv)
6468{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006469 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006470 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006471 char_u fname_buf[FLEN_FIXED + 1];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006472 dict_T *selfdict = selfdict_in;
6473
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006474 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6475 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006476 fp = rettv->vval.v_partial->pt_func;
6477 else
6478 {
6479 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006480 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006481 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006482 if (fname == NULL)
6483 {
6484 // There is no point binding a dict to a NULL function, just create
6485 // a function reference.
6486 rettv->v_type = VAR_FUNC;
6487 rettv->vval.v_string = NULL;
6488 }
6489 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006490 {
6491 char_u *tofree = NULL;
Bram Moolenaar0917e862023-02-18 14:42:44 +00006492 funcerror_T error;
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006493
6494 // Translate "s:func" to the stored function name.
6495 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6496 fp = find_func(fname, FALSE);
6497 vim_free(tofree);
6498 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006499 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006500
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006501 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006502 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006503 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006504
6505 if (pt != NULL)
6506 {
6507 pt->pt_refcount = 1;
6508 pt->pt_dict = selfdict;
6509 pt->pt_auto = TRUE;
6510 selfdict = NULL;
6511 if (rettv->v_type == VAR_FUNC)
6512 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006513 // Just a function: Take over the function name and use
6514 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006515 pt->pt_name = rettv->vval.v_string;
6516 }
6517 else
6518 {
6519 partial_T *ret_pt = rettv->vval.v_partial;
6520 int i;
6521
Bram Moolenaare38eab22019-12-05 21:50:01 +01006522 // Partial: copy the function name, use selfdict and copy
6523 // args. Can't take over name or args, the partial might
6524 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006525 if (ret_pt->pt_name != NULL)
6526 {
6527 pt->pt_name = vim_strsave(ret_pt->pt_name);
6528 func_ref(pt->pt_name);
6529 }
6530 else
6531 {
6532 pt->pt_func = ret_pt->pt_func;
6533 func_ptr_ref(pt->pt_func);
6534 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006535 if (ret_pt->pt_argc > 0)
6536 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006537 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006538 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006539 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006540 pt->pt_argc = 0;
6541 else
6542 {
6543 pt->pt_argc = ret_pt->pt_argc;
6544 for (i = 0; i < pt->pt_argc; i++)
6545 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6546 }
6547 }
6548 partial_unref(ret_pt);
6549 }
6550 rettv->v_type = VAR_PARTIAL;
6551 rettv->vval.v_partial = pt;
6552 }
6553 }
6554 return selfdict;
6555}
6556
6557/*
6558 * Return the name of the executed function.
6559 */
6560 char_u *
6561func_name(void *cookie)
6562{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006563 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006564}
6565
6566/*
6567 * Return the address holding the next breakpoint line for a funccall cookie.
6568 */
6569 linenr_T *
6570func_breakpoint(void *cookie)
6571{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006572 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006573}
6574
6575/*
6576 * Return the address holding the debug tick for a funccall cookie.
6577 */
6578 int *
6579func_dbg_tick(void *cookie)
6580{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006581 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006582}
6583
6584/*
6585 * Return the nesting level for a funccall cookie.
6586 */
6587 int
6588func_level(void *cookie)
6589{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006590 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006591}
6592
6593/*
6594 * Return TRUE when a function was ended by a ":return" command.
6595 */
6596 int
6597current_func_returned(void)
6598{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006599 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006600}
6601
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006602 int
6603free_unref_funccal(int copyID, int testing)
6604{
6605 int did_free = FALSE;
6606 int did_free_funccal = FALSE;
6607 funccall_T *fc, **pfc;
6608
6609 for (pfc = &previous_funccal; *pfc != NULL; )
6610 {
6611 if (can_free_funccal(*pfc, copyID))
6612 {
6613 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006614 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006615 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006616 did_free = TRUE;
6617 did_free_funccal = TRUE;
6618 }
6619 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006620 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006621 }
6622 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006623 // When a funccal was freed some more items might be garbage
6624 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006625 (void)garbage_collect(testing);
6626
6627 return did_free;
6628}
6629
6630/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006631 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006632 */
6633 static funccall_T *
6634get_funccal(void)
6635{
6636 int i;
6637 funccall_T *funccal;
6638 funccall_T *temp_funccal;
6639
6640 funccal = current_funccal;
6641 if (debug_backtrace_level > 0)
6642 {
6643 for (i = 0; i < debug_backtrace_level; i++)
6644 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006645 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006646 if (temp_funccal)
6647 funccal = temp_funccal;
6648 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006649 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006650 debug_backtrace_level = i;
6651 }
6652 }
6653 return funccal;
6654}
6655
6656/*
6657 * Return the hashtable used for local variables in the current funccal.
6658 * Return NULL if there is no current funccal.
6659 */
6660 hashtab_T *
6661get_funccal_local_ht()
6662{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006663 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006664 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006665 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006666}
6667
6668/*
6669 * Return the l: scope variable.
6670 * Return NULL if there is no current funccal.
6671 */
6672 dictitem_T *
6673get_funccal_local_var()
6674{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006675 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006676 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006677 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006678}
6679
6680/*
6681 * Return the hashtable used for argument in the current funccal.
6682 * Return NULL if there is no current funccal.
6683 */
6684 hashtab_T *
6685get_funccal_args_ht()
6686{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006687 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006688 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006689 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006690}
6691
6692/*
6693 * Return the a: scope variable.
6694 * Return NULL if there is no current funccal.
6695 */
6696 dictitem_T *
6697get_funccal_args_var()
6698{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006699 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006700 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006701 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006702}
6703
6704/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006705 * List function variables, if there is a function.
6706 */
6707 void
6708list_func_vars(int *first)
6709{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006710 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6711 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006712 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006713}
6714
6715/*
6716 * If "ht" is the hashtable for local variables in the current funccal, return
6717 * the dict that contains it.
6718 * Otherwise return NULL.
6719 */
6720 dict_T *
6721get_current_funccal_dict(hashtab_T *ht)
6722{
6723 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006724 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6725 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006726 return NULL;
6727}
6728
6729/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006730 * Search hashitem in parent scope.
6731 */
6732 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006733find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006734{
6735 funccall_T *old_current_funccal = current_funccal;
6736 hashtab_T *ht;
6737 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006738 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006739
Bram Moolenaarca16c602022-09-06 18:57:08 +01006740 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006741 return NULL;
6742
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006743 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006744 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006745 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006746 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006747 ht = find_var_ht(name, &varname);
6748 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006749 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006750 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006751 if (!HASHITEM_EMPTY(hi))
6752 {
6753 *pht = ht;
6754 break;
6755 }
6756 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006757 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006758 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006759 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006760 }
6761 current_funccal = old_current_funccal;
6762
6763 return hi;
6764}
6765
6766/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006767 * Search variable in parent scope.
6768 */
6769 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006770find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006771{
6772 dictitem_T *v = NULL;
6773 funccall_T *old_current_funccal = current_funccal;
6774 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006775 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006776
Bram Moolenaarca16c602022-09-06 18:57:08 +01006777 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006778 return NULL;
6779
Bram Moolenaare38eab22019-12-05 21:50:01 +01006780 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006781 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006782 while (current_funccal)
6783 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006784 ht = find_var_ht(name, &varname);
6785 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006786 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006787 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006788 if (v != NULL)
6789 break;
6790 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006791 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006792 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006793 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006794 }
6795 current_funccal = old_current_funccal;
6796
6797 return v;
6798}
6799
6800/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006801 * Set "copyID + 1" in previous_funccal and callers.
6802 */
6803 int
6804set_ref_in_previous_funccal(int copyID)
6805{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006806 funccall_T *fc;
6807
Bram Moolenaarca16c602022-09-06 18:57:08 +01006808 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006809 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006810 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006811 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6812 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6813 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006814 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006815 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006816 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006817}
6818
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006819 static int
6820set_ref_in_funccal(funccall_T *fc, int copyID)
6821{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006822 if (fc->fc_copyID != copyID)
6823 {
6824 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006825 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6826 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6827 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6828 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006829 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006830 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006831 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006832}
6833
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006834/*
6835 * Set "copyID" in all local vars and arguments in the call stack.
6836 */
6837 int
6838set_ref_in_call_stack(int copyID)
6839{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006840 funccall_T *fc;
6841 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006842
Bram Moolenaarca16c602022-09-06 18:57:08 +01006843 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006844 if (set_ref_in_funccal(fc, copyID))
6845 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006846
6847 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006848 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006849 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006850 if (set_ref_in_funccal(fc, copyID))
6851 return TRUE;
6852 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006853}
6854
6855/*
6856 * Set "copyID" in all functions available by name.
6857 */
6858 int
6859set_ref_in_functions(int copyID)
6860{
6861 int todo;
6862 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006863 ufunc_T *fp;
6864
6865 todo = (int)func_hashtab.ht_used;
6866 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006867 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006868 if (!HASHITEM_EMPTY(hi))
6869 {
6870 --todo;
6871 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006872 if (!func_name_refcount(fp->uf_name)
6873 && set_ref_in_func(NULL, fp, copyID))
6874 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006875 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006876 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006877 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006878}
6879
6880/*
6881 * Set "copyID" in all function arguments.
6882 */
6883 int
6884set_ref_in_func_args(int copyID)
6885{
6886 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006887
6888 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006889 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6890 copyID, NULL, NULL))
6891 return TRUE;
6892 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006893}
6894
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006895/*
6896 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006897 * Returns TRUE if setting references failed somehow.
6898 */
6899 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006900set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006901{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006902 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006903 funccall_T *fc;
Bram Moolenaar0917e862023-02-18 14:42:44 +00006904 funcerror_T error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006905 char_u fname_buf[FLEN_FIXED + 1];
6906 char_u *tofree = NULL;
6907 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006908 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006909
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006910 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006911 return FALSE;
6912
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006913 if (fp_in == NULL)
6914 {
6915 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006916 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006917 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006918 if (fp != NULL)
6919 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006920 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006921 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006922 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006923
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006924 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006925 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006926}
6927
Bram Moolenaare38eab22019-12-05 21:50:01 +01006928#endif // FEAT_EVAL