blob: e63caf9fed3daf6d2c394a7142f71263f040e211 [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
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +000039func_init(void)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040{
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);
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00001040 vim_free(trans_function_name(&p, NULL, TRUE, 0));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001041 if (*skipwhite(p) == '(')
1042 {
1043 if (nesting == MAX_FUNC_NESTING - 1)
1044 emsg(_(e_function_nesting_too_deep));
1045 else
1046 {
1047 ++nesting;
1048 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001049 nesting_inline[nesting] = FALSE;
1050 indent += 2;
1051 }
1052 }
1053 }
1054
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001055 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001056 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001057 // Not a comment line: check for nested inline function.
1058 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001059 while (end > p && VIM_ISWHITE(*end))
1060 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +02001061 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001062 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001063 int is_block;
1064
1065 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001066 --end;
1067 while (end > p && VIM_ISWHITE(*end))
1068 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001069 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
1070 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001071 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001072 char_u *s = p;
1073
1074 // check for line starting with "au" for :autocmd or
1075 // "com" for :command, these can use a {} block
1076 is_block = checkforcmd_noparen(&s, "autocmd", 2)
1077 || checkforcmd_noparen(&s, "command", 3);
1078 }
1079
1080 if (is_block)
1081 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001082 if (nesting == MAX_FUNC_NESTING - 1)
1083 emsg(_(e_function_nesting_too_deep));
1084 else
1085 {
1086 ++nesting;
1087 nesting_def[nesting] = TRUE;
1088 nesting_inline[nesting] = TRUE;
1089 indent += 2;
1090 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001091 }
1092 }
1093 }
1094
1095 // Check for ":append", ":change", ":insert". Not for :def.
1096 p = skip_range(p, FALSE, NULL);
1097 if (!vim9_function
1098 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1099 || (p[0] == 'c'
1100 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1101 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1102 && (STRNCMP(&p[3], "nge", 3) != 0
1103 || !ASCII_ISALPHA(p[6])))))))
1104 || (p[0] == 'i'
1105 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1106 && (!ASCII_ISALPHA(p[2])
1107 || (p[2] == 's'
1108 && (!ASCII_ISALPHA(p[3])
1109 || p[3] == 'e'))))))))
1110 skip_until = vim_strsave((char_u *)".");
1111
1112 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1113 arg = skipwhite(skiptowhite(p));
1114 if (arg[0] == '<' && arg[1] =='<'
1115 && ((p[0] == 'p' && p[1] == 'y'
1116 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1117 || ((p[2] == '3' || p[2] == 'x')
1118 && !ASCII_ISALPHA(p[3]))))
1119 || (p[0] == 'p' && p[1] == 'e'
1120 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1121 || (p[0] == 't' && p[1] == 'c'
1122 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1123 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1124 && !ASCII_ISALPHA(p[3]))
1125 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1126 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1127 || (p[0] == 'm' && p[1] == 'z'
1128 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1129 ))
1130 {
1131 // ":python <<" continues until a dot, like ":append"
1132 p = skipwhite(arg + 2);
1133 if (STRNCMP(p, "trim", 4) == 0)
1134 {
1135 // Ignore leading white space.
1136 p = skipwhite(p + 4);
1137 heredoc_trimmed = vim_strnsave(theline,
1138 skipwhite(theline) - theline);
1139 }
1140 if (*p == NUL)
1141 skip_until = vim_strsave((char_u *)".");
1142 else
1143 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1144 getline_options = GETLINE_NONE;
1145 is_heredoc = TRUE;
zeertzjqa93d9cd2023-05-02 16:25:47 +01001146 if (vim9_function && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001147 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001148 }
1149
Bram Moolenaard881d152022-05-13 13:50:36 +01001150 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001151 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001152 // Check for ":cmd v =<< [trim] EOF"
1153 // and ":cmd [a, b] =<< [trim] EOF"
1154 // and "lines =<< [trim] EOF" for Vim9
1155 // Where "cmd" can be "let", "var", "final" or "const".
zeertzjqa93d9cd2023-05-02 16:25:47 +01001156 arg = p;
1157 if (checkforcmd(&arg, "let", 2)
1158 || checkforcmd(&arg, "var", 3)
1159 || checkforcmd(&arg, "final", 5)
1160 || checkforcmd(&arg, "const", 5)
1161 || vim9_function)
Bram Moolenaard881d152022-05-13 13:50:36 +01001162 {
zeertzjqa93d9cd2023-05-02 16:25:47 +01001163 while (vim_strchr((char_u *)"$@&", *arg) != NULL)
1164 ++arg;
1165 arg = skipwhite(find_name_end(arg, NULL, NULL,
1166 FNE_INCL_BR | FNE_ALLOW_CURLY));
1167 if (vim9_function && *arg == ':')
1168 arg = skipwhite(skip_type(skipwhite(arg + 1), FALSE));
1169 if (arg[0] == '=' && arg[1] == '<' && arg[2] =='<')
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001170 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001171 p = skipwhite(arg + 3);
1172 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001173 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001174 if (STRNCMP(p, "trim", 4) == 0)
1175 {
1176 // Ignore leading white space.
1177 p = skipwhite(p + 4);
1178 heredoc_trimmed = vim_strnsave(theline,
1179 skipwhite(theline) - theline);
1180 continue;
1181 }
1182 if (STRNCMP(p, "eval", 4) == 0)
1183 {
1184 // Ignore leading white space.
1185 p = skipwhite(p + 4);
1186 continue;
1187 }
1188 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001189 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001190 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1191 getline_options = GETLINE_NONE;
1192 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001193 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001194 }
1195 }
1196 }
1197
1198 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001199 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001200 goto theend;
1201
Bram Moolenaar20677332021-06-06 17:02:53 +02001202 if (heredoc_concat_len > 0)
1203 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001204 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001205 // to be used for the instruction later.
1206 ga_concat(&heredoc_ga, theline);
1207 ga_concat(&heredoc_ga, (char_u *)"\n");
1208 p = vim_strsave((char_u *)"");
1209 }
1210 else
1211 {
1212 // Copy the line to newly allocated memory. get_one_sourceline()
1213 // allocates 250 bytes per line, this saves 80% on average. The
1214 // cost is an extra alloc/free.
1215 p = vim_strsave(theline);
1216 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001217 if (p == NULL)
1218 goto theend;
1219 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1220
1221 // Add NULL lines for continuation lines, so that the line count is
1222 // equal to the index in the growarray.
1223 while (sourcing_lnum_off-- > 0)
1224 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1225
1226 // Check for end of eap->arg.
1227 if (line_arg != NULL && *line_arg == NUL)
1228 line_arg = NULL;
1229 }
1230
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001231 // Return OK when no error was detected.
1232 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001233 ret = OK;
1234
1235theend:
1236 vim_free(skip_until);
1237 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001238 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001239 need_wait_return |= saved_wait_return;
1240 return ret;
1241}
1242
1243/*
1244 * Handle the body of a lambda. *arg points to the "{", process statements
1245 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001246 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001247 * When successful "rettv" is set to a funcref.
1248 */
1249 static int
1250lambda_function_body(
1251 char_u **arg,
1252 typval_T *rettv,
1253 evalarg_T *evalarg,
1254 garray_T *newargs,
1255 garray_T *argtypes,
1256 int varargs,
1257 garray_T *default_args,
1258 char_u *ret_type)
1259{
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001260 char_u *start = *arg;
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001261 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001262 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001263 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001264 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001265 exarg_T eap;
1266 garray_T newlines;
1267 char_u *cmdline = NULL;
1268 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001269 partial_T *pt;
1270 char_u *name;
1271 int lnum_save = -1;
1272 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1273
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001274 *arg = skipwhite(*arg + 1);
1275 if (**arg == '|' || !ends_excmd2(start, *arg))
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001276 {
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001277 semsg(_(e_trailing_characters_str), *arg);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001278 return FAIL;
1279 }
1280
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001281 CLEAR_FIELD(eap);
1282 eap.cmdidx = CMD_block;
1283 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001284 eap.cmdlinep = &cmdline;
1285 eap.skip = !evaluate;
1286 if (evalarg->eval_cctx != NULL)
1287 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1288 else
1289 {
1290 eap.getline = evalarg->eval_getline;
1291 eap.cookie = evalarg->eval_cookie;
1292 }
1293
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001294 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001295 if (get_function_body(&eap, &newlines, NULL,
1296 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001297 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001298
1299 // When inside a lambda must add the function lines to evalarg.eval_ga.
1300 evalarg->eval_break_count += newlines.ga_len;
1301 if (gap->ga_itemsize > 0)
1302 {
1303 int idx;
1304 char_u *last;
1305 size_t plen;
1306 char_u *pnl;
1307
1308 for (idx = 0; idx < newlines.ga_len; ++idx)
1309 {
1310 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1311
Bram Moolenaarecb66452021-05-18 15:09:18 +02001312 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001313 goto erret;
1314
1315 // Going to concatenate the lines after parsing. For an empty or
1316 // comment line use an empty string.
1317 // Insert NL characters at the start of each line, the string will
1318 // be split again later in .get_lambda_tv().
1319 if (*p == NUL || vim9_comment_start(p))
1320 p = (char_u *)"";
1321 plen = STRLEN(p);
1322 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1323 if (pnl != NULL)
1324 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001325 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1326 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001327 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001328 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001329 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001330 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001331 // more is following after the "}", which was skipped
1332 last = cmdline;
1333 else
1334 // nothing is following the "}"
1335 last = (char_u *)"}";
1336 plen = STRLEN(last);
1337 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1338 if (pnl != NULL)
1339 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001340 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1341 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001342 }
1343
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001344 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001345 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001346 garray_T *tfgap = &evalarg->eval_tofree_ga;
1347
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001348 // Something comes after the "}".
1349 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001350
1351 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001352 if (ga_grow(tfgap, 1) == OK)
1353 {
1354 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1355 evalarg->eval_using_cmdline = TRUE;
1356 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001357 }
1358 else
1359 *arg = (char_u *)"";
1360
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001361 if (!evaluate)
1362 {
1363 ret = OK;
1364 goto erret;
1365 }
1366
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001367 name = get_lambda_name();
Bram Moolenaare01e5212023-01-08 20:31:18 +00001368 ufunc = alloc_ufunc(name);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001369 if (ufunc == NULL)
1370 goto erret;
1371 set_ufunc_name(ufunc, name);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001372 if (hash_add(&func_hashtab, UF2HIKEY(ufunc), "add function") == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001373 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001374 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001375 ufunc->uf_refcount = 1;
1376 ufunc->uf_args = *newargs;
1377 newargs->ga_data = NULL;
1378 ufunc->uf_def_args = *default_args;
1379 default_args->ga_data = NULL;
1380 ufunc->uf_func_type = &t_func_any;
1381
1382 // error messages are for the first function line
1383 lnum_save = SOURCING_LNUM;
1384 SOURCING_LNUM = sourcing_lnum_top;
1385
1386 // parse argument types
1387 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1388 {
1389 SOURCING_LNUM = lnum_save;
1390 goto erret;
1391 }
1392
1393 // parse the return type, if any
1394 if (parse_return_type(ufunc, ret_type) == FAIL)
1395 goto erret;
1396
1397 pt = ALLOC_CLEAR_ONE(partial_T);
1398 if (pt == NULL)
1399 goto erret;
1400 pt->pt_func = ufunc;
1401 pt->pt_refcount = 1;
1402
1403 ufunc->uf_lines = newlines;
1404 newlines.ga_data = NULL;
1405 if (sandbox)
1406 ufunc->uf_flags |= FC_SANDBOX;
1407 if (!ASCII_ISUPPER(*ufunc->uf_name))
1408 ufunc->uf_flags |= FC_VIM9;
1409 ufunc->uf_script_ctx = current_sctx;
1410 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1411 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1412 set_function_type(ufunc);
1413
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001414 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1415
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001416 rettv->vval.v_partial = pt;
1417 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001418 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001419 ret = OK;
1420
1421erret:
1422 if (lnum_save >= 0)
1423 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001424 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001425 if (newargs != NULL)
1426 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001427 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001428 if (ufunc != NULL)
1429 {
1430 func_clear(ufunc, TRUE);
1431 func_free(ufunc, TRUE);
1432 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001433 return ret;
1434}
1435
1436/*
1437 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001438 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001439 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1441 */
1442 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001443get_lambda_tv(
1444 char_u **arg,
1445 typval_T *rettv,
1446 int types_optional,
1447 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001449 int evaluate = evalarg != NULL
1450 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001451 garray_T newargs;
1452 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001453 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001454 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001455 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001457 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001458 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001459 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001461 char_u *s;
1462 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001463 int *old_eval_lavars = eval_lavars_used;
1464 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001465 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001466 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001467 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001468 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001469 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001470 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001471
Bram Moolenaar4525a572022-02-13 11:57:33 +00001472 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001473 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474
1475 ga_init(&newargs);
1476 ga_init(&newlines);
1477
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001478 // First, check if this is really a lambda expression. "->" or "=>" must
1479 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001480 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001481 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001482 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001483 NULL, &default_args, TRUE, NULL, FALSE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001484 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001485 {
1486 if (types_optional)
1487 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001488 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001489 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001490
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001491 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001492 if (evaluate)
1493 pnewargs = &newargs;
1494 else
1495 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001496 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001497 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001498 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001499 &varargs, &default_args,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001500 FALSE, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001501 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001502 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001503 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001504 {
1505 if (types_optional)
1506 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001507 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001508 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001509 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001510 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001512 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1513 if (ret_type != NULL)
1514 {
1515 ret_type = vim_strsave(ret_type);
1516 tofree2 = ret_type;
1517 }
1518
Bram Moolenaare38eab22019-12-05 21:50:01 +01001519 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001520 if (evaluate)
1521 eval_lavars_used = &eval_lavars;
1522
Bram Moolenaar65c44152020-12-24 15:14:01 +01001523 *arg = skipwhite_and_linebreak(*arg, evalarg);
1524
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001525 // Recognize "{" as the start of a function body.
1526 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001527 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001528 if (evalarg == NULL)
1529 // cannot happen?
1530 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001531 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001532 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1533 types_optional ? &argtypes : NULL, varargs,
1534 &default_args, ret_type) == FAIL)
1535 goto errret;
1536 goto theend;
1537 }
1538 if (default_args.ga_len > 0)
1539 {
1540 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001541 goto errret;
1542 }
1543
Bram Moolenaare38eab22019-12-05 21:50:01 +01001544 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001545 start = *arg;
1546 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001547 if (ret == FAIL)
1548 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001549
Bram Moolenaar65c44152020-12-24 15:14:01 +01001550 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001551 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001552 *arg = skipwhite_and_linebreak(*arg, evalarg);
1553 if (**arg != '}')
1554 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001555 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001556 goto errret;
1557 }
1558 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001559 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560
1561 if (evaluate)
1562 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001563 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001564 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001565 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001566 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001567 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001568
Bram Moolenaare01e5212023-01-08 20:31:18 +00001569 fp = alloc_ufunc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570 if (fp == NULL)
1571 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001572 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001573 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001574 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001575 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001577 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001578 if (ga_grow(&newlines, 1) == FAIL)
1579 goto errret;
1580
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001581 // If there are line breaks, we need to split up the string.
1582 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001583 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001584 line_end = end;
1585
1586 // Add "return " before the expression (or the first line).
1587 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001588 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001589 if (p == NULL)
1590 goto errret;
1591 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1592 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001593 vim_strncpy(p + 7, start, line_end - start);
1594
1595 if (line_end != end)
1596 {
1597 // Add more lines, split by line breaks. Thus is used when a
1598 // lambda with { cmds } is encountered.
1599 while (*line_end == '\n')
1600 {
1601 if (ga_grow(&newlines, 1) == FAIL)
1602 goto errret;
1603 start = line_end + 1;
1604 line_end = vim_strchr(start, '\n');
1605 if (line_end == NULL)
1606 line_end = end;
1607 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1608 vim_strnsave(start, line_end - start);
1609 }
1610 }
1611
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001612 if (strstr((char *)p + 7, "a:") == NULL)
1613 // No a: variables are used for sure.
1614 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615
1616 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001617 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001619 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001620 if (types_optional)
1621 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001622 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001623 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001624 goto errret;
1625 if (ret_type != NULL)
1626 {
1627 fp->uf_ret_type = parse_type(&ret_type,
1628 &fp->uf_type_list, TRUE);
1629 if (fp->uf_ret_type == NULL)
1630 goto errret;
1631 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001632 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001633 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001634 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001635
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001637 if (current_funccal != NULL && eval_lavars)
1638 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001639 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001640 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001641 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001643
1644#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645 if (prof_def_func())
1646 func_do_profile(fp);
1647#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001648 if (sandbox)
1649 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001650 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001651 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001652 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001653 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001655 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001656 // Use the line number of the arguments.
1657 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001659 function_using_block_scopes(fp, evalarg->eval_cstack);
1660
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001661 pt->pt_func = fp;
1662 pt->pt_refcount = 1;
1663 rettv->vval.v_partial = pt;
1664 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001665
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001666 hash_add(&func_hashtab, UF2HIKEY(fp), "add lambda");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001667 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001668
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001669theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001670 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001671 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001672 if (types_optional)
1673 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001674
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 return OK;
1676
1677errret:
1678 ga_clear_strings(&newargs);
1679 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001680 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001681 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001682 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001683 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001684 if (fp != NULL)
1685 vim_free(fp->uf_arg_types);
1686 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001687 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001688 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001689 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001690 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 return FAIL;
1692}
1693
1694/*
1695 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1696 * name it contains, otherwise return "name".
1697 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1698 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001699 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1700 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001701 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001702 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001703 */
1704 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001705deref_func_name(
1706 char_u *name,
1707 int *lenp,
1708 partial_T **partialp,
1709 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001710 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001711 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001712 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713{
1714 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001715 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001716 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001717 char_u *s = NULL;
1718 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001719 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720
1721 if (partialp != NULL)
1722 *partialp = NULL;
1723
1724 cc = name[*lenp];
1725 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001726
Bram Moolenaar71f21932022-01-07 18:20:55 +00001727 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001728 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001729 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001730 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001731 tv = &v->di_tv;
1732 }
1733 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1734 {
1735 imported_T *import;
1736 char_u *p = name;
1737 int len = *lenp;
1738
1739 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001741 p = name + 2;
1742 len -= 2;
1743 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001744 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001745
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001746 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001747 if (import != NULL)
1748 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001749 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001750 if (new_function)
1751 semsg(_(e_redefining_imported_item_str), name);
1752 else
1753 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001754 name[len] = cc;
1755 *lenp = 0;
1756 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001757 }
1758 }
1759
1760 if (tv != NULL)
1761 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001762 if (found_var != NULL)
1763 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001764 if (tv->v_type == VAR_FUNC)
1765 {
1766 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001767 {
1768 *lenp = 0;
1769 return (char_u *)""; // just in case
1770 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001771 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001772 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001774
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001775 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001777 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001778
1779 if (pt == NULL)
1780 {
1781 *lenp = 0;
1782 return (char_u *)""; // just in case
1783 }
1784 if (partialp != NULL)
1785 *partialp = pt;
1786 s = partial_name(pt);
1787 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001789
1790 if (s != NULL)
1791 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001792 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001793 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001794 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001795
1796 if (sv != NULL)
1797 *type = sv->sv_type;
1798 }
1799 return s;
1800 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001801 }
1802
1803 return name;
1804}
1805
1806/*
1807 * Give an error message with a function name. Handle <SNR> things.
1808 * "ermsg" is to be passed without translation, use N_() instead of _().
1809 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001810 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811emsg_funcname(char *ermsg, char_u *name)
1812{
Bram Moolenaar54598062022-01-13 12:05:09 +00001813 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001814
Bram Moolenaar54598062022-01-13 12:05:09 +00001815 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001817 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818 if (p != name)
1819 vim_free(p);
1820}
1821
1822/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001823 * Get function arguments at "*arg" and advance it.
1824 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001825 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826 */
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001827 int
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001828get_func_arguments(
1829 char_u **arg,
1830 evalarg_T *evalarg,
1831 int partial_argc,
1832 typval_T *argvars,
1833 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001835 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001836 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001837 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001838 int evaluate = evalarg == NULL
1839 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001840
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001841 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001842 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001843 // skip the '(' or ',' and possibly line breaks
1844 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1845
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001846 if (*argp == ')' || *argp == ',' || *argp == NUL)
1847 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001848 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849 {
1850 ret = FAIL;
1851 break;
1852 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001853 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001854 // The comma should come right after the argument, but this wasn't
1855 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001856 if (vim9script)
1857 {
1858 if (*argp != ',' && *skipwhite(argp) == ',')
1859 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001860 if (evaluate)
1861 semsg(_(e_no_white_space_allowed_before_str_str),
1862 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001863 ret = FAIL;
1864 break;
1865 }
1866 }
1867 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001868 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001869 if (*argp != ',')
1870 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001871 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1872 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001873 if (evaluate)
1874 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001875 ret = FAIL;
1876 break;
1877 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001878 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001879
Bram Moolenaare6b53242020-07-01 17:28:33 +02001880 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001881 if (*argp == ')')
1882 ++argp;
1883 else
1884 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001885 *arg = argp;
1886 return ret;
1887}
1888
1889/*
1890 * Call a function and put the result in "rettv".
1891 * Return OK or FAIL.
1892 */
1893 int
1894get_func_tv(
1895 char_u *name, // name of the function
1896 int len, // length of "name" or -1 to use strlen()
1897 typval_T *rettv,
1898 char_u **arg, // argument, pointing to the '('
1899 evalarg_T *evalarg, // for line continuation
1900 funcexe_T *funcexe) // various values
1901{
1902 char_u *argp;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001903 int ret;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001904 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1905 int argcount = 0; // number of arguments found
1906 int vim9script = in_vim9script();
1907 int evaluate = evalarg == NULL
1908 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1909
1910 argp = *arg;
1911 ret = get_func_arguments(&argp, evalarg,
1912 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1913 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001914
1915 if (ret == OK)
1916 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001917 int i = 0;
1918 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919
1920 if (get_vim_var_nr(VV_TESTING))
1921 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001922 // Prepare for calling test_garbagecollect_now(), need to know
1923 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001924 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001925 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001926 for (i = 0; i < argcount; ++i)
1927 if (ga_grow(&funcargs, 1) == OK)
1928 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1929 &argvars[i];
1930 }
1931
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001932 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001933 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001934 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001935 // An error in a builtin function does not return FAIL, but we do
1936 // want to abort further processing if an error was given.
1937 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001938 clear_tv(rettv);
1939 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001940
1941 funcargs.ga_len -= i;
1942 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001943 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001944 {
1945 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001946 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001948 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001949 }
1950
1951 while (--argcount >= 0)
1952 clear_tv(&argvars[argcount]);
1953
Bram Moolenaar4525a572022-02-13 11:57:33 +00001954 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001955 *arg = argp;
1956 else
1957 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001958 return ret;
1959}
1960
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961/*
1962 * Return TRUE if "p" starts with "<SID>" or "s:".
1963 * Only works if eval_fname_script() returned non-zero for "p"!
1964 */
1965 static int
1966eval_fname_sid(char_u *p)
1967{
1968 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1969}
1970
1971/*
1972 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1973 * Change <SNR>123_name() to K_SNR 123_name().
1974 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001975 * and set "tofree".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001976 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001977 char_u *
Bram Moolenaar0917e862023-02-18 14:42:44 +00001978fname_trans_sid(
1979 char_u *name,
1980 char_u *fname_buf,
1981 char_u **tofree,
1982 funcerror_T *error)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001983{
1984 int llen;
1985 char_u *fname;
1986 int i;
1987
1988 llen = eval_fname_script(name);
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001989 if (llen == 0)
1990 return name; // no prefix
1991
1992 fname_buf[0] = K_SPECIAL;
1993 fname_buf[1] = KS_EXTRA;
1994 fname_buf[2] = (int)KE_SNR;
1995 i = 3;
1996 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001997 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001998 if (current_sctx.sc_sid <= 0)
1999 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002000 else
2001 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01002002 sprintf((char *)fname_buf + 3, "%ld_",
2003 (long)current_sctx.sc_sid);
2004 i = (int)STRLEN(fname_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002005 }
2006 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01002007 if (i + STRLEN(name + llen) < FLEN_FIXED)
2008 {
2009 STRCPY(fname_buf + i, name + llen);
2010 fname = fname_buf;
2011 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002012 else
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01002013 {
2014 fname = alloc(i + STRLEN(name + llen) + 1);
2015 if (fname == NULL)
2016 *error = FCERR_OTHER;
2017 else
2018 {
2019 *tofree = fname;
2020 mch_memmove(fname, fname_buf, (size_t)i);
2021 STRCPY(fname + i, name + llen);
2022 }
2023 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002024 return fname;
2025}
2026
2027/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002028 * Concatenate the script ID and function name into "<SNR>99_name".
2029 * "buffer" must have size MAX_FUNC_NAME_LEN.
2030 */
2031 void
2032func_name_with_sid(char_u *name, int sid, char_u *buffer)
2033{
2034 // A script-local function is stored as "<SNR>99_name".
2035 buffer[0] = K_SPECIAL;
2036 buffer[1] = KS_EXTRA;
2037 buffer[2] = (int)KE_SNR;
2038 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
2039 (long)sid, name);
2040}
2041
2042/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002043 * Find a function "name" in script "sid".
2044 */
2045 static ufunc_T *
2046find_func_with_sid(char_u *name, int sid)
2047{
Bram Moolenaarb8822442022-01-11 15:24:05 +00002048 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002049 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002050
Bram Moolenaarb8822442022-01-11 15:24:05 +00002051 if (!SCRIPT_ID_VALID(sid))
2052 return NULL; // not in a script
2053
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002054 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002055 hi = hash_find(&func_hashtab, buffer);
2056 if (!HASHITEM_EMPTY(hi))
2057 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002058 return NULL;
2059}
2060
2061/*
2062 * Find a function "name" in script "sid" prefixing the autoload prefix.
2063 */
2064 static ufunc_T *
2065find_func_with_prefix(char_u *name, int sid)
2066{
2067 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01002068 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00002069 scriptitem_T *si;
2070
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002071 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00002072 return NULL; // already has the prefix
2073 if (!SCRIPT_ID_VALID(sid))
2074 return NULL; // not in a script
2075 si = SCRIPT_ITEM(sid);
2076 if (si->sn_autoload_prefix != NULL)
2077 {
2078 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
2079 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002080 char_u *namep;
2081
2082 // skip a "<SNR>99_" prefix
2083 namep = untrans_function_name(name);
2084 if (namep == NULL)
2085 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00002086
2087 // An exported function in an autoload script is stored as
2088 // "dir#path#name".
2089 if (len < sizeof(buffer))
2090 auto_name = buffer;
2091 else
2092 auto_name = alloc(len);
2093 if (auto_name != NULL)
2094 {
2095 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002096 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002097 hi = hash_find(&func_hashtab, auto_name);
2098 if (auto_name != buffer)
2099 vim_free(auto_name);
2100 if (!HASHITEM_EMPTY(hi))
2101 return HI2UF(hi);
2102 }
2103 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002104
2105 return NULL;
2106}
2107
2108/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002109 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002110 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2111 * functions.
2112 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002113 * Return NULL for unknown function.
2114 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002115 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002116find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002117{
2118 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002119 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002120
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002121 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002122 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002123 // Find script-local function before global one.
2124 if (in_vim9script() && eval_isnamec1(*name)
2125 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002126 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002127 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2128 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002129 if (func != NULL)
2130 return func;
2131 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002132 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2133 {
2134 char_u *p = name + 5;
2135 long sid;
2136
2137 // printable "<SNR>123_Name" form
2138 sid = getdigits(&p);
2139 if (*p == '_')
2140 {
2141 func = find_func_with_sid(p + 1, (int)sid);
2142 if (func != NULL)
2143 return func;
2144 }
2145 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002146 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002147
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002148 if ((flags & FFED_NO_GLOBAL) == 0)
2149 {
2150 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002151 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002152 if (!HASHITEM_EMPTY(hi))
2153 return HI2UF(hi);
2154 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002155
Bram Moolenaarb8822442022-01-11 15:24:05 +00002156 // Find autoload function if this is an autoload script.
2157 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2158 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002159}
2160
2161/*
2162 * Find a function by name, return pointer to it in ufuncs.
2163 * "cctx" is passed in a :def function to find imported functions.
2164 * Return NULL for unknown or dead function.
2165 */
2166 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002167find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002168{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002169 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002170
2171 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2172 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002173 return NULL;
2174}
2175
2176/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002177 * Return TRUE if "ufunc" is a global function.
2178 */
2179 int
2180func_is_global(ufunc_T *ufunc)
2181{
2182 return ufunc->uf_name[0] != K_SPECIAL;
2183}
2184
2185/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002186 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2187 */
2188 int
2189func_requires_g_prefix(ufunc_T *ufunc)
2190{
2191 return ufunc->uf_name[0] != K_SPECIAL
2192 && (ufunc->uf_flags & FC_LAMBDA) == 0
Bram Moolenaarcfb4d4f2022-09-30 19:19:04 +01002193 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL
2194 && !isdigit(ufunc->uf_name[0]);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002195}
2196
2197/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002198 * Copy the function name of "fp" to buffer "buf".
2199 * "buf" must be able to hold the function name plus three bytes.
2200 * Takes care of script-local function names.
2201 */
2202 static void
2203cat_func_name(char_u *buf, ufunc_T *fp)
2204{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002205 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002206 {
2207 STRCPY(buf, "<SNR>");
2208 STRCAT(buf, fp->uf_name + 3);
2209 }
2210 else
2211 STRCPY(buf, fp->uf_name);
2212}
2213
2214/*
2215 * Add a number variable "name" to dict "dp" with value "nr".
2216 */
2217 static void
2218add_nr_var(
2219 dict_T *dp,
2220 dictitem_T *v,
2221 char *name,
2222 varnumber_T nr)
2223{
2224 STRCPY(v->di_key, name);
2225 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002226 hash_add(&dp->dv_hashtab, DI2HIKEY(v), "add variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002227 v->di_tv.v_type = VAR_NUMBER;
2228 v->di_tv.v_lock = VAR_FIXED;
2229 v->di_tv.vval.v_number = nr;
2230}
2231
2232/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002233 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002234 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002235 static void
2236free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002237{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002238 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002239
Bram Moolenaarca16c602022-09-06 18:57:08 +01002240 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002241 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002242 ufunc_T *fp = ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002243
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002244 // When garbage collecting a funccall_T may be freed before the
2245 // function that references it, clear its uf_scoped field.
2246 // The function may have been redefined and point to another
2247 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002248 if (fp != NULL && fp->uf_scoped == fc)
2249 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002250 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002251 ga_clear(&fc->fc_ufuncs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002252
Bram Moolenaarca16c602022-09-06 18:57:08 +01002253 func_ptr_unref(fc->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002254 vim_free(fc);
2255}
2256
2257/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002258 * Free "fc" and what it contains.
2259 * Can be called only when "fc" is kept beyond the period of it called,
2260 * i.e. after cleanup_function_call(fc).
2261 */
2262 static void
2263free_funccal_contents(funccall_T *fc)
2264{
2265 listitem_T *li;
2266
2267 // Free all l: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002268 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002269
2270 // Free all a: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002271 vars_clear(&fc->fc_l_avars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002272
2273 // Free the a:000 variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002274 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002275 clear_tv(&li->li_tv);
2276
2277 free_funccal(fc);
2278}
2279
2280/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002281 * Handle the last part of returning from a function: free the local hashtable.
2282 * Unless it is still in use by a closure.
2283 */
2284 static void
2285cleanup_function_call(funccall_T *fc)
2286{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002287 int may_free_fc = fc->fc_refcount <= 0;
2288 int free_fc = TRUE;
2289
Bram Moolenaarca16c602022-09-06 18:57:08 +01002290 current_funccal = fc->fc_caller;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002291
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002292 // Free all l: variables if not referred.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002293 if (may_free_fc && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT)
2294 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002295 else
2296 free_fc = FALSE;
2297
2298 // If the a:000 list and the l: and a: dicts are not referenced and
2299 // there is no closure using it, we can free the funccall_T and what's
2300 // in it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002301 if (may_free_fc && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)
2302 vars_clear_ext(&fc->fc_l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002303 else
2304 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002305 int todo;
2306 hashitem_T *hi;
2307 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002308
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002309 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002310
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002311 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002312 todo = (int)fc->fc_l_avars.dv_hashtab.ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002313 FOR_ALL_HASHTAB_ITEMS(&fc->fc_l_avars.dv_hashtab, hi, todo)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002314 {
2315 if (!HASHITEM_EMPTY(hi))
2316 {
2317 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002318 di = HI2DI(hi);
2319 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002320 }
2321 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002322 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002323
Bram Moolenaarca16c602022-09-06 18:57:08 +01002324 if (may_free_fc && fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2325 fc->fc_l_varlist.lv_first = NULL;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002326 else
2327 {
2328 listitem_T *li;
2329
2330 free_fc = FALSE;
2331
2332 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002333 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002334 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002335 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002336
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002337 if (free_fc)
2338 free_funccal(fc);
2339 else
2340 {
2341 static int made_copy = 0;
2342
2343 // "fc" is still in use. This can happen when returning "a:000",
2344 // assigning "l:" to a global variable or defining a closure.
2345 // Link "fc" in the list for garbage collection later.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002346 fc->fc_caller = previous_funccal;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002347 previous_funccal = fc;
2348
2349 if (want_garbage_collect)
2350 // If garbage collector is ready, clear count.
2351 made_copy = 0;
2352 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002353 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002354 // We have made a lot of copies, worth 4 Mbyte. This can happen
2355 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002356 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002357 // too much memory.
2358 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002359 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002360 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002361 }
2362}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002363
2364/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002365 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2366 */
2367 static int
2368numbered_function(char_u *name)
2369{
2370 return isdigit(*name)
2371 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2372}
2373
2374/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002375 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002376 * 1. ordinary names, function defined with :function or :def;
2377 * can start with "<SNR>123_" literally or with K_SPECIAL.
2378 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002379 * For the first we only count the name stored in func_hashtab as a reference,
2380 * using function() does not count as a reference, because the function is
2381 * looked up by name.
2382 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002383 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002384func_name_refcount(char_u *name)
2385{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002386 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002387}
2388
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002389/*
2390 * Unreference "fc": decrement the reference count and free it when it
2391 * becomes zero. "fp" is detached from "fc".
2392 * When "force" is TRUE we are exiting.
2393 */
2394 static void
2395funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2396{
2397 funccall_T **pfc;
2398 int i;
2399
2400 if (fc == NULL)
2401 return;
2402
2403 if (--fc->fc_refcount <= 0 && (force || (
Bram Moolenaarca16c602022-09-06 18:57:08 +01002404 fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT
2405 && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT
2406 && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2407 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->fc_caller)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002408 {
2409 if (fc == *pfc)
2410 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002411 *pfc = fc->fc_caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002412 free_funccal_contents(fc);
2413 return;
2414 }
2415 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002416 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
2417 if (((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] == fp)
2418 ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002419}
2420
2421/*
2422 * Remove the function from the function hashtable. If the function was
2423 * deleted while it still has references this was already done.
2424 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2425 */
2426 static int
2427func_remove(ufunc_T *fp)
2428{
2429 hashitem_T *hi;
2430
2431 // Return if it was already virtually deleted.
2432 if (fp->uf_flags & FC_DEAD)
2433 return FALSE;
2434
2435 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00002436 if (HASHITEM_EMPTY(hi))
2437 return FALSE;
2438
2439 // When there is a def-function index do not actually remove the
2440 // function, so we can find the index when defining the function again.
2441 // Do remove it when it's a copy.
2442 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002443 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00002444 fp->uf_flags |= FC_DEAD;
2445 return FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002446 }
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00002447 hash_remove(&func_hashtab, hi, "remove function");
2448 fp->uf_flags |= FC_DELETED;
2449 return TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002450}
2451
2452 static void
2453func_clear_items(ufunc_T *fp)
2454{
2455 ga_clear_strings(&(fp->uf_args));
2456 ga_clear_strings(&(fp->uf_def_args));
2457 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002458 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002459 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002460 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002461 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002462
2463 // Increment the refcount of this function to avoid it being freed
2464 // recursively when the partial is freed.
2465 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002466 partial_unref(fp->uf_partial);
2467 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002468 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002469
2470#ifdef FEAT_LUA
2471 if (fp->uf_cb_free != NULL)
2472 {
2473 fp->uf_cb_free(fp->uf_cb_state);
2474 fp->uf_cb_free = NULL;
2475 }
2476
2477 fp->uf_cb_state = NULL;
2478 fp->uf_cb = NULL;
2479#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002480#ifdef FEAT_PROFILE
2481 VIM_CLEAR(fp->uf_tml_count);
2482 VIM_CLEAR(fp->uf_tml_total);
2483 VIM_CLEAR(fp->uf_tml_self);
2484#endif
2485}
2486
2487/*
2488 * Free all things that a function contains. Does not free the function
2489 * itself, use func_free() for that.
2490 * When "force" is TRUE we are exiting.
2491 */
2492 static void
2493func_clear(ufunc_T *fp, int force)
2494{
2495 if (fp->uf_cleared)
2496 return;
2497 fp->uf_cleared = TRUE;
2498
2499 // clear this function
2500 func_clear_items(fp);
2501 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002502 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002503}
2504
2505/*
2506 * Free a function and remove it from the list of functions. Does not free
2507 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002508 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002509 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002510 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002511 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002512func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002513{
2514 // Only remove it when not done already, otherwise we would remove a newer
2515 // version of the function with the same name.
2516 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2517 func_remove(fp);
2518
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002519 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002520 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002521 if (fp->uf_dfunc_idx > 0)
2522 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002523 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002524 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002525 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002526 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002527 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002528}
2529
2530/*
2531 * Free all things that a function contains and free the function itself.
2532 * When "force" is TRUE we are exiting.
2533 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002534 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002535func_clear_free(ufunc_T *fp, int force)
2536{
2537 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002538 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2539 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002540 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002541 else
2542 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002543}
2544
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002545/*
2546 * Copy already defined function "lambda" to a new function with name "global".
2547 * This is for when a compiled function defines a global function.
2548 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002549 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002550copy_lambda_to_global_func(
Bram Moolenaarcc341812022-09-19 15:54:34 +01002551 char_u *lambda,
2552 char_u *global,
2553 loopvarinfo_T *loopvarinfo,
2554 ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002555{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002556 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002557 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002558
2559 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002560 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002561 semsg(_(e_lambda_function_not_found_str), lambda);
2562 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002563 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002564
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002565 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002566 if (fp != NULL)
2567 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002568 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002569 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002570 return FAIL;
2571 }
2572
Bram Moolenaare01e5212023-01-08 20:31:18 +00002573 fp = alloc_ufunc(global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002574 if (fp == NULL)
2575 return FAIL;
2576
2577 fp->uf_varargs = ufunc->uf_varargs;
2578 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2579 fp->uf_def_status = ufunc->uf_def_status;
2580 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2581 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2582 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2583 == FAIL
2584 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2585 goto failed;
2586
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002587 if (ufunc->uf_arg_types != NULL)
2588 {
2589 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2590 if (fp->uf_arg_types == NULL)
2591 goto failed;
2592 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2593 sizeof(type_T *) * fp->uf_args.ga_len);
2594 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002595 if (ufunc->uf_va_name != NULL)
2596 {
2597 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2598 if (fp->uf_va_name == NULL)
2599 goto failed;
2600 }
2601 fp->uf_ret_type = ufunc->uf_ret_type;
2602
2603 fp->uf_refcount = 1;
Bram Moolenaarc8ab30a2023-01-09 11:35:47 +00002604
2605 fp->uf_name_exp = NULL;
2606 set_ufunc_name(fp, global);
2607
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002608 hash_add(&func_hashtab, UF2HIKEY(fp), "copy lambda");
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002609
2610 // the referenced dfunc_T is now used one more time
2611 link_def_function(fp);
2612
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002613 // Create a partial to store the context of the function where it was
2614 // instantiated. Only needs to be done once. Do this on the original
2615 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002616 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2617 {
2618 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2619
2620 if (pt == NULL)
2621 goto failed;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002622 if (fill_partial_and_closure(pt, ufunc, loopvarinfo, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002623 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002624 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002625 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002626 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002627 ufunc->uf_partial = pt;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002628 }
2629
2630 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002631
2632failed:
2633 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002634 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002635}
2636
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002637static int funcdepth = 0;
2638
2639/*
2640 * Increment the function call depth count.
2641 * Return FAIL when going over 'maxfuncdepth'.
2642 * Otherwise return OK, must call funcdepth_decrement() later!
2643 */
2644 int
2645funcdepth_increment(void)
2646{
2647 if (funcdepth >= p_mfd)
2648 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002649 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002650 return FAIL;
2651 }
2652 ++funcdepth;
2653 return OK;
2654}
2655
2656 void
2657funcdepth_decrement(void)
2658{
2659 --funcdepth;
2660}
2661
2662/*
2663 * Get the current function call depth.
2664 */
2665 int
2666funcdepth_get(void)
2667{
2668 return funcdepth;
2669}
2670
2671/*
2672 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002673 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002674 * times as funcdepth_increment().
2675 */
2676 void
2677funcdepth_restore(int depth)
2678{
2679 funcdepth = depth;
2680}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002681
2682/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002683 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2684 * "rettv".
2685 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2686 * Returns NULL when allocation fails.
2687 */
2688 funccall_T *
2689create_funccal(ufunc_T *fp, typval_T *rettv)
2690{
2691 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2692
2693 if (fc == NULL)
2694 return NULL;
2695 fc->fc_caller = current_funccal;
2696 current_funccal = fc;
2697 fc->fc_func = fp;
2698 func_ptr_ref(fp);
2699 fc->fc_rettv = rettv;
2700 return fc;
2701}
2702
2703/*
2704 * To be called when returning from a compiled function; restores
2705 * current_funccal.
2706 */
2707 void
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +00002708remove_funccal(void)
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002709{
2710 funccall_T *fc = current_funccal;
2711
2712 current_funccal = fc->fc_caller;
2713 free_funccal(fc);
2714}
2715
2716/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002717 * Call a user function.
2718 */
Bram Moolenaar0917e862023-02-18 14:42:44 +00002719 static funcerror_T
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002721 ufunc_T *fp, // pointer to function
2722 int argcount, // nr of args
2723 typval_T *argvars, // arguments
2724 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002725 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002726 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002727{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002728 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002729 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002730 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002731 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002732 funccall_T *fc;
2733 int save_did_emsg;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002734 funcerror_T retval = FCERR_NONE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002735 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002736 dictitem_T *v;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002737 int fixvar_idx = 0; // index in fc_fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002738 int i;
2739 int ai;
2740 int islambda = FALSE;
2741 char_u numbuf[NUMBUFLEN];
2742 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002743 typval_T *tv_to_free[MAX_FUNC_ARGS];
2744 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002745#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002746 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747#endif
ichizok7e5fe382023-04-15 13:17:50 +01002748 ESTACK_CHECK_DECLARATION;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002749
Bram Moolenaarb2049902021-01-24 12:53:53 +01002750#ifdef FEAT_PROFILE
2751 CLEAR_FIELD(profile_info);
2752#endif
2753
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002754 // If depth of calling is getting too high, don't execute the function.
2755 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757 rettv->v_type = VAR_NUMBER;
2758 rettv->vval.v_number = -1;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002759 return FCERR_FAILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761
Bram Moolenaare38eab22019-12-05 21:50:01 +01002762 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002764 fc = create_funccal(fp, rettv);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002765 if (fc == NULL)
Bram Moolenaar0917e862023-02-18 14:42:44 +00002766 return FCERR_OTHER;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002767 fc->fc_level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002768 // Check if this function has a breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002769 fc->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2770 fc->fc_dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002771 // Set up fields for closure.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002772 ga_init2(&fc->fc_ufuncs, sizeof(ufunc_T *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002774 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002775 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002776#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01002777 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002778#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002779 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002780#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002781 if (do_profiling == PROF_YES)
2782 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002783#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002784 sticky_cmdmod_flags = 0;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002785 if (call_def_function(fp, argcount, argvars, 0,
2786 funcexe->fe_partial, funcexe->fe_object, fc, rettv) == FAIL)
2787 retval = FCERR_FAILED;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002788 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002789#ifdef FEAT_PROFILE
2790 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002791 || (caller != NULL && caller->uf_profiling)))
2792 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002793#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002794 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002795 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar0917e862023-02-18 14:42:44 +00002796 return retval;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002797 }
2798
Bram Moolenaar38453522021-11-28 22:00:12 +00002799 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800
2801 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002802 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2803 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2804 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 */
2806 /*
2807 * Init l: variables.
2808 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002809 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 if (selfdict != NULL)
2811 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002812 // Set l:self to "selfdict". Use "name" to avoid a warning from
2813 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002814 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 name = v->di_key;
2816 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002817 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002818 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v), "set self dictionary");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 v->di_tv.v_type = VAR_DICT;
2820 v->di_tv.v_lock = 0;
2821 v->di_tv.vval.v_dict = selfdict;
2822 ++selfdict->dv_refcount;
2823 }
2824
2825 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002826 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002827 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828 * Set a:000 to a list with room for the "..." arguments.
2829 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002830 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002831 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002832 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002833 (varnumber_T)(argcount >= fp->uf_args.ga_len
2834 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002835 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002836 if ((fp->uf_flags & FC_NOARGS) == 0)
2837 {
2838 // Use "name" to avoid a warning from some compiler that checks the
2839 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002840 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002841 name = v->di_key;
2842 STRCPY(name, "000");
2843 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002844 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v), "function argument");
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002845 v->di_tv.v_type = VAR_LIST;
2846 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002847 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002848 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002849 CLEAR_FIELD(fc->fc_l_varlist);
2850 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2851 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852
2853 /*
2854 * Set a:firstline to "firstline" and a:lastline to "lastline".
2855 * Set a:name to named arguments.
2856 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002857 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002859 if ((fp->uf_flags & FC_NOARGS) == 0)
2860 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002861 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2862 "firstline", (varnumber_T)funcexe->fe_firstline);
2863 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2864 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002865 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002866 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867 {
2868 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002869 typval_T def_rettv;
2870 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871
2872 ai = i - fp->uf_args.ga_len;
2873 if (ai < 0)
2874 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002875 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 name = FUNCARG(fp, i);
2877 if (islambda)
2878 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002879
2880 // evaluate named argument default expression
2881 isdefault = ai + fp->uf_def_args.ga_len >= 0
2882 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2883 && argvars[i].vval.v_number == VVAL_NONE));
2884 if (isdefault)
2885 {
2886 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002887
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002888 def_rettv.v_type = VAR_NUMBER;
2889 def_rettv.vval.v_number = -1;
2890
2891 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2892 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002893 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002894 {
2895 default_arg_err = 1;
2896 break;
2897 }
2898 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002899 }
2900 else
2901 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002902 if ((fp->uf_flags & FC_NOARGS) != 0)
2903 // Bail out if no a: arguments used (in lambda).
2904 break;
2905
Bram Moolenaare38eab22019-12-05 21:50:01 +01002906 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 sprintf((char *)numbuf, "%d", ai + 1);
2908 name = numbuf;
2909 }
2910 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2911 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002912 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002913 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002914 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 }
2916 else
2917 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002918 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002919 if (v == NULL)
2920 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002921 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002922 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002924 // Note: the values are copied directly to avoid alloc/free.
2925 // "argvars" must have VAR_FIXED for v_lock.
2926 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927 v->di_tv.v_lock = VAR_FIXED;
2928
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002929 if (isdefault)
2930 // Need to free this later, no matter where it's stored.
2931 tv_to_free[tv_to_free_len++] = &v->di_tv;
2932
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002933 if (addlocal)
2934 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002935 // Named arguments should be accessed without the "a:" prefix in
2936 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002937 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002938 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v), "local variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002939 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002940 else
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002941 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v), "add variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002942
2943 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2944 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002945 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002946
2947 li->li_tv = argvars[i];
2948 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002949 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950 }
2951 }
2952
Bram Moolenaare38eab22019-12-05 21:50:01 +01002953 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002955
2956 if (fp->uf_flags & FC_SANDBOX)
2957 {
2958 using_sandbox = TRUE;
2959 ++sandbox;
2960 }
2961
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002962 estack_push_ufunc(fp, 1);
ichizok7e5fe382023-04-15 13:17:50 +01002963 ESTACK_CHECK_SETUP;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002964 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002966 ++no_wait_return;
2967 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002969 smsg(_("calling %s"), SOURCING_NAME);
2970 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002972 char_u buf[MSG_BUF_LEN];
2973 char_u numbuf2[NUMBUFLEN];
2974 char_u *tofree;
2975 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002976
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002977 msg_puts("(");
2978 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002979 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002980 if (i > 0)
2981 msg_puts(", ");
2982 if (argvars[i].v_type == VAR_NUMBER)
2983 msg_outnum((long)argvars[i].vval.v_number);
2984 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002985 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002986 // Do not want errors such as E724 here.
2987 ++emsg_off;
2988 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2989 --emsg_off;
2990 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002992 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002994 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2995 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002996 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002997 msg_puts((char *)s);
2998 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002999 }
3000 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003002 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003004 msg_puts("\n"); // don't overwrite this either
3005
3006 verbose_leave_scroll();
3007 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 }
3009#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01003010 if (do_profiling == PROF_YES)
3011 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01003012 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013#endif
3014
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003015 // "legacy" does not apply to commands in the function
3016 sticky_cmdmod_flags = 0;
3017
Bram Moolenaar98aff652022-09-06 21:02:35 +01003018 // If called from a compiled :def function the execution context must be
3019 // hidden, any deferred functions need to be added to the function being
3020 // executed here.
dundargocc57b5bc2022-11-02 13:30:51 +00003021 save_current_ectx = clear_current_ectx();
Bram Moolenaar98aff652022-09-06 21:02:35 +01003022
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003023 save_current_sctx = current_sctx;
3024 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025 save_did_emsg = did_emsg;
3026 did_emsg = FALSE;
3027
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003028 if (default_arg_err && (fp->uf_flags & FC_ABORT))
Bram Moolenaar0917e862023-02-18 14:42:44 +00003029 {
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003030 did_emsg = TRUE;
Bram Moolenaar0917e862023-02-18 14:42:44 +00003031 retval = FCERR_FAILED;
3032 }
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003033 else if (islambda)
3034 {
3035 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
3036
3037 // A Lambda always has the command "return {expr}". It is much faster
3038 // to evaluate {expr} directly.
3039 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003040 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003041 --ex_nesting_level;
3042 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003043 else
3044 // call do_cmdline() to execute the lines
3045 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
3047
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003048 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01003049 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003050
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 --RedrawingDisabled;
3052
Bram Moolenaare38eab22019-12-05 21:50:01 +01003053 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003054 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
3055 {
3056 clear_tv(rettv);
3057 rettv->v_type = VAR_NUMBER;
3058 rettv->vval.v_number = -1;
Bram Moolenaard1149752023-02-18 15:31:53 +00003059
3060 // In corner cases returning a "failed" value is not backwards
3061 // compatible. Only do this for Vim9 script.
3062 if (in_vim9script())
3063 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
ichizok7e5fe382023-04-15 13:17:50 +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;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00003296 FOR_ALL_HASHTAB_ITEMS(&func_hashtab, hi, todo)
Bram Moolenaarce658352020-07-31 23:47:12 +02003297 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;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00003353 FOR_ALL_HASHTAB_ITEMS(&func_hashtab, hi, todo)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003354 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;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00003385 FOR_ALL_HASHTAB_ITEMS(&func_hashtab, hi, todo)
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 Moolenaar99a7c0d2023-02-21 19:55:14 +00004040 int flags)
4041{
4042 return trans_function_name_ext(pp, is_global, skip, flags,
4043 NULL, NULL, NULL, NULL);
4044}
4045
4046/*
4047 * trans_function_name() with extra arguments.
4048 * "fdp", "partial", "type" and "ufunc" can be NULL.
4049 */
4050 char_u *
4051trans_function_name_ext(
4052 char_u **pp,
4053 int *is_global,
4054 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01004056 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004057 partial_T **partial, // return: partial of a FuncRef
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00004058 type_T **type, // return: type of funcref
4059 ufunc_T **ufunc) // return: function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060{
4061 char_u *name = NULL;
4062 char_u *start;
4063 char_u *end;
4064 int lead;
4065 char_u sid_buf[20];
4066 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004067 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004068 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004070 int vim9script = in_vim9script();
4071 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072
4073 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02004074 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 start = *pp;
4076
Bram Moolenaare38eab22019-12-05 21:50:01 +01004077 // Check for hard coded <SNR>: already translated function ID (from a user
4078 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
4080 && (*pp)[2] == (int)KE_SNR)
4081 {
4082 *pp += 3;
4083 len = get_id_len(pp) + 3;
4084 return vim_strnsave(start, len);
4085 }
4086
Bram Moolenaare38eab22019-12-05 21:50:01 +01004087 // A name starting with "<SID>" or "<SNR>" is local to a script. But
4088 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089 lead = eval_fname_script(start);
4090 if (lead > 2)
4091 start += lead;
4092
Bram Moolenaare38eab22019-12-05 21:50:01 +01004093 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00004094 end = get_lval(start, NULL, &lv, FALSE, skip,
4095 flags | GLV_READ_ONLY | GLV_PREFER_FUNC,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004096 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004097 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00004098 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099 {
4100 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004101 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 goto theend;
4103 }
4104 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
4105 {
4106 /*
4107 * Report an invalid expression in braces, unless the expression
4108 * evaluation has been cancelled due to an aborting error, an
4109 * interrupt, or an exception.
4110 */
4111 if (!aborting())
4112 {
4113 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004114 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115 }
4116 else
4117 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
4118 goto theend;
4119 }
4120
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00004121 if (lv.ll_ufunc != NULL)
4122 {
4123 *ufunc = lv.ll_ufunc;
4124 name = vim_strsave(lv.ll_ufunc->uf_name);
4125 goto theend;
4126 }
4127
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128 if (lv.ll_tv != NULL)
4129 {
4130 if (fdp != NULL)
4131 {
4132 fdp->fd_dict = lv.ll_dict;
4133 fdp->fd_newkey = lv.ll_newkey;
4134 lv.ll_newkey = NULL;
4135 fdp->fd_di = lv.ll_di;
4136 }
4137 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
4138 {
4139 name = vim_strsave(lv.ll_tv->vval.v_string);
4140 *pp = end;
4141 }
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004142 else if (lv.ll_tv->v_type == VAR_CLASS
4143 && lv.ll_tv->vval.v_class != NULL)
4144 {
4145 name = vim_strsave(lv.ll_tv->vval.v_class->class_name);
4146 *pp = end;
4147 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004148 else if (lv.ll_tv->v_type == VAR_PARTIAL
4149 && lv.ll_tv->vval.v_partial != NULL)
4150 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004151 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004152 *pp = end;
4153 if (partial != NULL)
4154 *partial = lv.ll_tv->vval.v_partial;
4155 }
4156 else
4157 {
4158 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
4159 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00004160 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004161 else
4162 *pp = end;
4163 name = NULL;
4164 }
4165 goto theend;
4166 }
4167
4168 if (lv.ll_name == NULL)
4169 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004170 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 *pp = end;
4172 goto theend;
4173 }
4174
Bram Moolenaare38eab22019-12-05 21:50:01 +01004175 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 if (lv.ll_exp_name != NULL)
4177 {
4178 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004179 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004180 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 if (name == lv.ll_exp_name)
4182 name = NULL;
4183 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004184 else if (lv.ll_sid > 0)
4185 {
4186 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
4187 int cc = *lv.ll_name_end;
4188
4189 // function in another script. Prefix <SNR>99_ or the autoload prefix.
4190 *lv.ll_name_end = NUL;
4191 if (si->sn_autoload_prefix != NULL)
4192 {
4193 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
4194 }
4195 else
4196 {
4197 sid_buf[0] = K_SPECIAL;
4198 sid_buf[1] = KS_EXTRA;
4199 sid_buf[2] = (int)KE_SNR;
4200 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00004201 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004202 name = concat_str(sid_buf, lv.ll_name);
4203 }
4204 *lv.ll_name_end = cc;
4205 *pp = end;
4206 goto theend;
4207 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004208 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209 {
4210 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004211 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004212 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004213 if (name == *pp)
4214 name = NULL;
4215 }
4216 if (name != NULL)
4217 {
4218 name = vim_strsave(name);
4219 *pp = end;
4220 if (STRNCMP(name, "<SNR>", 5) == 0)
4221 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004222 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004223 name[0] = K_SPECIAL;
4224 name[1] = KS_EXTRA;
4225 name[2] = (int)KE_SNR;
4226 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
4227 }
4228 goto theend;
4229 }
4230
4231 if (lv.ll_exp_name != NULL)
4232 {
4233 len = (int)STRLEN(lv.ll_exp_name);
4234 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
4235 && STRNCMP(lv.ll_name, "s:", 2) == 0)
4236 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004237 // When there was "s:" already or the name expanded to get a
4238 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239 lv.ll_name += 2;
4240 len -= 2;
4241 lead = 2;
4242 }
4243 }
4244 else
4245 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004246 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004248 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004249 if (lv.ll_name[0] == 'g')
4250 {
4251 if (is_global != NULL)
4252 {
4253 *is_global = TRUE;
4254 }
4255 else
4256 {
4257 // dropping "g:" without setting "is_global" won't work in
4258 // Vim9script, put it back later
4259 prefix_g = TRUE;
4260 extra = 2;
4261 }
4262 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004264 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265 len = (int)(end - lv.ll_name);
4266 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004267 if (len <= 0)
4268 {
4269 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004270 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004271 goto theend;
4272 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004274 // In Vim9 script a user function is script-local by default, unless it
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004275 // starts with a lower case character: dict.func(). Or when in a class.
4276 vim9_local = ASCII_ISUPPER(*start) && vim9script
4277 && (flags & TFN_IN_CLASS) == 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004278
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279 /*
4280 * Copy the function name to allocated memory.
4281 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4282 * Accept <SNR>123_name() outside a script.
4283 */
4284 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004285 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004286 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004287 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004288 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004289 {
Kota Kato948a3892022-08-16 16:09:59 +01004290 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4291 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004292 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004293 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004294 goto theend;
4295 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004296 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004297 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004298 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004299 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300 || eval_fname_sid(*pp))
4301 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004302 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004303 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004305 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306 goto theend;
4307 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004308 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004309 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004310 extra = 3 + (int)STRLEN(sid_buf);
4311 else
4312 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313 }
4314 }
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004315 else if (!(flags & TFN_INT)
4316 && (builtin_function(lv.ll_name, len)
4317 || (vim9script && *lv.ll_name == '_'))
4318 && !((flags & TFN_IN_CLASS) && STRNCMP(lv.ll_name, "new", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004320 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004321 : e_function_name_must_start_with_capital_or_s_str),
4322 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 goto theend;
4324 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004325 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004326 {
4327 char_u *cp = vim_strchr(lv.ll_name, ':');
4328
4329 if (cp != NULL && cp < end)
4330 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004331 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332 goto theend;
4333 }
4334 }
4335
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004336 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 if (name != NULL)
4338 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004339 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 {
4341 name[0] = K_SPECIAL;
4342 name[1] = KS_EXTRA;
4343 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004344 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 STRCPY(name + 3, sid_buf);
4346 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004347 else if (prefix_g)
4348 {
4349 name[0] = 'g';
4350 name[1] = ':';
4351 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004352 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4353 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004354 }
4355 *pp = end;
4356
4357theend:
4358 clear_lval(&lv);
4359 return name;
4360}
4361
4362/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004363 * Assuming "name" is the result of trans_function_name() and it was prefixed
4364 * to use the script-local name, return the unmodified name (points into
4365 * "name"). Otherwise return NULL.
4366 * This can be used to first search for a script-local function and fall back
4367 * to the global function if not found.
4368 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004369 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004370untrans_function_name(char_u *name)
4371{
4372 char_u *p;
4373
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004374 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004375 {
4376 p = vim_strchr(name, '_');
4377 if (p != NULL)
4378 return p + 1;
4379 }
4380 return NULL;
4381}
4382
4383/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004384 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4385 * current script ID and returns the expanded function name. The caller should
4386 * free the returned name. If not called from a script context or the function
4387 * name doesn't start with these prefixes, then returns NULL.
4388 * This doesn't check whether the script-local function exists or not.
4389 */
4390 char_u *
4391get_scriptlocal_funcname(char_u *funcname)
4392{
4393 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004394 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004395 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004396 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004397
4398 if (funcname == NULL)
4399 return NULL;
4400
4401 if (STRNCMP(funcname, "s:", 2) != 0
4402 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004403 {
4404 ufunc_T *ufunc;
4405
4406 // The function name does not have a script-local prefix. Try finding
4407 // it when in a Vim9 script and there is no "g:" prefix.
4408 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4409 return NULL;
4410 ufunc = find_func(funcname, FALSE);
4411 if (ufunc == NULL || func_is_global(ufunc)
4412 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4413 return NULL;
4414 ++p;
4415 off = 0;
4416 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004417 else
4418 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004419
4420 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4421 {
4422 emsg(_(e_using_sid_not_in_script_context));
4423 return NULL;
4424 }
4425 // Expand s: prefix into <SNR>nr_<name>
4426 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4427 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004428 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004429 if (newname == NULL)
4430 return NULL;
4431 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004432 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004433
4434 return newname;
4435}
4436
4437/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004438 * Return script-local "fname" with the 3-byte sequence replaced by
4439 * printable <SNR> in allocated memory.
4440 */
4441 char_u *
4442alloc_printable_func_name(char_u *fname)
4443{
4444 char_u *n = alloc(STRLEN(fname + 3) + 6);
4445
4446 if (n != NULL)
4447 {
4448 STRCPY(n, "<SNR>");
4449 STRCPY(n + 5, fname + 3);
4450 }
4451 return n;
4452}
4453
4454/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004455 * Call trans_function_name(), except that a lambda is returned as-is.
4456 * Returns the name in allocated memory.
4457 */
4458 char_u *
4459save_function_name(
4460 char_u **name,
4461 int *is_global,
4462 int skip,
4463 int flags,
4464 funcdict_T *fudi)
4465{
4466 char_u *p = *name;
4467 char_u *saved;
4468
4469 if (STRNCMP(p, "<lambda>", 8) == 0)
4470 {
4471 p += 8;
4472 (void)getdigits(&p);
4473 saved = vim_strnsave(*name, p - *name);
4474 if (fudi != NULL)
4475 CLEAR_POINTER(fudi);
4476 }
4477 else
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00004478 saved = trans_function_name_ext(&p, is_global, skip,
4479 flags, fudi, NULL, NULL, NULL);
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004480 *name = p;
4481 return saved;
4482}
4483
4484/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004485 * List functions. When "regmatch" is NULL all of then.
4486 * Otherwise functions matching "regmatch".
4487 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004488 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004489list_functions(regmatch_T *regmatch)
4490{
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004491 int prev_ht_changed = func_hashtab.ht_changed;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004492 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004493 hashitem_T *hi;
4494
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004495 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004496 {
4497 if (!HASHITEM_EMPTY(hi))
4498 {
4499 ufunc_T *fp = HI2UF(hi);
4500
4501 --todo;
4502 if ((fp->uf_flags & FC_DEAD) == 0
4503 && (regmatch == NULL
4504 ? !message_filtered(fp->uf_name)
4505 && !func_name_refcount(fp->uf_name)
4506 : !isdigit(*fp->uf_name)
4507 && vim_regexec(regmatch, fp->uf_name, 0)))
4508 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004509 if (list_func_head(fp, FALSE) == FAIL)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004510 return;
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004511 if (function_list_modified(prev_ht_changed))
4512 return;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004513 }
4514 }
4515 }
4516}
4517
4518/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004519 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004520 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4521 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004522 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar554d0312023-01-05 19:59:18 +00004523 * If "class_flags" has CF_CLASS then the function is defined inside a class.
4524 * With CF_INTERFACE the function is define inside an interface, only the
4525 * ":def"/":function" line is expected, no function body.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004526 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004527 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004528 ufunc_T *
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004529define_function(
4530 exarg_T *eap,
4531 char_u *name_arg,
4532 garray_T *lines_to_free,
Bram Moolenaar554d0312023-01-05 19:59:18 +00004533 int class_flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 int j;
4536 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004537 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004538 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004539 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004540 char_u *p;
4541 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004542 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543 char_u *line_arg = NULL;
4544 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004545 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004546 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004547 garray_T newlines;
4548 int varargs = FALSE;
4549 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004550 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004551 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004552 int fp_allocated = FALSE;
4553 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004554 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 dictitem_T *v;
4556 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004557 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004560 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004561 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004562 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004563
4564 /*
4565 * ":function" without argument: list functions.
4566 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004567 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 {
4569 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004570 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004571 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004572 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 }
4574
4575 /*
4576 * ":function /pat": list functions matching pattern.
4577 */
4578 if (*eap->arg == '/')
4579 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004580 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 if (!eap->skip)
4582 {
4583 regmatch_T regmatch;
4584
4585 c = *p;
4586 *p = NUL;
4587 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4588 *p = c;
4589 if (regmatch.regprog != NULL)
4590 {
4591 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004592 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 vim_regfree(regmatch.regprog);
4594 }
4595 }
4596 if (*p == '/')
4597 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004598 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004599 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004600 }
4601
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004602 ga_init(&newargs);
4603 ga_init(&argtypes);
4604 ga_init(&default_args);
4605
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004606 /*
4607 * Get the function name. There are these situations:
Bram Moolenaar554d0312023-01-05 19:59:18 +00004608 * func normal function name, also when "class_flags" is non-zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 * "name" == func, "fudi.fd_dict" == NULL
4610 * dict.func new dictionary entry
4611 * "name" == NULL, "fudi.fd_dict" set,
4612 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4613 * dict.func existing dict entry with a Funcref
4614 * "name" == func, "fudi.fd_dict" set,
4615 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4616 * dict.func existing dict entry that's not a Funcref
4617 * "name" == NULL, "fudi.fd_dict" set,
4618 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4619 * s:func script-local function name
4620 * g:func global function name, same as "func"
4621 */
4622 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004623 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004624 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004625 // nested function, argument is (args).
4626 paren = TRUE;
4627 CLEAR_FIELD(fudi);
4628 }
4629 else
4630 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004631 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004632 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004633 if (p[0] == 's' && p[1] == ':')
4634 {
4635 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4636 return NULL;
4637 }
4638 p = to_name_end(p, TRUE);
4639 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4640 {
4641 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4642 eap->arg);
4643 return NULL;
4644 }
4645 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004646 }
4647
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004648 int tfn_flags = TFN_NO_AUTOLOAD | TFN_NEW_FUNC
Bram Moolenaar554d0312023-01-05 19:59:18 +00004649 | (class_flags != 0 ? TFN_IN_CLASS : 0);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004650 name = save_function_name(&p, &is_global, eap->skip, tfn_flags, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004651 paren = (vim_strchr(p, '(') != NULL);
4652 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004653 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004654 /*
4655 * Return on an invalid expression in braces, unless the expression
4656 * evaluation has been cancelled due to an aborting error, an
4657 * interrupt, or an exception.
4658 */
4659 if (!aborting())
4660 {
4661 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00004662 semsg(_(e_key_not_present_in_dictionary_str),
4663 fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004664 vim_free(fudi.fd_newkey);
4665 return NULL;
4666 }
4667 else
4668 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004669 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004670
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004671 // For "export def FuncName()" in an autoload script the function name
4672 // is stored with the legacy autoload name "dir#script#FuncName" so
4673 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004674 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004675 {
4676 char_u *prefixed = may_prefix_autoload(name);
4677
4678 if (prefixed != NULL && prefixed != name)
4679 {
4680 vim_free(name);
4681 name = prefixed;
4682 }
4683 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004684 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004685 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004686 {
4687 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4688 goto ret_free;
4689 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 }
4691
Bram Moolenaare38eab22019-12-05 21:50:01 +01004692 // An error in a function call during evaluation of an expression in magic
4693 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 saved_did_emsg = did_emsg;
4695 did_emsg = FALSE;
4696
4697 /*
4698 * ":function func" with only function name: list function.
4699 */
4700 if (!paren)
4701 {
4702 if (!ends_excmd(*skipwhite(p)))
4703 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004704 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004705 goto ret_free;
4706 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004707 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 if (eap->nextcmd != NULL)
4709 *p = NUL;
4710 if (!eap->skip && !got_int)
4711 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004712 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004713 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4714 {
4715 char_u *up = untrans_function_name(name);
4716
4717 // With Vim9 script the name was made script-local, if not
4718 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004719 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004720 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004721 }
4722
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 if (fp != NULL)
4724 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004725 // Check no function was added or removed from a timer, e.g. at
4726 // the more prompt. "fp" may then be invalid.
4727 int prev_ht_changed = func_hashtab.ht_changed;
4728
4729 if (list_func_head(fp, TRUE) == OK)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004731 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4732 {
4733 if (FUNCLINE(fp, j) == NULL)
4734 continue;
4735 msg_putchar('\n');
4736 msg_outnum((long)(j + 1));
4737 if (j < 9)
4738 msg_putchar(' ');
4739 if (j < 99)
4740 msg_putchar(' ');
4741 if (function_list_modified(prev_ht_changed))
4742 break;
4743 msg_prt_line(FUNCLINE(fp, j), FALSE);
4744 out_flush(); // show a line at a time
4745 ui_breakcheck();
4746 }
4747 if (!got_int)
4748 {
4749 msg_putchar('\n');
4750 if (!function_list_modified(prev_ht_changed))
4751 {
4752 if (fp->uf_def_status != UF_NOT_COMPILED)
4753 msg_puts(" enddef");
4754 else
4755 msg_puts(" endfunction");
4756 }
4757 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004758 }
4759 }
4760 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004761 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 }
4763 goto ret_free;
4764 }
4765
4766 /*
4767 * ":function name(arg1, arg2)" Define function.
4768 */
4769 p = skipwhite(p);
4770 if (*p != '(')
4771 {
4772 if (!eap->skip)
4773 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004774 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004775 goto ret_free;
4776 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004777 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 if (vim_strchr(p, '(') != NULL)
4779 p = vim_strchr(p, '(');
4780 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004781
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004782 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4783 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004784 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004785 goto ret_free;
4786 }
4787
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004788 // In Vim9 script only global functions can be redefined.
4789 if (vim9script && eap->forceit && !is_global)
4790 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004791 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004792 goto ret_free;
4793 }
4794
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004795 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004796
Bram Moolenaar04b12692020-05-04 23:24:44 +02004797 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004798 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004799 // Check the name of the function. Unless it's a dictionary function
4800 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004801 if (name != NULL)
4802 arg = name;
4803 else
4804 arg = fudi.fd_newkey;
4805 if (arg != NULL && (fudi.fd_di == NULL
4806 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4807 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4808 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004809 char_u *name_base = arg;
4810 int i;
4811
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004813 {
4814 name_base = vim_strchr(arg, '_');
4815 if (name_base == NULL)
4816 name_base = arg + 3;
4817 else
4818 ++name_base;
4819 }
4820 for (i = 0; name_base[i] != NUL && (i == 0
4821 ? eval_isnamec1(name_base[i])
4822 : eval_isnamec(name_base[i])); ++i)
4823 ;
4824 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004825 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004826
4827 // In Vim9 script a function cannot have the same name as a
4828 // variable.
4829 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004830 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4831 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004832 + EVAL_VAR_NO_FUNC) == OK)
4833 {
4834 semsg(_(e_redefining_script_item_str), name_base);
4835 goto ret_free;
4836 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004837 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004838 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004839 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004840 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004841 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004842 goto ret_free;
4843 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004844 }
4845
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004846 // This may get more lines and make the pointers into the first line
4847 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004848 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004849 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarf0571712023-01-04 13:16:20 +00004850 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004851 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar554d0312023-01-05 19:59:18 +00004852 eap, class_flags, &newlines, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004853 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004854 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004856 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004858 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004859 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004861 if (*p != ':')
4862 {
4863 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4864 p = skipwhite(p);
4865 }
4866 else if (!IS_WHITE_OR_NUL(p[1]))
4867 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004868 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004869 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004870 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004871 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004872 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004873 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004874 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004875 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004876 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004877 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004878 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004879 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004880 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004881 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004882 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004883 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004884 else
4885 // find extra arguments "range", "dict", "abort" and "closure"
4886 for (;;)
4887 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004888 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004889 p = skipwhite(p);
4890 if (STRNCMP(p, "range", 5) == 0)
4891 {
4892 flags |= FC_RANGE;
4893 p += 5;
4894 }
4895 else if (STRNCMP(p, "dict", 4) == 0)
4896 {
4897 flags |= FC_DICT;
4898 p += 4;
4899 }
4900 else if (STRNCMP(p, "abort", 5) == 0)
4901 {
4902 flags |= FC_ABORT;
4903 p += 5;
4904 }
4905 else if (STRNCMP(p, "closure", 7) == 0)
4906 {
4907 flags |= FC_CLOSURE;
4908 p += 7;
4909 if (current_funccal == NULL)
4910 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00004911 emsg_funcname(e_closure_function_should_not_be_at_top_level_str,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004912 name == NULL ? (char_u *)"" : name);
4913 goto erret;
4914 }
4915 }
4916 else
4917 break;
4918 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919
Bram Moolenaare38eab22019-12-05 21:50:01 +01004920 // When there is a line break use what follows for the function body.
4921 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004922 if (*p == '\n')
4923 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004924 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004925 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4926 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004927 && !(VIM_ISWHITE(*whitep) && *p == '#'
4928 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004929 && !eap->skip
4930 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004931 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004932
4933 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004934 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4935 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936 */
4937 if (KeyTyped)
4938 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004939 // Check if the function already exists, don't let the user type the
4940 // whole function before telling him it doesn't work! For a script we
4941 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942 if (!eap->skip && !eap->forceit)
4943 {
4944 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004945 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004946 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004947 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004948 }
4949
4950 if (!eap->skip && did_emsg)
4951 goto erret;
4952
Bram Moolenaare38eab22019-12-05 21:50:01 +01004953 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004954 cmdline_row = msg_row;
4955 }
4956
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004957 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004958 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004959
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004960 // Do not define the function when getting the body fails and when
4961 // skipping.
Bram Moolenaar554d0312023-01-05 19:59:18 +00004962 if (((class_flags & CF_INTERFACE) == 0
4963 && get_function_body(eap, &newlines, line_arg, lines_to_free)
4964 == FAIL)
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004965 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966 goto erret;
4967
4968 /*
4969 * If there are no errors, add the function
4970 */
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004971 if (fudi.fd_dict != NULL)
4972 {
4973 char numbuf[20];
4974
4975 fp = NULL;
4976 if (fudi.fd_newkey == NULL && !eap->forceit)
4977 {
4978 emsg(_(e_dictionary_entry_already_exists));
4979 goto erret;
4980 }
4981 if (fudi.fd_di == NULL)
4982 {
4983 // Can't add a function to a locked dictionary
4984 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
4985 goto erret;
4986 }
4987 // Can't change an existing function if it is locked
4988 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
4989 goto erret;
4990
4991 // Give the function a sequential number. Can only be used with a
4992 // Funcref!
4993 vim_free(name);
4994 sprintf(numbuf, "%d", ++func_nr);
4995 name = vim_strsave((char_u *)numbuf);
4996 if (name == NULL)
4997 goto erret;
4998 }
Bram Moolenaar554d0312023-01-05 19:59:18 +00004999 else if (class_flags == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005000 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005001 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00005002 char_u *find_name = name;
5003 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00005004 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005005
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005006 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00005007 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00005008 var_conflict = TRUE;
5009
5010 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
5011 {
5012 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
5013
5014 if (si->sn_autoload_prefix != NULL)
5015 {
5016 if (is_export)
5017 {
5018 find_name = name + STRLEN(si->sn_autoload_prefix);
5019 v = find_var(find_name, &ht, TRUE);
5020 if (v != NULL)
5021 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00005022 // Only check if the function already exists in the script,
5023 // global functions can be shadowed.
5024 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00005025 }
5026 else
5027 {
5028 char_u *prefixed = may_prefix_autoload(name);
5029
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00005030 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00005031 {
5032 v = find_var(prefixed, &ht, TRUE);
5033 if (v != NULL)
5034 var_conflict = TRUE;
5035 vim_free(prefixed);
5036 }
5037 }
5038 }
5039 }
5040 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005041 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00005042 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005043 goto erret;
5044 }
5045
Bram Moolenaaracc4b562022-01-24 13:54:45 +00005046 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02005047 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005048 {
Bram Moolenaareef21022020-08-01 22:16:43 +02005049 char_u *uname = untrans_function_name(name);
5050
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00005051 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02005052 }
5053
5054 if (fp != NULL || import != NULL)
5055 {
5056 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005057
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005058 // Function can be replaced with "function!" and when sourcing the
5059 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02005060 // A name that is used by an import can not be overruled.
5061 if (import != NULL
5062 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005063 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02005064 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 {
Bram Moolenaard604d782021-11-20 21:46:20 +00005066 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02005067 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02005068 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02005069 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00005070 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005071 goto erret;
5072 }
5073 if (fp->uf_calls > 0)
5074 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005075 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00005076 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005077 goto erret;
5078 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005079 if (fp->uf_refcount > 1)
5080 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005081 // This function is referenced somewhere, don't redefine it but
5082 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005083 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005084 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005085 fp = NULL;
5086 overwrite = TRUE;
5087 }
5088 else
5089 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005090 char_u *exp_name = fp->uf_name_exp;
5091
5092 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01005093 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005094 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02005095 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005096 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005097 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02005098#ifdef FEAT_PROFILE
5099 fp->uf_profiling = FALSE;
5100 fp->uf_prof_initialized = FALSE;
5101#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005102 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005103 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005104 }
5105 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106
5107 if (fp == NULL)
5108 {
5109 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
5110 {
5111 int slen, plen;
5112 char_u *scriptname;
5113
Bram Moolenaare38eab22019-12-05 21:50:01 +01005114 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005116 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005117 {
5118 scriptname = autoload_name(name);
5119 if (scriptname != NULL)
5120 {
5121 p = vim_strchr(scriptname, '/');
5122 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005123 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005124 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005125 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126 j = OK;
5127 vim_free(scriptname);
5128 }
5129 }
5130 if (j == FAIL)
5131 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02005132 linenr_T save_lnum = SOURCING_LNUM;
5133
5134 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00005135 semsg(_(e_function_name_does_not_match_script_file_name_str),
5136 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02005137 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005138 goto erret;
5139 }
5140 }
5141
Bram Moolenaare01e5212023-01-08 20:31:18 +00005142 fp = alloc_ufunc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005143 if (fp == NULL)
5144 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005145 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146
5147 if (fudi.fd_dict != NULL)
5148 {
5149 if (fudi.fd_di == NULL)
5150 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005151 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
5153 if (fudi.fd_di == NULL)
5154 {
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00005155 VIM_CLEAR(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156 goto erret;
5157 }
5158 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
5159 {
5160 vim_free(fudi.fd_di);
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00005161 VIM_CLEAR(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162 goto erret;
5163 }
5164 }
5165 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005166 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005167 clear_tv(&fudi.fd_di->di_tv);
5168 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005170
Bram Moolenaare38eab22019-12-05 21:50:01 +01005171 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172 flags |= FC_DICT;
5173 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005174 }
5175 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005176 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005177 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02005178 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005179
5180 if (eap->cmdidx == CMD_def)
5181 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02005182 int lnum_save = SOURCING_LNUM;
5183 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005184
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005185 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02005186
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005187 // error messages are for the first function line
5188 SOURCING_LNUM = sourcing_lnum_top;
5189
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02005190 // The function may use script variables from the context.
5191 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02005192
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005193 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005194 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005195 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005196 free_fp = fp_allocated;
5197 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005198 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005199 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005200
5201 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005202 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005203 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005204 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005205 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005206 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005207 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02005208 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005209 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005210 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005211 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005212
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005213 if (fp_allocated)
5214 {
5215 // insert the new function in the function list
5216 set_ufunc_name(fp, name);
5217 if (overwrite)
5218 {
5219 hi = hash_find(&func_hashtab, name);
5220 hi->hi_key = UF2HIKEY(fp);
5221 }
Bram Moolenaar554d0312023-01-05 19:59:18 +00005222 else if (class_flags == 0 && hash_add(&func_hashtab,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005223 UF2HIKEY(fp), "add function") == FAIL)
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005224 {
5225 free_fp = TRUE;
5226 goto erret;
5227 }
5228 fp->uf_refcount = 1;
5229 }
5230
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005231 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005232 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005233 if ((flags & FC_CLOSURE) != 0)
5234 {
Bram Moolenaar58016442016-07-31 18:30:22 +02005235 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005236 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005237 }
5238 else
5239 fp->uf_scoped = NULL;
5240
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005242 if (prof_def_func())
5243 func_do_profile(fp);
5244#endif
5245 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02005246 if (sandbox)
5247 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02005248 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005249 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005250 fp->uf_flags = flags;
5251 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01005252 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005253 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02005254 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02005255 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005256 if (is_export)
5257 {
5258 fp->uf_flags |= FC_EXPORT;
dundargocc57b5bc2022-11-02 13:30:51 +00005259 // let do_one_cmd() know the export worked.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005260 is_export = FALSE;
5261 }
5262
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005263 if (eap->cmdidx == CMD_def)
5264 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02005265 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
5266 // :func does not use Vim9 script syntax, even in a Vim9 script file
5267 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005268
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005269 goto ret_free;
5270
5271erret:
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005272 if (fp != NULL)
5273 {
Bram Moolenaarf0571712023-01-04 13:16:20 +00005274 // these were set to "newargs" and "default_args", which are cleared
5275 // below
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005276 ga_init(&fp->uf_args);
5277 ga_init(&fp->uf_def_args);
5278 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005279errret_2:
Bram Moolenaarf0571712023-01-04 13:16:20 +00005280 ga_clear_strings(&newargs);
5281 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005282 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005283 if (fp != NULL)
Bram Moolenaarf0571712023-01-04 13:16:20 +00005284 {
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005285 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarf0571712023-01-04 13:16:20 +00005286 VIM_CLEAR(fp->uf_va_name);
5287 clear_type_list(&fp->uf_type_list);
5288 }
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005289 if (free_fp)
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00005290 VIM_CLEAR(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005291ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005292 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005293 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005294 if (name != name_arg)
5295 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005296 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005298
5299 return fp;
5300}
5301
5302/*
5303 * ":function"
5304 */
5305 void
5306ex_function(exarg_T *eap)
5307{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005308 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005309
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005310 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Bram Moolenaar554d0312023-01-05 19:59:18 +00005311 (void)define_function(eap, NULL, &lines_to_free, 0);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005312 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005313}
5314
5315/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005316 * Find a function by name, including "<lambda>123".
5317 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005318 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005319 * Return NULL if not found.
5320 */
5321 ufunc_T *
5322find_func_by_name(char_u *name, compiletype_T *compile_type)
5323{
5324 char_u *arg = name;
5325 char_u *fname;
5326 ufunc_T *ufunc;
5327 int is_global = FALSE;
5328
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005329 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5330 {
5331 *compile_type = CT_PROFILE;
5332 arg = skipwhite(arg + 7);
5333 }
5334 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5335 {
5336 *compile_type = CT_DEBUG;
5337 arg = skipwhite(arg + 5);
5338 }
5339
5340 if (STRNCMP(arg, "<lambda>", 8) == 0)
5341 {
5342 arg += 8;
5343 (void)getdigits(&arg);
5344 fname = vim_strnsave(name, arg - name);
5345 }
5346 else
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005347 {
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005348 // First try finding a method in a class, trans_function_name() will
5349 // give an error if the function is not found.
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005350 ufunc = find_class_func(&arg);
5351 if (ufunc != NULL)
5352 return ufunc;
5353
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005354 fname = trans_function_name_ext(&arg, &is_global, FALSE,
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005355 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD | TFN_NO_DECL,
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005356 NULL, NULL, NULL, &ufunc);
5357 if (ufunc != NULL)
5358 {
5359 vim_free(fname);
5360 return ufunc;
5361 }
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005362 }
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005363 if (fname == NULL)
5364 {
5365 semsg(_(e_invalid_argument_str), name);
5366 return NULL;
5367 }
5368 if (!ends_excmd2(name, arg))
5369 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005370 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005371 emsg(ex_errmsg(e_trailing_characters_str, arg));
5372 return NULL;
5373 }
5374
5375 ufunc = find_func(fname, is_global);
5376 if (ufunc == NULL)
5377 {
5378 char_u *p = untrans_function_name(fname);
5379
5380 if (p != NULL)
5381 // Try again without making it script-local.
5382 ufunc = find_func(p, FALSE);
5383 }
5384 vim_free(fname);
5385 if (ufunc == NULL)
5386 semsg(_(e_cannot_find_function_str), name);
5387 return ufunc;
5388}
5389
5390/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005391 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005392 * be compiled or the one specified by the argument.
5393 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005394 */
5395 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005396ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005397{
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005398 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005399 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005400 compiletype_T compile_type = CT_NONE;
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005401 ufunc_T *ufunc = find_func_by_name(eap->arg, &compile_type);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005402 if (ufunc != NULL)
5403 {
5404 if (func_needs_compiling(ufunc, compile_type))
5405 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5406 else
5407 smsg(_("Function %s does not need compiling"), eap->arg);
5408 }
5409 }
5410 else
5411 {
5412 long todo = (long)func_hashtab.ht_used;
5413 int changed = func_hashtab.ht_changed;
5414 hashitem_T *hi;
5415
5416 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5417 {
5418 if (!HASHITEM_EMPTY(hi))
5419 {
5420 --todo;
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005421 ufunc_T *ufunc = HI2UF(hi);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005422 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5423 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5424 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005425 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005426 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5427
5428 if (func_hashtab.ht_changed != changed)
5429 {
5430 // a function has been added or removed, need to start
5431 // over
5432 todo = (long)func_hashtab.ht_used;
5433 changed = func_hashtab.ht_changed;
5434 hi = func_hashtab.ht_array;
5435 --hi;
5436 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005437 }
5438 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005439 }
5440 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005441}
5442
5443/*
5444 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5445 * Return 2 if "p" starts with "s:".
5446 * Return 0 otherwise.
5447 */
5448 int
5449eval_fname_script(char_u *p)
5450{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005451 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5452 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5454 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5455 return 5;
5456 if (p[0] == 's' && p[1] == ':')
5457 return 2;
5458 return 0;
5459}
5460
5461 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005462translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005463{
5464 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005465 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005466 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005467}
5468
5469/*
5470 * Return TRUE when "ufunc" has old-style "..." varargs
5471 * or named varargs "...name: type".
5472 */
5473 int
5474has_varargs(ufunc_T *ufunc)
5475{
5476 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005477}
5478
5479/*
5480 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005481 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005482 */
5483 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005484function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005485{
5486 char_u *nm = name;
5487 char_u *p;
5488 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005489 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005490 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005491
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005492 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5493 if (no_deref)
5494 flag |= TFN_NO_DEREF;
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005495 p = trans_function_name(&nm, &is_global, FALSE, flag);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005496 nm = skipwhite(nm);
5497
Bram Moolenaare38eab22019-12-05 21:50:01 +01005498 // Only accept "funcname", "funcname ", "funcname (..." and
5499 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005500 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005501 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005502 vim_free(p);
5503 return n;
5504}
5505
Bram Moolenaar113e1072019-01-20 15:30:40 +01005506#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005507 char_u *
5508get_expanded_name(char_u *name, int check)
5509{
5510 char_u *nm = name;
5511 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005512 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005513
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005514 p = trans_function_name(&nm, &is_global, FALSE, TFN_INT|TFN_QUIET);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005516 if (p != NULL && *nm == NUL
5517 && (!check || translated_function_exists(p, is_global)))
5518 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519
5520 vim_free(p);
5521 return NULL;
5522}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005523#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005524
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005525/*
5526 * Function given to ExpandGeneric() to obtain the list of user defined
5527 * function names.
5528 */
5529 char_u *
5530get_user_func_name(expand_T *xp, int idx)
5531{
5532 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005533 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005534 static hashitem_T *hi;
5535 ufunc_T *fp;
5536
5537 if (idx == 0)
5538 {
5539 done = 0;
5540 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005541 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005542 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005543 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005544 {
5545 if (done++ > 0)
5546 ++hi;
5547 while (HASHITEM_EMPTY(hi))
5548 ++hi;
5549 fp = HI2UF(hi);
5550
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005551 // don't show dead, dict and lambda functions
5552 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005553 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005554 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005555
5556 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005557 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005558
5559 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005560 if (xp->xp_context != EXPAND_USER_FUNC
5561 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005562 {
5563 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005564 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005565 STRCAT(IObuff, ")");
5566 }
5567 return IObuff;
5568 }
5569 return NULL;
5570}
5571
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005572/*
Bram Moolenaar83677162023-01-08 19:54:10 +00005573 * Make a copy of a function.
5574 * Intended to be used for a function defined on a base class that has a copy
5575 * on the child class.
5576 * The copy has uf_refcount set to one.
5577 * Returns NULL when out of memory.
5578 */
5579 ufunc_T *
5580copy_function(ufunc_T *fp)
5581{
Bram Moolenaare01e5212023-01-08 20:31:18 +00005582 ufunc_T *ufunc = alloc_ufunc(fp->uf_name);
Bram Moolenaar83677162023-01-08 19:54:10 +00005583 if (ufunc == NULL)
5584 return NULL;
5585
5586 // Most things can just be copied.
5587 *ufunc = *fp;
5588
5589 ufunc->uf_def_status = UF_TO_BE_COMPILED;
5590 ufunc->uf_dfunc_idx = 0;
5591 ufunc->uf_class = NULL;
5592
5593 ga_copy_strings(&fp->uf_args, &ufunc->uf_args);
5594 ga_copy_strings(&fp->uf_def_args, &ufunc->uf_def_args);
5595
5596 if (ufunc->uf_arg_types != NULL)
5597 {
5598 // "uf_arg_types" is an allocated array, make a copy.
5599 type_T **at = ALLOC_CLEAR_MULT(type_T *, ufunc->uf_args.ga_len);
5600 if (at != NULL)
5601 {
5602 mch_memmove(at, ufunc->uf_arg_types,
5603 sizeof(type_T *) * ufunc->uf_args.ga_len);
5604 ufunc->uf_arg_types = at;
5605 }
5606 }
5607
5608 // TODO: how about the types themselves? they can be freed when the
5609 // original function is freed:
5610 // type_T **uf_arg_types;
5611 // type_T *uf_ret_type;
5612
5613 ufunc->uf_type_list.ga_len = 0;
5614 ufunc->uf_type_list.ga_data = NULL;
5615
5616 // TODO: partial_T *uf_partial;
5617
5618 if (ufunc->uf_va_name != NULL)
5619 ufunc->uf_va_name = vim_strsave(ufunc->uf_va_name);
5620
5621 // TODO:
5622 // type_T *uf_va_type;
5623 // type_T *uf_func_type;
5624
5625 ufunc->uf_block_depth = 0;
5626 ufunc->uf_block_ids = NULL;
5627
5628 ga_copy_strings(&fp->uf_lines, &ufunc->uf_lines);
5629
5630 ufunc->uf_refcount = 1;
5631 ufunc->uf_name_exp = NULL;
5632 STRCPY(ufunc->uf_name, fp->uf_name);
5633
5634 return ufunc;
5635}
5636
5637/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005638 * ":delfunction {name}"
5639 */
5640 void
5641ex_delfunction(exarg_T *eap)
5642{
5643 ufunc_T *fp = NULL;
5644 char_u *p;
5645 char_u *name;
5646 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005647 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005648
5649 p = eap->arg;
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00005650 name = trans_function_name_ext(&p, &is_global, eap->skip, 0, &fudi,
5651 NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005652 vim_free(fudi.fd_newkey);
5653 if (name == NULL)
5654 {
5655 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005656 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005657 return;
5658 }
5659 if (!ends_excmd(*skipwhite(p)))
5660 {
5661 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005662 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005663 return;
5664 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005665 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005666 if (eap->nextcmd != NULL)
5667 *p = NUL;
5668
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005669 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005670 {
5671 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005672 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005673 vim_free(name);
5674 return;
5675 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005676 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005677 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005678 vim_free(name);
5679
5680 if (!eap->skip)
5681 {
5682 if (fp == NULL)
5683 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005684 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005685 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005686 return;
5687 }
5688 if (fp->uf_calls > 0)
5689 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005690 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005691 return;
5692 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005693 if (fp->uf_flags & FC_VIM9)
5694 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005695 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005696 return;
5697 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005698
5699 if (fudi.fd_dict != NULL)
5700 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005701 // Delete the dict item that refers to the function, it will
5702 // invoke func_unref() and possibly delete the function.
Bram Moolenaaref2c3252022-11-25 16:31:51 +00005703 dictitem_remove(fudi.fd_dict, fudi.fd_di, "delfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005704 }
5705 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005706 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005707 // A normal function (not a numbered function or lambda) has a
5708 // refcount of 1 for the entry in the hashtable. When deleting
5709 // it and the refcount is more than one, it should be kept.
5710 // A numbered function and lambda should be kept if the refcount is
5711 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005712 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005713 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005714 // Function is still referenced somewhere. Don't free it but
5715 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005716 if (func_remove(fp))
5717 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005718 }
5719 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005720 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005721 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005722 }
5723}
5724
5725/*
5726 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005727 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005728 */
5729 void
5730func_unref(char_u *name)
5731{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005732 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005733
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005734 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005735 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005736 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005737 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005738 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005739#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005740 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005741#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005742 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005743 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005744 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005745}
5746
5747/*
5748 * Unreference a Function: decrement the reference count and free it when it
5749 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005750 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005751 */
5752 void
5753func_ptr_unref(ufunc_T *fp)
5754{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005755 if (fp != NULL && (--fp->uf_refcount <= 0
5756 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5757 && fp->uf_partial->pt_refcount <= 1
5758 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005759 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005760 // Only delete it when it's not being used. Otherwise it's done
5761 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005762 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005763 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005764 }
5765}
5766
5767/*
5768 * Count a reference to a Function.
5769 */
5770 void
5771func_ref(char_u *name)
5772{
5773 ufunc_T *fp;
5774
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005775 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005776 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005777 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005778 if (fp != NULL)
5779 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005780 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005781 // Only give an error for a numbered function.
5782 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005783 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005784}
5785
5786/*
5787 * Count a reference to a Function.
5788 */
5789 void
5790func_ptr_ref(ufunc_T *fp)
5791{
5792 if (fp != NULL)
5793 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005794}
5795
5796/*
5797 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5798 * referenced from anywhere that is in use.
5799 */
5800 static int
5801can_free_funccal(funccall_T *fc, int copyID)
5802{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005803 return (fc->fc_l_varlist.lv_copyID != copyID
5804 && fc->fc_l_vars.dv_copyID != copyID
5805 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005806 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005807}
5808
5809/*
5810 * ":return [expr]"
5811 */
5812 void
5813ex_return(exarg_T *eap)
5814{
5815 char_u *arg = eap->arg;
5816 typval_T rettv;
5817 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005818 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005819
5820 if (current_funccal == NULL)
5821 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005822 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005823 return;
5824 }
5825
Bram Moolenaar844fb642021-10-23 13:32:30 +01005826 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005827 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5828
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005829 if (eap->skip)
5830 ++emsg_skip;
5831
5832 eap->nextcmd = NULL;
5833 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005834 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005835 {
5836 if (!eap->skip)
5837 returning = do_return(eap, FALSE, TRUE, &rettv);
5838 else
5839 clear_tv(&rettv);
5840 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005841 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005842 else if (!eap->skip)
5843 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005844 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005845 update_force_abort();
5846
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005847 /*
5848 * Return unless the expression evaluation has been cancelled due to an
5849 * aborting error, an interrupt, or an exception.
5850 */
5851 if (!aborting())
5852 returning = do_return(eap, FALSE, TRUE, NULL);
5853 }
5854
Bram Moolenaare38eab22019-12-05 21:50:01 +01005855 // When skipping or the return gets pending, advance to the next command
5856 // in this line (!returning). Otherwise, ignore the rest of the line.
5857 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005858 if (returning)
5859 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005860 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005861 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005862
5863 if (eap->skip)
5864 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005865 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005866}
5867
zeertzjq5299c092023-04-12 20:48:16 +01005868/*
5869 * Lower level implementation of "call". Only called when not skipping.
5870 */
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005871 static int
5872ex_call_inner(
5873 exarg_T *eap,
5874 char_u *name,
5875 char_u **arg,
5876 char_u *startarg,
5877 funcexe_T *funcexe_init,
5878 evalarg_T *evalarg)
5879{
5880 linenr_T lnum;
5881 int doesrange;
5882 typval_T rettv;
5883 int failed = FALSE;
5884
zeertzjq5299c092023-04-12 20:48:16 +01005885 lnum = eap->line1;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005886 for ( ; lnum <= eap->line2; ++lnum)
5887 {
5888 funcexe_T funcexe;
5889
zeertzjq5299c092023-04-12 20:48:16 +01005890 if (eap->addr_count > 0)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005891 {
5892 if (lnum > curbuf->b_ml.ml_line_count)
5893 {
5894 // If the function deleted lines or switched to another buffer
5895 // the line number may become invalid.
5896 emsg(_(e_invalid_range));
5897 break;
5898 }
5899 curwin->w_cursor.lnum = lnum;
5900 curwin->w_cursor.col = 0;
5901 curwin->w_cursor.coladd = 0;
5902 }
5903 *arg = startarg;
5904
5905 funcexe = *funcexe_init;
5906 funcexe.fe_doesrange = &doesrange;
5907 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5908 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5909 {
5910 failed = TRUE;
5911 break;
5912 }
5913 if (has_watchexpr())
5914 dbg_check_breakpoint(eap);
5915
5916 // Handle a function returning a Funcref, Dictionary or List.
5917 if (handle_subscript(arg, NULL, &rettv,
zeertzjq5299c092023-04-12 20:48:16 +01005918 &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005919 {
5920 failed = TRUE;
5921 break;
5922 }
5923
5924 clear_tv(&rettv);
zeertzjq5299c092023-04-12 20:48:16 +01005925 if (doesrange)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005926 break;
5927
5928 // Stop when immediately aborting on error, or when an interrupt
5929 // occurred or an exception was thrown but not caught.
5930 // get_func_tv() returned OK, so that the check for trailing
5931 // characters below is executed.
5932 if (aborting())
5933 break;
5934 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005935 return failed;
5936}
5937
5938/*
5939 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5940 * Returns FAIL or OK.
5941 */
5942 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005943ex_defer_inner(
5944 char_u *name,
5945 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005946 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005947 partial_T *partial,
5948 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005949{
5950 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005951 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005952 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005953 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005954
5955 if (current_funccal == NULL)
5956 {
5957 semsg(_(e_str_not_inside_function), "defer");
5958 return FAIL;
5959 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005960 if (partial != NULL)
5961 {
5962 if (partial->pt_dict != NULL)
5963 {
5964 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5965 return FAIL;
5966 }
5967 if (partial->pt_argc > 0)
5968 {
5969 int i;
5970
5971 partial_argc = partial->pt_argc;
5972 for (i = 0; i < partial_argc; ++i)
5973 copy_tv(&partial->pt_argv[i], &argvars[i]);
5974 }
5975 }
5976 r = get_func_arguments(arg, evalarg, FALSE,
5977 argvars + partial_argc, &argcount);
5978 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005979
5980 if (r == OK)
5981 {
5982 if (type != NULL)
5983 {
5984 // Check that the arguments are OK for the types of the funcref.
5985 r = check_argument_types(type, argvars, argcount, NULL, name);
5986 }
5987 else if (builtin_function(name, -1))
5988 {
5989 int idx = find_internal_func(name);
5990
5991 if (idx < 0)
5992 {
5993 emsg_funcname(e_unknown_function_str, name);
5994 r = FAIL;
5995 }
5996 else if (check_internal_func(idx, argcount) == -1)
5997 r = FAIL;
5998 }
5999 else
6000 {
6001 ufunc_T *ufunc = find_func(name, FALSE);
6002
6003 // we tolerate an unknown function here, it might be defined later
6004 if (ufunc != NULL)
6005 {
Bram Moolenaar0917e862023-02-18 14:42:44 +00006006 funcerror_T error = check_user_func_argcount(ufunc, argcount);
Bram Moolenaar16900322022-09-08 19:51:45 +01006007 if (error != FCERR_UNKNOWN)
6008 {
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01006009 user_func_error(error, name, FALSE);
Bram Moolenaar16900322022-09-08 19:51:45 +01006010 r = FAIL;
6011 }
6012 }
6013 }
6014 }
6015
Bram Moolenaar86d87252022-09-05 21:21:25 +01006016 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01006017 {
6018 while (--argcount >= 0)
6019 clear_tv(&argvars[argcount]);
6020 return FAIL;
6021 }
6022 return add_defer(name, argcount, argvars);
6023}
6024
6025/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01006026 * Return TRUE if currently inside a function call.
6027 * Give an error message and return FALSE when not.
6028 */
6029 int
6030can_add_defer(void)
6031{
6032 if (!in_def_function() && get_current_funccal() == NULL)
6033 {
6034 semsg(_(e_str_not_inside_function), "defer");
6035 return FALSE;
6036 }
6037 return TRUE;
6038}
6039
6040/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01006041 * Add a deferred call for "name" with arguments "argvars[argcount]".
6042 * Consumes "argvars[]".
6043 * Caller must check that in_def_function() returns TRUE or current_funccal is
6044 * not NULL.
6045 * Returns OK or FAIL.
6046 */
6047 int
6048add_defer(char_u *name, int argcount_arg, typval_T *argvars)
6049{
6050 char_u *saved_name = vim_strsave(name);
6051 int argcount = argcount_arg;
6052 defer_T *dr;
6053 int ret = FAIL;
6054
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006055 if (saved_name == NULL)
6056 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01006057 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006058 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01006059 if (add_defer_function(saved_name, argcount, argvars) == OK)
6060 argcount = 0;
6061 }
6062 else
6063 {
6064 if (current_funccal->fc_defer.ga_itemsize == 0)
6065 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
6066 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
6067 goto theend;
6068 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
6069 + current_funccal->fc_defer.ga_len++;
6070 dr->dr_name = saved_name;
6071 dr->dr_argcount = argcount;
6072 while (argcount > 0)
6073 {
6074 --argcount;
6075 dr->dr_argvars[argcount] = argvars[argcount];
6076 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006077 }
6078 ret = OK;
6079
6080theend:
6081 while (--argcount >= 0)
6082 clear_tv(&argvars[argcount]);
6083 return ret;
6084}
6085
6086/*
6087 * Invoked after a functions has finished: invoke ":defer" functions.
6088 */
Bram Moolenaar58779852022-09-06 18:31:14 +01006089 static void
6090handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006091{
6092 int idx;
6093
Bram Moolenaar58779852022-09-06 18:31:14 +01006094 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006095 {
Bram Moolenaar58779852022-09-06 18:31:14 +01006096 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006097
Bram Moolenaar42994bf2023-04-17 19:23:45 +01006098 if (dr->dr_name == NULL)
6099 // already being called, can happen if function does ":qa"
6100 continue;
6101
6102 funcexe_T funcexe;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006103 CLEAR_FIELD(funcexe);
6104 funcexe.fe_evaluate = TRUE;
6105
Bram Moolenaar42994bf2023-04-17 19:23:45 +01006106 typval_T rettv;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006107 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaar42994bf2023-04-17 19:23:45 +01006108
6109 char_u *name = dr->dr_name;
6110 dr->dr_name = NULL;
6111
6112 call_func(name, -1, &rettv, dr->dr_argcount, dr->dr_argvars, &funcexe);
6113
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006114 clear_tv(&rettv);
Bram Moolenaar42994bf2023-04-17 19:23:45 +01006115 vim_free(name);
6116 for (int i = dr->dr_argcount - 1; i >= 0; --i)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006117 clear_tv(&dr->dr_argvars[i]);
6118 }
Bram Moolenaar58779852022-09-06 18:31:14 +01006119 ga_clear(&funccal->fc_defer);
6120}
6121
zeertzjq960cf912023-04-18 21:52:54 +01006122 static void
6123invoke_funccall_defer(funccall_T *fc)
6124{
6125 if (fc->fc_ectx != NULL)
6126 {
6127 // :def function
6128 unwind_def_callstack(fc->fc_ectx);
6129 may_invoke_defer_funcs(fc->fc_ectx);
6130 }
6131 else
6132 {
6133 // legacy function
6134 handle_defer_one(fc);
6135 }
6136}
6137
Bram Moolenaar58779852022-09-06 18:31:14 +01006138/*
6139 * Called when exiting: call all defer functions.
6140 */
6141 void
6142invoke_all_defer(void)
6143{
zeertzjq1be4b812023-04-19 14:21:24 +01006144 for (funccall_T *fc = current_funccal; fc != NULL; fc = fc->fc_caller)
6145 invoke_funccall_defer(fc);
6146
zeertzjq960cf912023-04-18 21:52:54 +01006147 for (funccal_entry_T *fce = funccal_stack; fce != NULL; fce = fce->next)
6148 for (funccall_T *fc = fce->top_funccal; fc != NULL; fc = fc->fc_caller)
6149 invoke_funccall_defer(fc);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006150}
6151
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006152/*
6153 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006154 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006155 */
6156 void
6157ex_call(exarg_T *eap)
6158{
6159 char_u *arg = eap->arg;
6160 char_u *startarg;
6161 char_u *name;
6162 char_u *tofree;
6163 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006164 int failed = FALSE;
6165 funcdict_T fudi;
6166 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006167 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006168 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00006169 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00006170 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006171
Bram Moolenaare6b53242020-07-01 17:28:33 +02006172 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006173 if (eap->skip)
6174 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006175 typval_T rettv;
6176
Bram Moolenaare38eab22019-12-05 21:50:01 +01006177 // trans_function_name() doesn't work well when skipping, use eval0()
6178 // instead to skip to any following command, e.g. for:
6179 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006180 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006181 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006182 clear_tv(&rettv);
6183 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006184 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006185 return;
6186 }
6187
zeertzjq5299c092023-04-12 20:48:16 +01006188 tofree = trans_function_name_ext(&arg, NULL, FALSE, TFN_INT,
Bram Moolenaar99a7c0d2023-02-21 19:55:14 +00006189 &fudi, &partial, vim9script ? &type : NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006190 if (fudi.fd_newkey != NULL)
6191 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006192 // Still need to give an error message for missing key.
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00006193 semsg(_(e_key_not_present_in_dictionary_str), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006194 vim_free(fudi.fd_newkey);
6195 }
6196 if (tofree == NULL)
6197 return;
6198
Bram Moolenaare38eab22019-12-05 21:50:01 +01006199 // Increase refcount on dictionary, it could get deleted when evaluating
6200 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006201 if (fudi.fd_dict != NULL)
6202 ++fudi.fd_dict->dv_refcount;
6203
Bram Moolenaare38eab22019-12-05 21:50:01 +01006204 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
6205 // contents. For VAR_PARTIAL get its partial, unless we already have one
6206 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006207 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006208 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00006209 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00006210 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006211
Bram Moolenaare38eab22019-12-05 21:50:01 +01006212 // Skip white space to allow ":call func ()". Not good, but required for
6213 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006214 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006215 if (*startarg != '(')
6216 {
Bram Moolenaare1242042021-12-16 20:56:57 +00006217 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006218 goto end;
6219 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00006220 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02006221 {
6222 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
6223 goto end;
6224 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006225
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006226 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006227 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006228 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01006229 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006230 }
6231 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006232 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02006233 funcexe_T funcexe;
6234
Bram Moolenaara80faa82020-04-12 19:37:17 +02006235 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006236 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00006237 funcexe.fe_partial = partial;
6238 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006239 funcexe.fe_firstline = eap->line1;
6240 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00006241 funcexe.fe_found_var = found_var;
zeertzjq5299c092023-04-12 20:48:16 +01006242 funcexe.fe_evaluate = TRUE;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006243 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006245
Bram Moolenaar1d341892021-09-18 15:25:52 +02006246 // When inside :try we need to check for following "| catch" or "| endtry".
6247 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006248 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006249 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006250 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02006251 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02006252 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006253 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02006254 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006255 {
6256 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00006257 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006258 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006259 }
6260 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02006261 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006262 }
Bram Moolenaara929c922022-04-18 15:21:17 +01006263 // Must be after using "arg", it may point into memory cleared here.
6264 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006265
6266end:
6267 dict_unref(fudi.fd_dict);
6268 vim_free(tofree);
6269}
6270
6271/*
6272 * Return from a function. Possibly makes the return pending. Also called
6273 * for a pending return at the ":endtry" or after returning from an extra
6274 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
6275 * when called due to a ":return" command. "rettv" may point to a typval_T
6276 * with the return rettv. Returns TRUE when the return can be carried out,
6277 * FALSE when the return gets pending.
6278 */
6279 int
6280do_return(
6281 exarg_T *eap,
6282 int reanimate,
6283 int is_cmd,
6284 void *rettv)
6285{
6286 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01006287 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006288
6289 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006290 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006291 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006292
6293 /*
6294 * Cleanup (and inactivate) conditionals, but stop when a try conditional
6295 * not in its finally clause (which then is to be executed next) is found.
6296 * In this case, make the ":return" pending for execution at the ":endtry".
6297 * Otherwise, return normally.
6298 */
6299 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
6300 if (idx >= 0)
6301 {
6302 cstack->cs_pending[idx] = CSTP_RETURN;
6303
6304 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006305 // A pending return again gets pending. "rettv" points to an
6306 // allocated variable with the rettv of the original ":return"'s
6307 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006308 cstack->cs_rettv[idx] = rettv;
6309 else
6310 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006311 // When undoing a return in order to make it pending, get the stored
6312 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006313 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006314 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006315
6316 if (rettv != NULL)
6317 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006318 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006319 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
6320 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
6321 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02006322 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006323 }
6324 else
6325 cstack->cs_rettv[idx] = NULL;
6326
6327 if (reanimate)
6328 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006329 // The pending return value could be overwritten by a ":return"
6330 // without argument in a finally clause; reset the default
6331 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006332 current_funccal->fc_rettv->v_type = VAR_NUMBER;
6333 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006334 }
6335 }
6336 report_make_pending(CSTP_RETURN, rettv);
6337 }
6338 else
6339 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006340 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006341
Bram Moolenaare38eab22019-12-05 21:50:01 +01006342 // If the return is carried out now, store the return value. For
6343 // a return immediately after reanimation, the value is already
6344 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006345 if (!reanimate && rettv != NULL)
6346 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006347 clear_tv(current_funccal->fc_rettv);
6348 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006349 if (!is_cmd)
6350 vim_free(rettv);
6351 }
6352 }
6353
6354 return idx < 0;
6355}
6356
6357/*
6358 * Free the variable with a pending return value.
6359 */
6360 void
6361discard_pending_return(void *rettv)
6362{
6363 free_tv((typval_T *)rettv);
6364}
6365
6366/*
6367 * Generate a return command for producing the value of "rettv". The result
6368 * is an allocated string. Used by report_pending() for verbose messages.
6369 */
6370 char_u *
6371get_return_cmd(void *rettv)
6372{
6373 char_u *s = NULL;
6374 char_u *tofree = NULL;
6375 char_u numbuf[NUMBUFLEN];
6376
6377 if (rettv != NULL)
6378 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6379 if (s == NULL)
6380 s = (char_u *)"";
6381
6382 STRCPY(IObuff, ":return ");
6383 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6384 if (STRLEN(s) + 8 >= IOSIZE)
6385 STRCPY(IObuff + IOSIZE - 4, "...");
6386 vim_free(tofree);
6387 return vim_strsave(IObuff);
6388}
6389
6390/*
6391 * Get next function line.
6392 * Called by do_cmdline() to get the next line.
6393 * Returns allocated string, or NULL for end of function.
6394 */
6395 char_u *
6396get_func_line(
6397 int c UNUSED,
6398 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006399 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006400 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006401{
6402 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006403 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006404 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006405 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006406
Bram Moolenaare38eab22019-12-05 21:50:01 +01006407 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006408 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006409 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006410 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006411 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006412 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006413 }
6414#ifdef FEAT_PROFILE
6415 if (do_profiling == PROF_YES)
6416 func_line_end(cookie);
6417#endif
6418
6419 gap = &fp->uf_lines;
6420 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006421 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006422 retval = NULL;
6423 else
6424 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006425 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006426 while (fcp->fc_linenr < gap->ga_len
6427 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6428 ++fcp->fc_linenr;
6429 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006430 retval = NULL;
6431 else
6432 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006433 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6434 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006435#ifdef FEAT_PROFILE
6436 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006437 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006438#endif
6439 }
6440 }
6441
Bram Moolenaare38eab22019-12-05 21:50:01 +01006442 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006443 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006444 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006445 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006446 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006447 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006448 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006449 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006450 }
6451
6452 return retval;
6453}
6454
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006455/*
6456 * Return TRUE if the currently active function should be ended, because a
6457 * return was encountered or an error occurred. Used inside a ":while".
6458 */
6459 int
6460func_has_ended(void *cookie)
6461{
6462 funccall_T *fcp = (funccall_T *)cookie;
6463
Bram Moolenaare38eab22019-12-05 21:50:01 +01006464 // Ignore the "abort" flag if the abortion behavior has been changed due to
6465 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006466 return (((fcp->fc_func->uf_flags & FC_ABORT)
6467 && did_emsg && !aborted_in_try())
6468 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006469}
6470
6471/*
6472 * return TRUE if cookie indicates a function which "abort"s on errors.
6473 */
6474 int
6475func_has_abort(
6476 void *cookie)
6477{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006478 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006479}
6480
6481
6482/*
6483 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6484 * Don't do this when "Func" is already a partial that was bound
6485 * explicitly (pt_auto is FALSE).
6486 * Changes "rettv" in-place.
6487 * Returns the updated "selfdict_in".
6488 */
6489 dict_T *
6490make_partial(dict_T *selfdict_in, typval_T *rettv)
6491{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006492 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006493 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006494 char_u fname_buf[FLEN_FIXED + 1];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006495 dict_T *selfdict = selfdict_in;
6496
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006497 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6498 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006499 fp = rettv->vval.v_partial->pt_func;
6500 else
6501 {
6502 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006503 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006504 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006505 if (fname == NULL)
6506 {
6507 // There is no point binding a dict to a NULL function, just create
6508 // a function reference.
6509 rettv->v_type = VAR_FUNC;
6510 rettv->vval.v_string = NULL;
6511 }
6512 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006513 {
6514 char_u *tofree = NULL;
Bram Moolenaar0917e862023-02-18 14:42:44 +00006515 funcerror_T error;
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006516
6517 // Translate "s:func" to the stored function name.
6518 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6519 fp = find_func(fname, FALSE);
6520 vim_free(tofree);
6521 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006522 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006523
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006524 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006525 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006526 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006527
6528 if (pt != NULL)
6529 {
6530 pt->pt_refcount = 1;
6531 pt->pt_dict = selfdict;
6532 pt->pt_auto = TRUE;
6533 selfdict = NULL;
6534 if (rettv->v_type == VAR_FUNC)
6535 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006536 // Just a function: Take over the function name and use
6537 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006538 pt->pt_name = rettv->vval.v_string;
6539 }
6540 else
6541 {
6542 partial_T *ret_pt = rettv->vval.v_partial;
6543 int i;
6544
Bram Moolenaare38eab22019-12-05 21:50:01 +01006545 // Partial: copy the function name, use selfdict and copy
6546 // args. Can't take over name or args, the partial might
6547 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006548 if (ret_pt->pt_name != NULL)
6549 {
6550 pt->pt_name = vim_strsave(ret_pt->pt_name);
6551 func_ref(pt->pt_name);
6552 }
6553 else
6554 {
6555 pt->pt_func = ret_pt->pt_func;
6556 func_ptr_ref(pt->pt_func);
6557 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006558 if (ret_pt->pt_argc > 0)
6559 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006560 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006561 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006562 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006563 pt->pt_argc = 0;
6564 else
6565 {
6566 pt->pt_argc = ret_pt->pt_argc;
6567 for (i = 0; i < pt->pt_argc; i++)
6568 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6569 }
6570 }
6571 partial_unref(ret_pt);
6572 }
6573 rettv->v_type = VAR_PARTIAL;
6574 rettv->vval.v_partial = pt;
6575 }
6576 }
6577 return selfdict;
6578}
6579
6580/*
6581 * Return the name of the executed function.
6582 */
6583 char_u *
6584func_name(void *cookie)
6585{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006586 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006587}
6588
6589/*
6590 * Return the address holding the next breakpoint line for a funccall cookie.
6591 */
6592 linenr_T *
6593func_breakpoint(void *cookie)
6594{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006595 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006596}
6597
6598/*
6599 * Return the address holding the debug tick for a funccall cookie.
6600 */
6601 int *
6602func_dbg_tick(void *cookie)
6603{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006604 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006605}
6606
6607/*
6608 * Return the nesting level for a funccall cookie.
6609 */
6610 int
6611func_level(void *cookie)
6612{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006613 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006614}
6615
6616/*
6617 * Return TRUE when a function was ended by a ":return" command.
6618 */
6619 int
6620current_func_returned(void)
6621{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006622 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006623}
6624
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006625 int
6626free_unref_funccal(int copyID, int testing)
6627{
6628 int did_free = FALSE;
6629 int did_free_funccal = FALSE;
6630 funccall_T *fc, **pfc;
6631
6632 for (pfc = &previous_funccal; *pfc != NULL; )
6633 {
6634 if (can_free_funccal(*pfc, copyID))
6635 {
6636 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006637 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006638 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006639 did_free = TRUE;
6640 did_free_funccal = TRUE;
6641 }
6642 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006643 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006644 }
6645 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006646 // When a funccal was freed some more items might be garbage
6647 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006648 (void)garbage_collect(testing);
6649
6650 return did_free;
6651}
6652
6653/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006654 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006655 */
6656 static funccall_T *
6657get_funccal(void)
6658{
6659 int i;
6660 funccall_T *funccal;
6661 funccall_T *temp_funccal;
6662
6663 funccal = current_funccal;
6664 if (debug_backtrace_level > 0)
6665 {
6666 for (i = 0; i < debug_backtrace_level; i++)
6667 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006668 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006669 if (temp_funccal)
6670 funccal = temp_funccal;
6671 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006672 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006673 debug_backtrace_level = i;
6674 }
6675 }
6676 return funccal;
6677}
6678
6679/*
6680 * Return the hashtable used for local variables in the current funccal.
6681 * Return NULL if there is no current funccal.
6682 */
6683 hashtab_T *
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +00006684get_funccal_local_ht(void)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006685{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006686 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006687 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006688 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006689}
6690
6691/*
6692 * Return the l: scope variable.
6693 * Return NULL if there is no current funccal.
6694 */
6695 dictitem_T *
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +00006696get_funccal_local_var(void)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006697{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006698 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006699 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006700 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006701}
6702
6703/*
6704 * Return the hashtable used for argument in the current funccal.
6705 * Return NULL if there is no current funccal.
6706 */
6707 hashtab_T *
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +00006708get_funccal_args_ht(void)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006709{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006710 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006711 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006712 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006713}
6714
6715/*
6716 * Return the a: scope variable.
6717 * Return NULL if there is no current funccal.
6718 */
6719 dictitem_T *
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +00006720get_funccal_args_var(void)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006721{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006722 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006723 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006724 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006725}
6726
6727/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006728 * List function variables, if there is a function.
6729 */
6730 void
6731list_func_vars(int *first)
6732{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006733 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6734 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006735 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006736}
6737
6738/*
6739 * If "ht" is the hashtable for local variables in the current funccal, return
6740 * the dict that contains it.
6741 * Otherwise return NULL.
6742 */
6743 dict_T *
6744get_current_funccal_dict(hashtab_T *ht)
6745{
6746 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006747 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6748 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006749 return NULL;
6750}
6751
6752/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006753 * Search hashitem in parent scope.
6754 */
6755 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006756find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006757{
6758 funccall_T *old_current_funccal = current_funccal;
6759 hashtab_T *ht;
6760 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006761 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006762
Bram Moolenaarca16c602022-09-06 18:57:08 +01006763 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006764 return NULL;
6765
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006766 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006767 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006768 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006769 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006770 ht = find_var_ht(name, &varname);
6771 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006772 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006773 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006774 if (!HASHITEM_EMPTY(hi))
6775 {
6776 *pht = ht;
6777 break;
6778 }
6779 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006780 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006781 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006782 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006783 }
6784 current_funccal = old_current_funccal;
6785
6786 return hi;
6787}
6788
6789/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006790 * Search variable in parent scope.
6791 */
6792 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006793find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006794{
6795 dictitem_T *v = NULL;
6796 funccall_T *old_current_funccal = current_funccal;
6797 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006798 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006799
Bram Moolenaarca16c602022-09-06 18:57:08 +01006800 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006801 return NULL;
6802
Bram Moolenaare38eab22019-12-05 21:50:01 +01006803 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006804 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006805 while (current_funccal)
6806 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006807 ht = find_var_ht(name, &varname);
6808 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006809 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006810 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006811 if (v != NULL)
6812 break;
6813 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006814 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006815 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006816 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006817 }
6818 current_funccal = old_current_funccal;
6819
6820 return v;
6821}
6822
6823/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006824 * Set "copyID + 1" in previous_funccal and callers.
6825 */
6826 int
6827set_ref_in_previous_funccal(int copyID)
6828{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006829 funccall_T *fc;
6830
Bram Moolenaarca16c602022-09-06 18:57:08 +01006831 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006832 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006833 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006834 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6835 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6836 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006837 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006838 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006839 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006840}
6841
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006842 static int
6843set_ref_in_funccal(funccall_T *fc, int copyID)
6844{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006845 if (fc->fc_copyID != copyID)
6846 {
6847 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006848 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6849 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6850 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6851 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006852 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006853 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006854 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006855}
6856
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006857/*
6858 * Set "copyID" in all local vars and arguments in the call stack.
6859 */
6860 int
6861set_ref_in_call_stack(int copyID)
6862{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006863 funccall_T *fc;
6864 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006865
Bram Moolenaarca16c602022-09-06 18:57:08 +01006866 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006867 if (set_ref_in_funccal(fc, copyID))
6868 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006869
6870 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006871 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006872 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006873 if (set_ref_in_funccal(fc, copyID))
6874 return TRUE;
6875 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006876}
6877
6878/*
6879 * Set "copyID" in all functions available by name.
6880 */
6881 int
6882set_ref_in_functions(int copyID)
6883{
6884 int todo;
6885 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006886 ufunc_T *fp;
6887
6888 todo = (int)func_hashtab.ht_used;
6889 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006890 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006891 if (!HASHITEM_EMPTY(hi))
6892 {
6893 --todo;
6894 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006895 if (!func_name_refcount(fp->uf_name)
6896 && set_ref_in_func(NULL, fp, copyID))
6897 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006898 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006899 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006900 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006901}
6902
6903/*
6904 * Set "copyID" in all function arguments.
6905 */
6906 int
6907set_ref_in_func_args(int copyID)
6908{
6909 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006910
6911 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006912 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6913 copyID, NULL, NULL))
6914 return TRUE;
6915 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006916}
6917
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006918/*
6919 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006920 * Returns TRUE if setting references failed somehow.
6921 */
6922 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006923set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006924{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006925 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006926 funccall_T *fc;
Bram Moolenaar0917e862023-02-18 14:42:44 +00006927 funcerror_T error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006928 char_u fname_buf[FLEN_FIXED + 1];
6929 char_u *tofree = NULL;
6930 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006931 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006932
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006933 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006934 return FALSE;
6935
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006936 if (fp_in == NULL)
6937 {
6938 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006939 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006940 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006941 if (fp != NULL)
6942 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006943 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006944 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006945 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006946
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006947 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006948 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006949}
6950
Bram Moolenaare38eab22019-12-05 21:50:01 +01006951#endif // FEAT_EVAL