blob: 3ff49c9dd0fed46e402303843d284fd4d9582f1b [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +010035static char_u *untrans_function_name(char_u *name);
Bram Moolenaar58779852022-09-06 18:31:14 +010036static void handle_defer_one(funccall_T *funccal);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020037
38 void
39func_init()
40{
41 hash_init(&func_hashtab);
42}
43
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020044/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020045 * Return the function hash table
46 */
47 hashtab_T *
48func_tbl_get(void)
49{
50 return &func_hashtab;
51}
52
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaardce24412022-02-08 20:35:30 +000058 * If "eap" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaardce24412022-02-08 20:35:30 +000069 exarg_T *eap,
Bram Moolenaar2a389082021-04-09 20:24:31 +020070 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010071 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072{
Bram Moolenaar6e949782020-04-13 17:21:00 +020073 char_u *p = arg;
74 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020075 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010076
77 while (ASCII_ISALNUM(*p) || *p == '_')
78 ++p;
79 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020080 || (argtypes == NULL
81 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
82 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010083 {
84 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000085 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 return arg;
87 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010088
Bram Moolenaar057e84a2021-02-28 16:55:11 +010089 // Vim9 script: cannot use script var name for argument. In function: also
90 // check local vars and arguments.
91 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
Bram Moolenaardce24412022-02-08 20:35:30 +000092 evalarg == NULL ? NULL : evalarg->eval_cctx,
93 eap == NULL ? NULL : eap->cstack, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000117 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000172 * Get a next line, store it in "eap" if appropriate and put the line in
173 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000174 */
175 static char_u *
176get_function_line(
177 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000178 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000179 int indent,
180 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000181{
182 char_u *theline;
183
184 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000185 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000186 else
187 theline = eap->getline(':', eap->cookie, indent, getline_options);
188 if (theline != NULL)
189 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000190 if (lines_to_free->ga_len > 0
Bram Moolenaarffdaca92022-12-09 21:41:48 +0000191 && eap->cmdlinep != NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000192 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
193 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000194 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000195 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{
773 if (cstack != NULL && cstack->cs_idx >= 0)
774 {
775 int count = cstack->cs_idx + 1;
776 int i;
777
778 fp->uf_block_ids = ALLOC_MULT(int, count);
779 if (fp->uf_block_ids != NULL)
780 {
781 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
782 sizeof(int) * count);
783 fp->uf_block_depth = count;
784 }
785
786 // Set flag in each block to indicate a function was defined. This
787 // is used to keep the variable when leaving the block, see
788 // hide_script_var().
789 for (i = 0; i <= cstack->cs_idx; ++i)
790 cstack->cs_flags[i] |= CSF_FUNC_DEF;
791 }
792}
793
794/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100795 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200796 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100797 * "newlines" must already have been initialized.
798 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
799 */
800 static int
801get_function_body(
802 exarg_T *eap,
803 garray_T *newlines,
804 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000805 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100806{
807 linenr_T sourcing_lnum_top = SOURCING_LNUM;
808 linenr_T sourcing_lnum_off;
809 int saved_wait_return = need_wait_return;
810 char_u *line_arg = line_arg_in;
811 int vim9_function = eap->cmdidx == CMD_def
812 || eap->cmdidx == CMD_block;
813#define MAX_FUNC_NESTING 50
814 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200815 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100816 int nesting = 0;
817 getline_opt_T getline_options;
818 int indent = 2;
819 char_u *skip_until = NULL;
820 int ret = FAIL;
821 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200822 int heredoc_concat_len = 0;
823 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100824 char_u *heredoc_trimmed = NULL;
825
Bram Moolenaar20677332021-06-06 17:02:53 +0200826 ga_init2(&heredoc_ga, 1, 500);
827
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100828 // Detect having skipped over comment lines to find the return
829 // type. Add NULL lines to keep the line count correct.
830 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
831 if (SOURCING_LNUM < sourcing_lnum_off)
832 {
833 sourcing_lnum_off -= SOURCING_LNUM;
834 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
835 goto theend;
836 while (sourcing_lnum_off-- > 0)
837 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
838 }
839
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200840 nesting_def[0] = vim9_function;
841 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100842 getline_options = vim9_function
843 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
844 for (;;)
845 {
846 char_u *theline;
847 char_u *p;
848 char_u *arg;
849
850 if (KeyTyped)
851 {
852 msg_scroll = TRUE;
853 saved_wait_return = FALSE;
854 }
855 need_wait_return = FALSE;
856
857 if (line_arg != NULL)
858 {
859 // Use eap->arg, split up in parts by line breaks.
860 theline = line_arg;
861 p = vim_strchr(theline, '\n');
862 if (p == NULL)
863 line_arg += STRLEN(line_arg);
864 else
865 {
866 *p = NUL;
867 line_arg = p + 1;
868 }
869 }
870 else
871 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000872 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100873 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100874 }
875 if (KeyTyped)
876 lines_left = Rows - 1;
877 if (theline == NULL)
878 {
879 // Use the start of the function for the line number.
880 SOURCING_LNUM = sourcing_lnum_top;
881 if (skip_until != NULL)
882 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200883 else if (nesting_inline[nesting])
884 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100885 else if (eap->cmdidx == CMD_def)
886 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100887 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000888 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100889 goto theend;
890 }
891
892 // Detect line continuation: SOURCING_LNUM increased more than one.
893 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
894 if (SOURCING_LNUM < sourcing_lnum_off)
895 sourcing_lnum_off -= SOURCING_LNUM;
896 else
897 sourcing_lnum_off = 0;
898
899 if (skip_until != NULL)
900 {
901 // Don't check for ":endfunc"/":enddef" between
902 // * ":append" and "."
903 // * ":python <<EOF" and "EOF"
904 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
905 if (heredoc_trimmed == NULL
906 || (is_heredoc && skipwhite(theline) == theline)
907 || STRNCMP(theline, heredoc_trimmed,
908 STRLEN(heredoc_trimmed)) == 0)
909 {
910 if (heredoc_trimmed == NULL)
911 p = theline;
912 else if (is_heredoc)
913 p = skipwhite(theline) == theline
914 ? theline : theline + STRLEN(heredoc_trimmed);
915 else
916 p = theline + STRLEN(heredoc_trimmed);
917 if (STRCMP(p, skip_until) == 0)
918 {
919 VIM_CLEAR(skip_until);
920 VIM_CLEAR(heredoc_trimmed);
921 getline_options = vim9_function
922 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
923 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200924
925 if (heredoc_concat_len > 0)
926 {
927 // Replace the starting line with all the concatenated
928 // lines.
929 ga_concat(&heredoc_ga, theline);
930 vim_free(((char_u **)(newlines->ga_data))[
931 heredoc_concat_len - 1]);
932 ((char_u **)(newlines->ga_data))[
933 heredoc_concat_len - 1] = heredoc_ga.ga_data;
934 ga_init(&heredoc_ga);
935 heredoc_concat_len = 0;
936 theline += STRLEN(theline); // skip the "EOF"
937 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100938 }
939 }
940 }
941 else
942 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200943 int c;
944 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000945 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100946
947 // skip ':' and blanks
948 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
949 ;
950
951 // Check for "endfunction", "enddef" or "}".
952 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000953 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200954 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100955 ? *p == '}'
956 : (checkforcmd(&p, nesting_def[nesting]
957 ? "enddef" : "endfunction", 4)
958 && *p != ':'))
959 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000960 if (!nesting_inline[nesting] && nesting_def[nesting]
961 && p < cmd + 6)
962 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100963 if (nesting-- == 0)
964 {
965 char_u *nextcmd = NULL;
966
967 if (*p == '|' || *p == '}')
968 nextcmd = p + 1;
969 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
970 nextcmd = line_arg;
971 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100972 && (vim9_function || p_verbose > 0))
973 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200974 SOURCING_LNUM = sourcing_lnum_top
975 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100976 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000977 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100978 else
979 give_warning2((char_u *)
980 _("W22: Text found after :endfunction: %s"),
981 p, TRUE);
982 }
983 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100984 {
985 // Another command follows. If the line came from "eap"
986 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000987 // change "eap->cmdlinep" to point to the last fetched
988 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100989 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000990 if (lines_to_free->ga_len > 0
991 && *eap->cmdlinep !=
992 ((char_u **)lines_to_free->ga_data)
993 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100994 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000995 // *cmdlinep will be freed later, thus remove the
996 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000998 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
999 [lines_to_free->ga_len - 1];
1000 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001001 }
1002 }
1003 break;
1004 }
1005 }
1006
1007 // Check for mismatched "endfunc" or "enddef".
1008 // We don't check for "def" inside "func" thus we also can't check
1009 // for "enddef".
1010 // We continue to find the end of the function, although we might
1011 // not find it.
1012 else if (nesting_def[nesting])
1013 {
1014 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
1015 emsg(_(e_mismatched_endfunction));
1016 }
1017 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
1018 emsg(_(e_mismatched_enddef));
1019
1020 // Increase indent inside "if", "while", "for" and "try", decrease
1021 // at "end".
1022 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
1023 indent -= 2;
1024 else if (STRNCMP(p, "if", 2) == 0
1025 || STRNCMP(p, "wh", 2) == 0
1026 || STRNCMP(p, "for", 3) == 0
1027 || STRNCMP(p, "try", 3) == 0)
1028 indent += 2;
1029
1030 // Check for defining a function inside this function.
1031 // Only recognize "def" inside "def", not inside "function",
1032 // For backwards compatibility, see Test_function_python().
1033 c = *p;
1034 if (is_function_cmd(&p)
1035 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
1036 {
1037 if (*p == '!')
1038 p = skipwhite(p + 1);
1039 p += eval_fname_script(p);
1040 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
1041 NULL, NULL));
1042 if (*skipwhite(p) == '(')
1043 {
1044 if (nesting == MAX_FUNC_NESTING - 1)
1045 emsg(_(e_function_nesting_too_deep));
1046 else
1047 {
1048 ++nesting;
1049 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001050 nesting_inline[nesting] = FALSE;
1051 indent += 2;
1052 }
1053 }
1054 }
1055
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001056 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001057 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001058 // Not a comment line: check for nested inline function.
1059 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001060 while (end > p && VIM_ISWHITE(*end))
1061 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +02001062 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001063 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001064 int is_block;
1065
1066 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001067 --end;
1068 while (end > p && VIM_ISWHITE(*end))
1069 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001070 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
1071 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +02001072 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +02001073 char_u *s = p;
1074
1075 // check for line starting with "au" for :autocmd or
1076 // "com" for :command, these can use a {} block
1077 is_block = checkforcmd_noparen(&s, "autocmd", 2)
1078 || checkforcmd_noparen(&s, "command", 3);
1079 }
1080
1081 if (is_block)
1082 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +02001083 if (nesting == MAX_FUNC_NESTING - 1)
1084 emsg(_(e_function_nesting_too_deep));
1085 else
1086 {
1087 ++nesting;
1088 nesting_def[nesting] = TRUE;
1089 nesting_inline[nesting] = TRUE;
1090 indent += 2;
1091 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001092 }
1093 }
1094 }
1095
1096 // Check for ":append", ":change", ":insert". Not for :def.
1097 p = skip_range(p, FALSE, NULL);
1098 if (!vim9_function
1099 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1100 || (p[0] == 'c'
1101 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1102 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1103 && (STRNCMP(&p[3], "nge", 3) != 0
1104 || !ASCII_ISALPHA(p[6])))))))
1105 || (p[0] == 'i'
1106 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1107 && (!ASCII_ISALPHA(p[2])
1108 || (p[2] == 's'
1109 && (!ASCII_ISALPHA(p[3])
1110 || p[3] == 'e'))))))))
1111 skip_until = vim_strsave((char_u *)".");
1112
1113 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1114 arg = skipwhite(skiptowhite(p));
1115 if (arg[0] == '<' && arg[1] =='<'
1116 && ((p[0] == 'p' && p[1] == 'y'
1117 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1118 || ((p[2] == '3' || p[2] == 'x')
1119 && !ASCII_ISALPHA(p[3]))))
1120 || (p[0] == 'p' && p[1] == 'e'
1121 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1122 || (p[0] == 't' && p[1] == 'c'
1123 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1124 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1125 && !ASCII_ISALPHA(p[3]))
1126 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1127 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1128 || (p[0] == 'm' && p[1] == 'z'
1129 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1130 ))
1131 {
1132 // ":python <<" continues until a dot, like ":append"
1133 p = skipwhite(arg + 2);
1134 if (STRNCMP(p, "trim", 4) == 0)
1135 {
1136 // Ignore leading white space.
1137 p = skipwhite(p + 4);
1138 heredoc_trimmed = vim_strnsave(theline,
1139 skipwhite(theline) - theline);
1140 }
1141 if (*p == NUL)
1142 skip_until = vim_strsave((char_u *)".");
1143 else
1144 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1145 getline_options = GETLINE_NONE;
1146 is_heredoc = TRUE;
Bram Moolenaard881d152022-05-13 13:50:36 +01001147 if (eap->cmdidx == CMD_def && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001148 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001149 }
1150
Bram Moolenaard881d152022-05-13 13:50:36 +01001151 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001152 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001153 // Check for ":cmd v =<< [trim] EOF"
1154 // and ":cmd [a, b] =<< [trim] EOF"
1155 // and "lines =<< [trim] EOF" for Vim9
1156 // Where "cmd" can be "let", "var", "final" or "const".
1157 arg = skipwhite(skiptowhite(p));
1158 if (*arg == '[')
1159 arg = vim_strchr(arg, ']');
1160 if (arg != NULL)
1161 {
1162 int found = (eap->cmdidx == CMD_def && arg[0] == '='
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001163 && arg[1] == '<' && arg[2] =='<');
1164
Bram Moolenaard881d152022-05-13 13:50:36 +01001165 if (!found)
1166 // skip over the argument after "cmd"
1167 arg = skipwhite(skiptowhite(arg));
1168 if (found || (arg[0] == '=' && arg[1] == '<'
1169 && arg[2] =='<'
1170 && (checkforcmd(&p, "let", 2)
1171 || checkforcmd(&p, "var", 3)
1172 || checkforcmd(&p, "final", 5)
1173 || checkforcmd(&p, "const", 5))))
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001174 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001175 p = skipwhite(arg + 3);
1176 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001177 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001178 if (STRNCMP(p, "trim", 4) == 0)
1179 {
1180 // Ignore leading white space.
1181 p = skipwhite(p + 4);
1182 heredoc_trimmed = vim_strnsave(theline,
1183 skipwhite(theline) - theline);
1184 continue;
1185 }
1186 if (STRNCMP(p, "eval", 4) == 0)
1187 {
1188 // Ignore leading white space.
1189 p = skipwhite(p + 4);
1190 continue;
1191 }
1192 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001193 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001194 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1195 getline_options = GETLINE_NONE;
1196 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001197 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001198 }
1199 }
1200 }
1201
1202 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001203 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001204 goto theend;
1205
Bram Moolenaar20677332021-06-06 17:02:53 +02001206 if (heredoc_concat_len > 0)
1207 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001208 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001209 // to be used for the instruction later.
1210 ga_concat(&heredoc_ga, theline);
1211 ga_concat(&heredoc_ga, (char_u *)"\n");
1212 p = vim_strsave((char_u *)"");
1213 }
1214 else
1215 {
1216 // Copy the line to newly allocated memory. get_one_sourceline()
1217 // allocates 250 bytes per line, this saves 80% on average. The
1218 // cost is an extra alloc/free.
1219 p = vim_strsave(theline);
1220 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001221 if (p == NULL)
1222 goto theend;
1223 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1224
1225 // Add NULL lines for continuation lines, so that the line count is
1226 // equal to the index in the growarray.
1227 while (sourcing_lnum_off-- > 0)
1228 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1229
1230 // Check for end of eap->arg.
1231 if (line_arg != NULL && *line_arg == NUL)
1232 line_arg = NULL;
1233 }
1234
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001235 // Return OK when no error was detected.
1236 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001237 ret = OK;
1238
1239theend:
1240 vim_free(skip_until);
1241 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001242 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001243 need_wait_return |= saved_wait_return;
1244 return ret;
1245}
1246
1247/*
1248 * Handle the body of a lambda. *arg points to the "{", process statements
1249 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001250 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001251 * When successful "rettv" is set to a funcref.
1252 */
1253 static int
1254lambda_function_body(
1255 char_u **arg,
1256 typval_T *rettv,
1257 evalarg_T *evalarg,
1258 garray_T *newargs,
1259 garray_T *argtypes,
1260 int varargs,
1261 garray_T *default_args,
1262 char_u *ret_type)
1263{
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001264 char_u *start = *arg;
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001265 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001266 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001267 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001268 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001269 exarg_T eap;
1270 garray_T newlines;
1271 char_u *cmdline = NULL;
1272 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001273 partial_T *pt;
1274 char_u *name;
1275 int lnum_save = -1;
1276 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1277
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001278 *arg = skipwhite(*arg + 1);
1279 if (**arg == '|' || !ends_excmd2(start, *arg))
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001280 {
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001281 semsg(_(e_trailing_characters_str), *arg);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001282 return FAIL;
1283 }
1284
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001285 CLEAR_FIELD(eap);
1286 eap.cmdidx = CMD_block;
1287 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001288 eap.cmdlinep = &cmdline;
1289 eap.skip = !evaluate;
1290 if (evalarg->eval_cctx != NULL)
1291 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1292 else
1293 {
1294 eap.getline = evalarg->eval_getline;
1295 eap.cookie = evalarg->eval_cookie;
1296 }
1297
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001298 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001299 if (get_function_body(&eap, &newlines, NULL,
1300 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001301 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001302
1303 // When inside a lambda must add the function lines to evalarg.eval_ga.
1304 evalarg->eval_break_count += newlines.ga_len;
1305 if (gap->ga_itemsize > 0)
1306 {
1307 int idx;
1308 char_u *last;
1309 size_t plen;
1310 char_u *pnl;
1311
1312 for (idx = 0; idx < newlines.ga_len; ++idx)
1313 {
1314 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1315
Bram Moolenaarecb66452021-05-18 15:09:18 +02001316 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001317 goto erret;
1318
1319 // Going to concatenate the lines after parsing. For an empty or
1320 // comment line use an empty string.
1321 // Insert NL characters at the start of each line, the string will
1322 // be split again later in .get_lambda_tv().
1323 if (*p == NUL || vim9_comment_start(p))
1324 p = (char_u *)"";
1325 plen = STRLEN(p);
1326 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1327 if (pnl != NULL)
1328 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001329 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1330 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001331 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001332 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001333 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001334 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001335 // more is following after the "}", which was skipped
1336 last = cmdline;
1337 else
1338 // nothing is following the "}"
1339 last = (char_u *)"}";
1340 plen = STRLEN(last);
1341 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1342 if (pnl != NULL)
1343 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001344 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1345 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001346 }
1347
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001348 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001349 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001350 garray_T *tfgap = &evalarg->eval_tofree_ga;
1351
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001352 // Something comes after the "}".
1353 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001354
1355 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001356 if (ga_grow(tfgap, 1) == OK)
1357 {
1358 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1359 evalarg->eval_using_cmdline = TRUE;
1360 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001361 }
1362 else
1363 *arg = (char_u *)"";
1364
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001365 if (!evaluate)
1366 {
1367 ret = OK;
1368 goto erret;
1369 }
1370
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001371 name = get_lambda_name();
Bram Moolenaare01e5212023-01-08 20:31:18 +00001372 ufunc = alloc_ufunc(name);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001373 if (ufunc == NULL)
1374 goto erret;
1375 set_ufunc_name(ufunc, name);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001376 if (hash_add(&func_hashtab, UF2HIKEY(ufunc), "add function") == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001377 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001378 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001379 ufunc->uf_refcount = 1;
1380 ufunc->uf_args = *newargs;
1381 newargs->ga_data = NULL;
1382 ufunc->uf_def_args = *default_args;
1383 default_args->ga_data = NULL;
1384 ufunc->uf_func_type = &t_func_any;
1385
1386 // error messages are for the first function line
1387 lnum_save = SOURCING_LNUM;
1388 SOURCING_LNUM = sourcing_lnum_top;
1389
1390 // parse argument types
1391 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1392 {
1393 SOURCING_LNUM = lnum_save;
1394 goto erret;
1395 }
1396
1397 // parse the return type, if any
1398 if (parse_return_type(ufunc, ret_type) == FAIL)
1399 goto erret;
1400
1401 pt = ALLOC_CLEAR_ONE(partial_T);
1402 if (pt == NULL)
1403 goto erret;
1404 pt->pt_func = ufunc;
1405 pt->pt_refcount = 1;
1406
1407 ufunc->uf_lines = newlines;
1408 newlines.ga_data = NULL;
1409 if (sandbox)
1410 ufunc->uf_flags |= FC_SANDBOX;
1411 if (!ASCII_ISUPPER(*ufunc->uf_name))
1412 ufunc->uf_flags |= FC_VIM9;
1413 ufunc->uf_script_ctx = current_sctx;
1414 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1415 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1416 set_function_type(ufunc);
1417
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001418 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1419
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001420 rettv->vval.v_partial = pt;
1421 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001422 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001423 ret = OK;
1424
1425erret:
1426 if (lnum_save >= 0)
1427 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001428 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001429 if (newargs != NULL)
1430 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001431 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001432 if (ufunc != NULL)
1433 {
1434 func_clear(ufunc, TRUE);
1435 func_free(ufunc, TRUE);
1436 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001437 return ret;
1438}
1439
1440/*
1441 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001442 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001443 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1445 */
1446 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001447get_lambda_tv(
1448 char_u **arg,
1449 typval_T *rettv,
1450 int types_optional,
1451 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001452{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001453 int evaluate = evalarg != NULL
1454 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 garray_T newargs;
1456 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001457 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001458 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001459 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001460 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001461 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001463 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001464 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001465 char_u *s;
1466 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001467 int *old_eval_lavars = eval_lavars_used;
1468 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001469 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001470 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001471 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001472 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001473 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001474 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001475
Bram Moolenaar4525a572022-02-13 11:57:33 +00001476 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001477 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478
1479 ga_init(&newargs);
1480 ga_init(&newlines);
1481
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001482 // First, check if this is really a lambda expression. "->" or "=>" must
1483 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001484 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001485 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001486 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001487 NULL, &default_args, TRUE, NULL, FALSE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001488 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001489 {
1490 if (types_optional)
1491 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001492 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001493 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001494
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001495 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001496 if (evaluate)
1497 pnewargs = &newargs;
1498 else
1499 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001500 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001501 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001502 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001503 &varargs, &default_args,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00001504 FALSE, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001505 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001506 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001507 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001508 {
1509 if (types_optional)
1510 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001511 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001512 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001513 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001514 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001516 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1517 if (ret_type != NULL)
1518 {
1519 ret_type = vim_strsave(ret_type);
1520 tofree2 = ret_type;
1521 }
1522
Bram Moolenaare38eab22019-12-05 21:50:01 +01001523 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001524 if (evaluate)
1525 eval_lavars_used = &eval_lavars;
1526
Bram Moolenaar65c44152020-12-24 15:14:01 +01001527 *arg = skipwhite_and_linebreak(*arg, evalarg);
1528
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001529 // Recognize "{" as the start of a function body.
1530 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001531 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001532 if (evalarg == NULL)
1533 // cannot happen?
1534 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001535 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001536 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1537 types_optional ? &argtypes : NULL, varargs,
1538 &default_args, ret_type) == FAIL)
1539 goto errret;
1540 goto theend;
1541 }
1542 if (default_args.ga_len > 0)
1543 {
1544 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001545 goto errret;
1546 }
1547
Bram Moolenaare38eab22019-12-05 21:50:01 +01001548 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001549 start = *arg;
1550 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001551 if (ret == FAIL)
1552 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001553
Bram Moolenaar65c44152020-12-24 15:14:01 +01001554 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001555 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001556 *arg = skipwhite_and_linebreak(*arg, evalarg);
1557 if (**arg != '}')
1558 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001559 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001560 goto errret;
1561 }
1562 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001563 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564
1565 if (evaluate)
1566 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001567 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001568 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001569 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001570 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001571 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001572
Bram Moolenaare01e5212023-01-08 20:31:18 +00001573 fp = alloc_ufunc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 if (fp == NULL)
1575 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001576 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001577 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001578 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001579 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001581 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 if (ga_grow(&newlines, 1) == FAIL)
1583 goto errret;
1584
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001585 // If there are line breaks, we need to split up the string.
1586 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001587 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001588 line_end = end;
1589
1590 // Add "return " before the expression (or the first line).
1591 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001592 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593 if (p == NULL)
1594 goto errret;
1595 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1596 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001597 vim_strncpy(p + 7, start, line_end - start);
1598
1599 if (line_end != end)
1600 {
1601 // Add more lines, split by line breaks. Thus is used when a
1602 // lambda with { cmds } is encountered.
1603 while (*line_end == '\n')
1604 {
1605 if (ga_grow(&newlines, 1) == FAIL)
1606 goto errret;
1607 start = line_end + 1;
1608 line_end = vim_strchr(start, '\n');
1609 if (line_end == NULL)
1610 line_end = end;
1611 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1612 vim_strnsave(start, line_end - start);
1613 }
1614 }
1615
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001616 if (strstr((char *)p + 7, "a:") == NULL)
1617 // No a: variables are used for sure.
1618 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619
1620 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001621 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001623 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001624 if (types_optional)
1625 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001626 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001627 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001628 goto errret;
1629 if (ret_type != NULL)
1630 {
1631 fp->uf_ret_type = parse_type(&ret_type,
1632 &fp->uf_type_list, TRUE);
1633 if (fp->uf_ret_type == NULL)
1634 goto errret;
1635 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001636 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001637 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001638 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001639
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001641 if (current_funccal != NULL && eval_lavars)
1642 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001643 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001644 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001645 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001646 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647
1648#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 if (prof_def_func())
1650 func_do_profile(fp);
1651#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001652 if (sandbox)
1653 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001654 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001655 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001656 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001657 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001659 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001660 // Use the line number of the arguments.
1661 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001662
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001663 function_using_block_scopes(fp, evalarg->eval_cstack);
1664
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001665 pt->pt_func = fp;
1666 pt->pt_refcount = 1;
1667 rettv->vval.v_partial = pt;
1668 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001669
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001670 hash_add(&func_hashtab, UF2HIKEY(fp), "add lambda");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001671 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001672
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001673theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001674 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001675 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001676 if (types_optional)
1677 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001678
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679 return OK;
1680
1681errret:
1682 ga_clear_strings(&newargs);
1683 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001684 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001685 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001686 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001687 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001688 if (fp != NULL)
1689 vim_free(fp->uf_arg_types);
1690 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001692 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001693 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001694 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001695 return FAIL;
1696}
1697
1698/*
1699 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1700 * name it contains, otherwise return "name".
1701 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1702 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001703 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1704 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001705 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001706 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707 */
1708 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001709deref_func_name(
1710 char_u *name,
1711 int *lenp,
1712 partial_T **partialp,
1713 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001714 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001715 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001716 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717{
1718 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001719 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001721 char_u *s = NULL;
1722 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001723 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001724
1725 if (partialp != NULL)
1726 *partialp = NULL;
1727
1728 cc = name[*lenp];
1729 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001730
Bram Moolenaar71f21932022-01-07 18:20:55 +00001731 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001733 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001735 tv = &v->di_tv;
1736 }
1737 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1738 {
1739 imported_T *import;
1740 char_u *p = name;
1741 int len = *lenp;
1742
1743 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001744 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001745 p = name + 2;
1746 len -= 2;
1747 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001748 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001749
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001750 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001751 if (import != NULL)
1752 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001753 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001754 if (new_function)
1755 semsg(_(e_redefining_imported_item_str), name);
1756 else
1757 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001758 name[len] = cc;
1759 *lenp = 0;
1760 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001761 }
1762 }
1763
1764 if (tv != NULL)
1765 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001766 if (found_var != NULL)
1767 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001768 if (tv->v_type == VAR_FUNC)
1769 {
1770 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001771 {
1772 *lenp = 0;
1773 return (char_u *)""; // just in case
1774 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001775 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001776 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001779 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001781 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001782
1783 if (pt == NULL)
1784 {
1785 *lenp = 0;
1786 return (char_u *)""; // just in case
1787 }
1788 if (partialp != NULL)
1789 *partialp = pt;
1790 s = partial_name(pt);
1791 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001793
1794 if (s != NULL)
1795 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001796 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001797 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001798 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001799
1800 if (sv != NULL)
1801 *type = sv->sv_type;
1802 }
1803 return s;
1804 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805 }
1806
1807 return name;
1808}
1809
1810/*
1811 * Give an error message with a function name. Handle <SNR> things.
1812 * "ermsg" is to be passed without translation, use N_() instead of _().
1813 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001814 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001815emsg_funcname(char *ermsg, char_u *name)
1816{
Bram Moolenaar54598062022-01-13 12:05:09 +00001817 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818
Bram Moolenaar54598062022-01-13 12:05:09 +00001819 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001821 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 if (p != name)
1823 vim_free(p);
1824}
1825
1826/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001827 * Get function arguments at "*arg" and advance it.
1828 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001829 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830 */
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001831 int
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001832get_func_arguments(
1833 char_u **arg,
1834 evalarg_T *evalarg,
1835 int partial_argc,
1836 typval_T *argvars,
1837 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001839 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001840 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001841 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001842 int evaluate = evalarg == NULL
1843 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001844
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001845 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001846 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001847 // skip the '(' or ',' and possibly line breaks
1848 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1849
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 if (*argp == ')' || *argp == ',' || *argp == NUL)
1851 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001852 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 {
1854 ret = FAIL;
1855 break;
1856 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001857 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001858 // The comma should come right after the argument, but this wasn't
1859 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001860 if (vim9script)
1861 {
1862 if (*argp != ',' && *skipwhite(argp) == ',')
1863 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001864 if (evaluate)
1865 semsg(_(e_no_white_space_allowed_before_str_str),
1866 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001867 ret = FAIL;
1868 break;
1869 }
1870 }
1871 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001872 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 if (*argp != ',')
1874 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001875 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1876 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001877 if (evaluate)
1878 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001879 ret = FAIL;
1880 break;
1881 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001882 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001883
Bram Moolenaare6b53242020-07-01 17:28:33 +02001884 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885 if (*argp == ')')
1886 ++argp;
1887 else
1888 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001889 *arg = argp;
1890 return ret;
1891}
1892
1893/*
1894 * Call a function and put the result in "rettv".
1895 * Return OK or FAIL.
1896 */
1897 int
1898get_func_tv(
1899 char_u *name, // name of the function
1900 int len, // length of "name" or -1 to use strlen()
1901 typval_T *rettv,
1902 char_u **arg, // argument, pointing to the '('
1903 evalarg_T *evalarg, // for line continuation
1904 funcexe_T *funcexe) // various values
1905{
1906 char_u *argp;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001907 int ret;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001908 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1909 int argcount = 0; // number of arguments found
1910 int vim9script = in_vim9script();
1911 int evaluate = evalarg == NULL
1912 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1913
1914 argp = *arg;
1915 ret = get_func_arguments(&argp, evalarg,
1916 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1917 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918
1919 if (ret == OK)
1920 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001921 int i = 0;
1922 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001923
1924 if (get_vim_var_nr(VV_TESTING))
1925 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001926 // Prepare for calling test_garbagecollect_now(), need to know
1927 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001928 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001929 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001930 for (i = 0; i < argcount; ++i)
1931 if (ga_grow(&funcargs, 1) == OK)
1932 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1933 &argvars[i];
1934 }
1935
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001936 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001937 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001938 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001939 // An error in a builtin function does not return FAIL, but we do
1940 // want to abort further processing if an error was given.
1941 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001942 clear_tv(rettv);
1943 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001944
1945 funcargs.ga_len -= i;
1946 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001947 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001948 {
1949 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001950 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001951 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001952 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001953 }
1954
1955 while (--argcount >= 0)
1956 clear_tv(&argvars[argcount]);
1957
Bram Moolenaar4525a572022-02-13 11:57:33 +00001958 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001959 *arg = argp;
1960 else
1961 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001962 return ret;
1963}
1964
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965/*
1966 * Return TRUE if "p" starts with "<SID>" or "s:".
1967 * Only works if eval_fname_script() returned non-zero for "p"!
1968 */
1969 static int
1970eval_fname_sid(char_u *p)
1971{
1972 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1973}
1974
1975/*
1976 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1977 * Change <SNR>123_name() to K_SNR 123_name().
1978 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001979 * and set "tofree".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001980 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001981 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001982fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1983{
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;
2313 for (hi = fc->fc_l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
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));
2436 if (!HASHITEM_EMPTY(hi))
2437 {
2438 // When there is a def-function index do not actually remove the
2439 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002440 // Do remove it when it's a copy.
2441 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002442 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002443 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002444 return FALSE;
2445 }
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002446 hash_remove(&func_hashtab, hi, "remove function");
Bram Moolenaarc970e422021-03-17 15:03:04 +01002447 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002448 return TRUE;
2449 }
2450 return FALSE;
2451}
2452
2453 static void
2454func_clear_items(ufunc_T *fp)
2455{
2456 ga_clear_strings(&(fp->uf_args));
2457 ga_clear_strings(&(fp->uf_def_args));
2458 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002459 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002460 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002461 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002462 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002463
2464 // Increment the refcount of this function to avoid it being freed
2465 // recursively when the partial is freed.
2466 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002467 partial_unref(fp->uf_partial);
2468 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002469 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002470
2471#ifdef FEAT_LUA
2472 if (fp->uf_cb_free != NULL)
2473 {
2474 fp->uf_cb_free(fp->uf_cb_state);
2475 fp->uf_cb_free = NULL;
2476 }
2477
2478 fp->uf_cb_state = NULL;
2479 fp->uf_cb = NULL;
2480#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002481#ifdef FEAT_PROFILE
2482 VIM_CLEAR(fp->uf_tml_count);
2483 VIM_CLEAR(fp->uf_tml_total);
2484 VIM_CLEAR(fp->uf_tml_self);
2485#endif
2486}
2487
2488/*
2489 * Free all things that a function contains. Does not free the function
2490 * itself, use func_free() for that.
2491 * When "force" is TRUE we are exiting.
2492 */
2493 static void
2494func_clear(ufunc_T *fp, int force)
2495{
2496 if (fp->uf_cleared)
2497 return;
2498 fp->uf_cleared = TRUE;
2499
2500 // clear this function
2501 func_clear_items(fp);
2502 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002503 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002504}
2505
2506/*
2507 * Free a function and remove it from the list of functions. Does not free
2508 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002509 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002510 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002511 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002512 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002513func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002514{
2515 // Only remove it when not done already, otherwise we would remove a newer
2516 // version of the function with the same name.
2517 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2518 func_remove(fp);
2519
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002520 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002521 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002522 if (fp->uf_dfunc_idx > 0)
2523 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002524 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002525 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002526 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002527 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002528 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002529}
2530
2531/*
2532 * Free all things that a function contains and free the function itself.
2533 * When "force" is TRUE we are exiting.
2534 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002535 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002536func_clear_free(ufunc_T *fp, int force)
2537{
2538 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002539 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2540 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002541 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002542 else
2543 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002544}
2545
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002546/*
2547 * Copy already defined function "lambda" to a new function with name "global".
2548 * This is for when a compiled function defines a global function.
2549 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002550 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002551copy_lambda_to_global_func(
Bram Moolenaarcc341812022-09-19 15:54:34 +01002552 char_u *lambda,
2553 char_u *global,
2554 loopvarinfo_T *loopvarinfo,
2555 ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002556{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002557 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002558 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002559
2560 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002561 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002562 semsg(_(e_lambda_function_not_found_str), lambda);
2563 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002564 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002565
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002566 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002567 if (fp != NULL)
2568 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002569 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002570 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002571 return FAIL;
2572 }
2573
Bram Moolenaare01e5212023-01-08 20:31:18 +00002574 fp = alloc_ufunc(global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002575 if (fp == NULL)
2576 return FAIL;
2577
2578 fp->uf_varargs = ufunc->uf_varargs;
2579 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2580 fp->uf_def_status = ufunc->uf_def_status;
2581 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2582 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2583 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2584 == FAIL
2585 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2586 goto failed;
2587
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002588 if (ufunc->uf_arg_types != NULL)
2589 {
2590 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2591 if (fp->uf_arg_types == NULL)
2592 goto failed;
2593 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2594 sizeof(type_T *) * fp->uf_args.ga_len);
2595 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002596 if (ufunc->uf_va_name != NULL)
2597 {
2598 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2599 if (fp->uf_va_name == NULL)
2600 goto failed;
2601 }
2602 fp->uf_ret_type = ufunc->uf_ret_type;
2603
2604 fp->uf_refcount = 1;
Bram Moolenaarc8ab30a2023-01-09 11:35:47 +00002605
2606 fp->uf_name_exp = NULL;
2607 set_ufunc_name(fp, global);
2608
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002609 hash_add(&func_hashtab, UF2HIKEY(fp), "copy lambda");
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002610
2611 // the referenced dfunc_T is now used one more time
2612 link_def_function(fp);
2613
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002614 // Create a partial to store the context of the function where it was
2615 // instantiated. Only needs to be done once. Do this on the original
2616 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002617 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2618 {
2619 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2620
2621 if (pt == NULL)
2622 goto failed;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002623 if (fill_partial_and_closure(pt, ufunc, loopvarinfo, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002624 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002625 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002626 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002627 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002628 ufunc->uf_partial = pt;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002629 }
2630
2631 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002632
2633failed:
2634 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002635 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002636}
2637
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002638static int funcdepth = 0;
2639
2640/*
2641 * Increment the function call depth count.
2642 * Return FAIL when going over 'maxfuncdepth'.
2643 * Otherwise return OK, must call funcdepth_decrement() later!
2644 */
2645 int
2646funcdepth_increment(void)
2647{
2648 if (funcdepth >= p_mfd)
2649 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002650 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002651 return FAIL;
2652 }
2653 ++funcdepth;
2654 return OK;
2655}
2656
2657 void
2658funcdepth_decrement(void)
2659{
2660 --funcdepth;
2661}
2662
2663/*
2664 * Get the current function call depth.
2665 */
2666 int
2667funcdepth_get(void)
2668{
2669 return funcdepth;
2670}
2671
2672/*
2673 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002674 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002675 * times as funcdepth_increment().
2676 */
2677 void
2678funcdepth_restore(int depth)
2679{
2680 funcdepth = depth;
2681}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002682
2683/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002684 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2685 * "rettv".
2686 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2687 * Returns NULL when allocation fails.
2688 */
2689 funccall_T *
2690create_funccal(ufunc_T *fp, typval_T *rettv)
2691{
2692 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2693
2694 if (fc == NULL)
2695 return NULL;
2696 fc->fc_caller = current_funccal;
2697 current_funccal = fc;
2698 fc->fc_func = fp;
2699 func_ptr_ref(fp);
2700 fc->fc_rettv = rettv;
2701 return fc;
2702}
2703
2704/*
2705 * To be called when returning from a compiled function; restores
2706 * current_funccal.
2707 */
2708 void
2709remove_funccal()
2710{
2711 funccall_T *fc = current_funccal;
2712
2713 current_funccal = fc->fc_caller;
2714 free_funccal(fc);
2715}
2716
2717/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 * Call a user function.
2719 */
2720 static void
2721call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002722 ufunc_T *fp, // pointer to function
2723 int argcount, // nr of args
2724 typval_T *argvars, // arguments
2725 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002726 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002727 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002729 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002730 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002731 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002732 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 funccall_T *fc;
2734 int save_did_emsg;
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
Bram Moolenaare31ee862020-01-07 20:59:34 +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;
2759 return;
2760 }
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)
2766 return;
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 Moolenaarffdaca92022-12-09 21:41:48 +00002785 call_def_function(fp, argcount, argvars, 0,
2786 funcexe->fe_partial, funcexe->fe_object, fc, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002787 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002788#ifdef FEAT_PROFILE
2789 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002790 || (caller != NULL && caller->uf_profiling)))
2791 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002792#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002793 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002794 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002795 return;
2796 }
2797
Bram Moolenaar38453522021-11-28 22:00:12 +00002798 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799
2800 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002801 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2802 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2803 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 */
2805 /*
2806 * Init l: variables.
2807 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002808 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 if (selfdict != NULL)
2810 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002811 // Set l:self to "selfdict". Use "name" to avoid a warning from
2812 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002813 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 name = v->di_key;
2815 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002816 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002817 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v), "set self dictionary");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 v->di_tv.v_type = VAR_DICT;
2819 v->di_tv.v_lock = 0;
2820 v->di_tv.vval.v_dict = selfdict;
2821 ++selfdict->dv_refcount;
2822 }
2823
2824 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002825 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002826 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 * Set a:000 to a list with room for the "..." arguments.
2828 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002829 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002830 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002831 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002832 (varnumber_T)(argcount >= fp->uf_args.ga_len
2833 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002834 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002835 if ((fp->uf_flags & FC_NOARGS) == 0)
2836 {
2837 // Use "name" to avoid a warning from some compiler that checks the
2838 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002839 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002840 name = v->di_key;
2841 STRCPY(name, "000");
2842 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002843 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v), "function argument");
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002844 v->di_tv.v_type = VAR_LIST;
2845 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002846 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002847 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002848 CLEAR_FIELD(fc->fc_l_varlist);
2849 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2850 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002851
2852 /*
2853 * Set a:firstline to "firstline" and a:lastline to "lastline".
2854 * Set a:name to named arguments.
2855 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002856 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002858 if ((fp->uf_flags & FC_NOARGS) == 0)
2859 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002860 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2861 "firstline", (varnumber_T)funcexe->fe_firstline);
2862 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2863 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002864 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002865 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 {
2867 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002868 typval_T def_rettv;
2869 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870
2871 ai = i - fp->uf_args.ga_len;
2872 if (ai < 0)
2873 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002874 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 name = FUNCARG(fp, i);
2876 if (islambda)
2877 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002878
2879 // evaluate named argument default expression
2880 isdefault = ai + fp->uf_def_args.ga_len >= 0
2881 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2882 && argvars[i].vval.v_number == VVAL_NONE));
2883 if (isdefault)
2884 {
2885 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002886
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002887 def_rettv.v_type = VAR_NUMBER;
2888 def_rettv.vval.v_number = -1;
2889
2890 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2891 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002892 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002893 {
2894 default_arg_err = 1;
2895 break;
2896 }
2897 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 }
2899 else
2900 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002901 if ((fp->uf_flags & FC_NOARGS) != 0)
2902 // Bail out if no a: arguments used (in lambda).
2903 break;
2904
Bram Moolenaare38eab22019-12-05 21:50:01 +01002905 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 sprintf((char *)numbuf, "%d", ai + 1);
2907 name = numbuf;
2908 }
2909 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2910 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002911 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002913 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002914 }
2915 else
2916 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002917 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918 if (v == NULL)
2919 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002920 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002921 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002922
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002923 // Note: the values are copied directly to avoid alloc/free.
2924 // "argvars" must have VAR_FIXED for v_lock.
2925 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002926 v->di_tv.v_lock = VAR_FIXED;
2927
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002928 if (isdefault)
2929 // Need to free this later, no matter where it's stored.
2930 tv_to_free[tv_to_free_len++] = &v->di_tv;
2931
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932 if (addlocal)
2933 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002934 // Named arguments should be accessed without the "a:" prefix in
2935 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002936 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002937 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v), "local variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002938 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002939 else
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002940 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v), "add variable");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941
2942 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2943 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002944 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002945
2946 li->li_tv = argvars[i];
2947 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002948 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949 }
2950 }
2951
Bram Moolenaare38eab22019-12-05 21:50:01 +01002952 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002953 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002954
2955 if (fp->uf_flags & FC_SANDBOX)
2956 {
2957 using_sandbox = TRUE;
2958 ++sandbox;
2959 }
2960
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002961 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002962 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002963 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002964 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002965 ++no_wait_return;
2966 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002968 smsg(_("calling %s"), SOURCING_NAME);
2969 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002971 char_u buf[MSG_BUF_LEN];
2972 char_u numbuf2[NUMBUFLEN];
2973 char_u *tofree;
2974 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002975
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002976 msg_puts("(");
2977 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002979 if (i > 0)
2980 msg_puts(", ");
2981 if (argvars[i].v_type == VAR_NUMBER)
2982 msg_outnum((long)argvars[i].vval.v_number);
2983 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002984 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002985 // Do not want errors such as E724 here.
2986 ++emsg_off;
2987 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2988 --emsg_off;
2989 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002990 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002991 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002993 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2994 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002996 msg_puts((char *)s);
2997 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998 }
2999 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003001 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003003 msg_puts("\n"); // don't overwrite this either
3004
3005 verbose_leave_scroll();
3006 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 }
3008#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01003009 if (do_profiling == PROF_YES)
3010 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01003011 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012#endif
3013
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003014 // "legacy" does not apply to commands in the function
3015 sticky_cmdmod_flags = 0;
3016
Bram Moolenaar98aff652022-09-06 21:02:35 +01003017 // If called from a compiled :def function the execution context must be
3018 // hidden, any deferred functions need to be added to the function being
3019 // executed here.
dundargocc57b5bc2022-11-02 13:30:51 +00003020 save_current_ectx = clear_current_ectx();
Bram Moolenaar98aff652022-09-06 21:02:35 +01003021
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003022 save_current_sctx = current_sctx;
3023 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003024 save_did_emsg = did_emsg;
3025 did_emsg = FALSE;
3026
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003027 if (default_arg_err && (fp->uf_flags & FC_ABORT))
3028 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003029 else if (islambda)
3030 {
3031 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
3032
3033 // A Lambda always has the command "return {expr}". It is much faster
3034 // to evaluate {expr} directly.
3035 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003036 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003037 --ex_nesting_level;
3038 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003039 else
3040 // call do_cmdline() to execute the lines
3041 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003042 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
3043
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003044 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01003045 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003046
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 --RedrawingDisabled;
3048
Bram Moolenaare38eab22019-12-05 21:50:01 +01003049 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003050 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
3051 {
3052 clear_tv(rettv);
3053 rettv->v_type = VAR_NUMBER;
3054 rettv->vval.v_number = -1;
3055 }
3056
3057#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01003058 if (do_profiling == PROF_YES)
3059 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003060 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01003061
3062 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
3063 profile_may_end_func(&profile_info, fp, caller);
3064 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003065#endif
3066
Bram Moolenaare38eab22019-12-05 21:50:01 +01003067 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 if (p_verbose >= 12)
3069 {
3070 ++no_wait_return;
3071 verbose_enter_scroll();
3072
3073 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003074 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaarca16c602022-09-06 18:57:08 +01003075 else if (fc->fc_rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003076 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaarca16c602022-09-06 18:57:08 +01003077 (long)fc->fc_rettv->vval.v_number);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003078 else
3079 {
3080 char_u buf[MSG_BUF_LEN];
3081 char_u numbuf2[NUMBUFLEN];
3082 char_u *tofree;
3083 char_u *s;
3084
Bram Moolenaare38eab22019-12-05 21:50:01 +01003085 // The value may be very long. Skip the middle part, so that we
3086 // have some idea how it starts and ends. smsg() would always
3087 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003088 ++emsg_off;
Bram Moolenaarca16c602022-09-06 18:57:08 +01003089 s = tv2string(fc->fc_rettv, &tofree, numbuf2, 0);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003090 --emsg_off;
3091 if (s != NULL)
3092 {
3093 if (vim_strsize(s) > MSG_BUF_CLEN)
3094 {
3095 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
3096 s = buf;
3097 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003098 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 vim_free(tofree);
3100 }
3101 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003102 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103
3104 verbose_leave_scroll();
3105 --no_wait_return;
3106 }
3107
Bram Moolenaare31ee862020-01-07 20:59:34 +01003108 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003109 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003110 current_sctx = save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01003111 restore_current_ectx(save_current_ectx);
3112
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113#ifdef FEAT_PROFILE
3114 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003115 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02003117 if (using_sandbox)
3118 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003119 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003121 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003122 {
3123 ++no_wait_return;
3124 verbose_enter_scroll();
3125
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003126 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003127 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128
3129 verbose_leave_scroll();
3130 --no_wait_return;
3131 }
3132
3133 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01003134 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02003135 for (i = 0; i < tv_to_free_len; ++i)
3136 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003137 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138}
3139
3140/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003141 * Check the argument count for user function "fp".
3142 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3143 */
3144 int
3145check_user_func_argcount(ufunc_T *fp, int argcount)
3146{
3147 int regular_args = fp->uf_args.ga_len;
3148
3149 if (argcount < regular_args - fp->uf_def_args.ga_len)
3150 return FCERR_TOOFEW;
3151 else if (!has_varargs(fp) && argcount > regular_args)
3152 return FCERR_TOOMANY;
3153 return FCERR_UNKNOWN;
3154}
3155
3156/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003157 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003158 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003159 int
3160call_user_func_check(
3161 ufunc_T *fp,
3162 int argcount,
3163 typval_T *argvars,
3164 typval_T *rettv,
3165 funcexe_T *funcexe,
3166 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003167{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003168 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003169
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003170#ifdef FEAT_LUA
3171 if (fp->uf_flags & FC_CFUNC)
3172 {
3173 cfunc_T cb = fp->uf_cb;
3174
3175 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3176 }
3177#endif
3178
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003179 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3180 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003181 error = check_user_func_argcount(fp, argcount);
3182 if (error != FCERR_UNKNOWN)
3183 return error;
3184 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003185 error = FCERR_DICT;
3186 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003187 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003188 int did_save_redo = FALSE;
3189 save_redo_T save_redo;
3190
3191 /*
3192 * Call the user function.
3193 * Save and restore search patterns, script variables and
3194 * redo buffer.
3195 */
3196 save_search_patterns();
3197 if (!ins_compl_active())
3198 {
3199 saveRedobuff(&save_redo);
3200 did_save_redo = TRUE;
3201 }
3202 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003203 call_user_func(fp, argcount, argvars, rettv, funcexe,
3204 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003205 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3206 // Function was unreferenced while being used, free it now.
3207 func_clear_free(fp, FALSE);
3208 if (did_save_redo)
3209 restoreRedobuff(&save_redo);
3210 restore_search_patterns();
3211 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003212 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003213 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003214}
3215
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003216static funccal_entry_T *funccal_stack = NULL;
3217
3218/*
3219 * Save the current function call pointer, and set it to NULL.
3220 * Used when executing autocommands and for ":source".
3221 */
3222 void
3223save_funccal(funccal_entry_T *entry)
3224{
3225 entry->top_funccal = current_funccal;
3226 entry->next = funccal_stack;
3227 funccal_stack = entry;
3228 current_funccal = NULL;
3229}
3230
3231 void
3232restore_funccal(void)
3233{
3234 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003235 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003236 else
3237 {
3238 current_funccal = funccal_stack->top_funccal;
3239 funccal_stack = funccal_stack->next;
3240 }
3241}
3242
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003243 funccall_T *
3244get_current_funccal(void)
3245{
3246 return current_funccal;
3247}
3248
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003249/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003250 * Return TRUE when currently at the script level:
3251 * - not in a function
3252 * - not executing an autocommand
3253 * Note that when an autocommand sources a script the result is FALSE;
3254 */
3255 int
3256at_script_level(void)
3257{
3258 return current_funccal == NULL && autocmd_match == NULL;
3259}
3260
3261/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003262 * Mark all functions of script "sid" as deleted.
3263 */
3264 void
3265delete_script_functions(int sid)
3266{
3267 hashitem_T *hi;
3268 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003269 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003270 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003271 size_t len;
3272
3273 buf[0] = K_SPECIAL;
3274 buf[1] = KS_EXTRA;
3275 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003276 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003277 len = STRLEN(buf);
3278
Bram Moolenaarce658352020-07-31 23:47:12 +02003279 while (todo > 0)
3280 {
3281 todo = func_hashtab.ht_used;
3282 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3283 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003284 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003285 fp = HI2UF(hi);
3286 if (STRNCMP(fp->uf_name, buf, len) == 0)
3287 {
3288 int changed = func_hashtab.ht_changed;
3289
3290 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003291
3292 if (fp->uf_calls > 0)
3293 {
3294 // Function is executing, don't free it but do remove
3295 // it from the hashtable.
3296 if (func_remove(fp))
3297 fp->uf_refcount--;
3298 }
3299 else
3300 {
3301 func_clear(fp, TRUE);
3302 // When clearing a function another function can be
3303 // cleared as a side effect. When that happens start
3304 // over.
3305 if (changed != func_hashtab.ht_changed)
3306 break;
3307 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003308 }
3309 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003310 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003311 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003312}
3313
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003314#if defined(EXITFREE) || defined(PROTO)
3315 void
3316free_all_functions(void)
3317{
3318 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003319 ufunc_T *fp;
3320 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003321 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003322 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323
Bram Moolenaare38eab22019-12-05 21:50:01 +01003324 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003325 while (current_funccal != NULL)
3326 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003327 clear_tv(current_funccal->fc_rettv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003328 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003329 if (current_funccal == NULL && funccal_stack != NULL)
3330 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003331 }
3332
Bram Moolenaare38eab22019-12-05 21:50:01 +01003333 // First clear what the functions contain. Since this may lower the
3334 // reference count of a function, it may also free a function and change
3335 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003336 while (todo > 0)
3337 {
3338 todo = func_hashtab.ht_used;
3339 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3340 if (!HASHITEM_EMPTY(hi))
3341 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003342 // clear the def function index now
3343 fp = HI2UF(hi);
3344 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003345 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003346
Bram Moolenaare38eab22019-12-05 21:50:01 +01003347 // Only free functions that are not refcounted, those are
3348 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003349 if (func_name_refcount(fp->uf_name))
3350 ++skipped;
3351 else
3352 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003353 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003354 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003355 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003356 {
3357 skipped = 0;
3358 break;
3359 }
3360 }
3361 --todo;
3362 }
3363 }
3364
Bram Moolenaare38eab22019-12-05 21:50:01 +01003365 // Now actually free the functions. Need to start all over every time,
3366 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003367 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003368 while (func_hashtab.ht_used > skipped)
3369 {
3370 todo = func_hashtab.ht_used;
3371 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 if (!HASHITEM_EMPTY(hi))
3373 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003374 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003375 // Only free functions that are not refcounted, those are
3376 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003377 fp = HI2UF(hi);
3378 if (func_name_refcount(fp->uf_name))
3379 ++skipped;
3380 else
3381 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003382 if (func_free(fp, FALSE) == OK)
3383 {
3384 skipped = 0;
3385 break;
3386 }
3387 // did not actually free it
3388 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003389 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003391 }
3392 if (skipped == 0)
3393 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003394
3395 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396}
3397#endif
3398
3399/*
3400 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003401 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3402 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 * "len" is the length of "name", or -1 for NUL terminated.
3404 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003405 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003406builtin_function(char_u *name, int len)
3407{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003408 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409
Bram Moolenaara26b9702020-04-18 19:53:28 +02003410 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003412 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3413 {
3414 if (name[i] == AUTOLOAD_CHAR)
3415 return FALSE;
3416 if (!eval_isnamec(name[i]))
3417 {
3418 // "name.something" is not a builtin function
3419 if (name[i] == '.')
3420 return FALSE;
3421 break;
3422 }
3423 }
3424 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425}
3426
3427 int
3428func_call(
3429 char_u *name,
3430 typval_T *args,
3431 partial_T *partial,
3432 dict_T *selfdict,
3433 typval_T *rettv)
3434{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003435 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 listitem_T *item;
3437 typval_T argv[MAX_FUNC_ARGS + 1];
3438 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 int r = 0;
3440
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003441 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003442 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 {
3444 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3445 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003446 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 break;
3448 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003449 // Make a copy of each argument. This is needed to be able to set
3450 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003451 copy_tv(&item->li_tv, &argv[argc++]);
3452 }
3453
3454 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003455 {
3456 funcexe_T funcexe;
3457
Bram Moolenaara80faa82020-04-12 19:37:17 +02003458 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003459 funcexe.fe_firstline = curwin->w_cursor.lnum;
3460 funcexe.fe_lastline = curwin->w_cursor.lnum;
3461 funcexe.fe_evaluate = TRUE;
3462 funcexe.fe_partial = partial;
3463 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003464 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3465 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466
Bram Moolenaare38eab22019-12-05 21:50:01 +01003467 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003468 while (argc > 0)
3469 clear_tv(&argv[--argc]);
3470
3471 return r;
3472}
3473
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003474static int callback_depth = 0;
3475
3476 int
3477get_callback_depth(void)
3478{
3479 return callback_depth;
3480}
3481
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003483 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003484 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003485 */
3486 int
3487call_callback(
3488 callback_T *callback,
3489 int len, // length of "name" or -1 to use strlen()
3490 typval_T *rettv, // return value goes here
3491 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003492 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003493 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003494{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003495 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003496 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003497
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003498 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3499 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003500 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003501 funcexe.fe_evaluate = TRUE;
3502 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003503 ++callback_depth;
3504 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3505 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003506
3507 // When a :def function was called that uses :try an error would be turned
3508 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003509 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003510 {
3511 need_rethrow = FALSE;
3512 handle_did_throw();
3513 }
3514
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003515 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003516}
3517
3518/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003519 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003520 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003521 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3522 */
3523 varnumber_T
3524call_callback_retnr(
3525 callback_T *callback,
3526 int argcount, // number of "argvars"
3527 typval_T *argvars) // vars for arguments, must have "argcount"
3528 // PLUS ONE elements!
3529{
3530 typval_T rettv;
3531 varnumber_T retval;
3532
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003533 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003534 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003535
3536 retval = tv_get_number_chk(&rettv, NULL);
3537 clear_tv(&rettv);
3538 return retval;
3539}
3540
3541/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003542 * Give an error message for the result of a function.
3543 * Nothing if "error" is FCERR_NONE.
3544 */
3545 void
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003546user_func_error(int error, char_u *name, int found_var)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003547{
3548 switch (error)
3549 {
3550 case FCERR_UNKNOWN:
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003551 if (found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003552 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003553 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003554 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003555 break;
3556 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003557 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003558 break;
3559 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003560 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003561 break;
3562 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003563 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003564 break;
3565 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003566 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003567 break;
3568 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003569 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003570 break;
3571 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003572 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3573 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003574 break;
3575 }
3576}
3577
3578/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003580 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 * Return FAIL when the function can't be called, OK otherwise.
3582 * Also returns OK when an error was encountered while executing the function.
3583 */
3584 int
3585call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003586 char_u *funcname, // name of the function
3587 int len, // length of "name" or -1 to use strlen()
3588 typval_T *rettv, // return value goes here
3589 int argcount_in, // number of "argvars"
3590 typval_T *argvars_in, // vars for arguments, must have "argcount"
3591 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003592 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003593{
3594 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003595 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003597 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 char_u fname_buf[FLEN_FIXED + 1];
3599 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003600 char_u *fname = NULL;
3601 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 int argcount = argcount_in;
3603 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003604 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003605 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003606 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003608 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003609 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003610 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003611 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003612
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003613 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3614 // even when call_func() returns FAIL.
3615 rettv->v_type = VAR_UNKNOWN;
3616
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003617 if (partial != NULL)
3618 fp = partial->pt_func;
3619 if (fp == NULL)
3620 {
3621 // Make a copy of the name, if it comes from a funcref variable it
3622 // could be changed or deleted in the called function.
3623 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3624 if (name == NULL)
3625 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003626
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003627 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3628 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003630 if (funcexe->fe_doesrange != NULL)
3631 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003632
3633 if (partial != NULL)
3634 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003635 // When the function has a partial with a dict and there is a dict
3636 // argument, use the dict argument. That is backwards compatible.
3637 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003638 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003640 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 {
3642 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003643 {
3644 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3645 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003646 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003647 goto theend;
3648 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003650 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 for (i = 0; i < argcount_in; ++i)
3652 argv[i + argv_clear] = argvars_in[i];
3653 argvars = argv;
3654 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003655
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003656 if (funcexe->fe_check_type != NULL
3657 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003658 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003659 // Now funcexe->fe_check_type is missing the added arguments,
3660 // make a copy of the type with the correction.
3661 check_type = *funcexe->fe_check_type;
3662 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003663 check_type.tt_args = check_type_args;
3664 CLEAR_FIELD(check_type_args);
3665 for (i = 0; i < check_type.tt_argcount; ++i)
3666 check_type_args[i + partial->pt_argc] =
3667 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003668 check_type.tt_argcount += partial->pt_argc;
3669 check_type.tt_min_argcount += partial->pt_argc;
3670 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 }
3672 }
3673
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003674 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3675 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003676 {
3677 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003678 if (check_argument_types(funcexe->fe_check_type,
3679 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003680 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003681 error = FCERR_OTHER;
3682 }
3683
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003684 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 {
3686 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003687 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688
Bram Moolenaar333894b2020-08-01 18:53:07 +02003689 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003690 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003691 {
3692 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003694 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695
Bram Moolenaare38eab22019-12-05 21:50:01 +01003696 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003698 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003700 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 {
3702 /*
3703 * User defined function.
3704 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003705 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003706 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003707 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003708 if (fp != NULL && !is_global && in_vim9script()
3709 && func_requires_g_prefix(fp))
3710 // In Vim9 script g: is required to find a global
3711 // non-autoload function.
3712 fp = NULL;
3713 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003714
Bram Moolenaare38eab22019-12-05 21:50:01 +01003715 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003716 if (fp == NULL
3717 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003718 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719 && !aborting())
3720 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003721 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003722 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003724 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3726 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003727 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003728 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003730 if (fp == NULL)
3731 {
3732 char_u *p = untrans_function_name(rfname);
3733
3734 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003735 // Don't do this if the name starts with "s:".
3736 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003737 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003738 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003740 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003741 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003742 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003744 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003745 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003746 argcount = funcexe->fe_argv_func(argcount, argvars,
zeertzjq48db5da2022-09-16 12:10:03 +01003747 argv_clear, fp);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003748
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003749 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003750 {
3751 // Method call: base->Method()
3752 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003753 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003754 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003755 argvars = argv;
3756 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003757 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003758
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003759 error = call_user_func_check(fp, argcount, argvars, rettv,
3760 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 }
3762 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003763 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003764 {
3765 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003766 * expr->method(): Find the method name in the table, call its
3767 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003768 */
3769 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003770 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003771 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 else
3773 {
3774 /*
3775 * Find the function name in the table, call its implementation.
3776 */
3777 error = call_internal_func(fname, argcount, argvars, rettv);
3778 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003779
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 /*
3781 * The function call (or "FuncUndefined" autocommand sequence) might
3782 * have been aborted by an error, an interrupt, or an explicitly thrown
3783 * exception that has not been caught so far. This situation can be
3784 * tested for by calling aborting(). For an error in an internal
3785 * function or for the "E132" error in call_user_func(), however, the
3786 * throw point at which the "force_abort" flag (temporarily reset by
3787 * emsg()) is normally updated has not been reached yet. We need to
3788 * update that flag first to make aborting() reliable.
3789 */
3790 update_force_abort();
3791 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003792 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 ret = OK;
3794
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003795theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 /*
3797 * Report an error unless the argument evaluation or function call has been
3798 * cancelled due to an aborting error, an interrupt, or an exception.
3799 */
3800 if (!aborting())
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003801 user_func_error(error, (name != NULL) ? name : funcname,
3802 funcexe->fe_found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003804 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003806 clear_tv(&argv[--argv_clear + argv_base]);
3807
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 vim_free(tofree);
3809 vim_free(name);
3810
3811 return ret;
3812}
3813
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003814/*
3815 * Call a function without arguments, partial or dict.
3816 * This is like call_func() when the call is only "FuncName()".
3817 * To be used by "expr" options.
3818 * Returns NOTDONE when the function could not be found.
3819 */
3820 int
3821call_simple_func(
3822 char_u *funcname, // name of the function
3823 int len, // length of "name" or -1 to use strlen()
3824 typval_T *rettv) // return value goes here
3825{
3826 int ret = FAIL;
3827 int error = FCERR_NONE;
3828 char_u fname_buf[FLEN_FIXED + 1];
3829 char_u *tofree = NULL;
3830 char_u *name;
3831 char_u *fname;
3832 char_u *rfname;
3833 int is_global = FALSE;
3834 ufunc_T *fp;
3835
3836 rettv->v_type = VAR_NUMBER; // default rettv is number zero
3837 rettv->vval.v_number = 0;
3838
3839 // Make a copy of the name, an option can be changed in the function.
3840 name = vim_strnsave(funcname, len);
3841 if (name == NULL)
3842 return ret;
3843
3844 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3845
3846 // Skip "g:" before a function name.
3847 if (fname[0] == 'g' && fname[1] == ':')
3848 {
3849 is_global = TRUE;
3850 rfname = fname + 2;
3851 }
3852 else
3853 rfname = fname;
3854 fp = find_func(rfname, is_global);
3855 if (fp != NULL && !is_global && in_vim9script()
3856 && func_requires_g_prefix(fp))
3857 // In Vim9 script g: is required to find a global non-autoload
3858 // function.
3859 fp = NULL;
3860 if (fp == NULL)
3861 ret = NOTDONE;
3862 else if (fp != NULL && (fp->uf_flags & FC_DELETED))
3863 error = FCERR_DELETED;
3864 else if (fp != NULL)
3865 {
3866 typval_T argvars[1];
3867 funcexe_T funcexe;
3868
3869 argvars[0].v_type = VAR_UNKNOWN;
3870 CLEAR_FIELD(funcexe);
3871 funcexe.fe_evaluate = TRUE;
3872
3873 error = call_user_func_check(fp, 0, argvars, rettv, &funcexe, NULL);
3874 if (error == FCERR_NONE)
3875 ret = OK;
3876 }
3877
3878 user_func_error(error, name, FALSE);
3879 vim_free(tofree);
3880 vim_free(name);
3881
3882 return ret;
3883}
3884
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003885 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003886printable_func_name(ufunc_T *fp)
3887{
3888 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3889}
3890
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003891/*
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003892 * When "prev_ht_changed" does not equal "ht_changed" give an error and return
3893 * TRUE. Otherwise return FALSE.
3894 */
3895 static int
3896function_list_modified(int prev_ht_changed)
3897{
3898 if (prev_ht_changed != func_hashtab.ht_changed)
3899 {
3900 emsg(_(e_function_list_was_modified));
3901 return TRUE;
3902 }
3903 return FALSE;
3904}
3905
3906/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003907 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003908 */
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003909 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910list_func_head(ufunc_T *fp, int indent)
3911{
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003912 int prev_ht_changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913 int j;
3914
3915 msg_start();
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003916
3917 // a timer at the more prompt may have deleted the function
3918 if (function_list_modified(prev_ht_changed))
3919 return FAIL;
3920
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003921 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003922 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003923 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003924 msg_puts("def ");
3925 else
3926 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003927 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003928 msg_putchar('(');
3929 for (j = 0; j < fp->uf_args.ga_len; ++j)
3930 {
3931 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003932 msg_puts(", ");
3933 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003934 if (fp->uf_arg_types != NULL)
3935 {
3936 char *tofree;
3937
3938 msg_puts(": ");
3939 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3940 vim_free(tofree);
3941 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003942 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3943 {
3944 msg_puts(" = ");
3945 msg_puts(((char **)(fp->uf_def_args.ga_data))
3946 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3947 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 }
3949 if (fp->uf_varargs)
3950 {
3951 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003952 msg_puts(", ");
3953 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003954 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003955 if (fp->uf_va_name != NULL)
3956 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003957 if (!fp->uf_varargs)
3958 {
3959 if (j)
3960 msg_puts(", ");
3961 msg_puts("...");
3962 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003963 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003964 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003965 {
3966 char *tofree;
3967
3968 msg_puts(": ");
3969 msg_puts(type_name(fp->uf_va_type, &tofree));
3970 vim_free(tofree);
3971 }
3972 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003974
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003975 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003976 {
3977 if (fp->uf_ret_type != &t_void)
3978 {
3979 char *tofree;
3980
3981 msg_puts(": ");
3982 msg_puts(type_name(fp->uf_ret_type, &tofree));
3983 vim_free(tofree);
3984 }
3985 }
3986 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003987 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003989 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003991 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003992 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003993 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 msg_clr_eos();
3995 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003996 last_set_msg(fp->uf_script_ctx);
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003997
3998 return OK;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999}
4000
4001/*
4002 * Get a function name, translating "<SID>" and "<SNR>".
4003 * Also handles a Funcref in a List or Dictionary.
4004 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004005 * Set "*is_global" to TRUE when the function must be global, unless
4006 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004007 * flags:
4008 * TFN_INT: internal function name OK
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004009 * TFN_IN_CLASS: function in a class
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 * TFN_QUIET: be quiet
4011 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004012 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004013 * Advances "pp" to just after the function name (if no error).
4014 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004015 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004016trans_function_name(
4017 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004018 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01004019 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01004021 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004022 partial_T **partial, // return: partial of a FuncRef
4023 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024{
4025 char_u *name = NULL;
4026 char_u *start;
4027 char_u *end;
4028 int lead;
4029 char_u sid_buf[20];
4030 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004031 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004032 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004034 int vim9script = in_vim9script();
4035 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036
4037 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02004038 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 start = *pp;
4040
Bram Moolenaare38eab22019-12-05 21:50:01 +01004041 // Check for hard coded <SNR>: already translated function ID (from a user
4042 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
4044 && (*pp)[2] == (int)KE_SNR)
4045 {
4046 *pp += 3;
4047 len = get_id_len(pp) + 3;
4048 return vim_strnsave(start, len);
4049 }
4050
Bram Moolenaare38eab22019-12-05 21:50:01 +01004051 // A name starting with "<SID>" or "<SNR>" is local to a script. But
4052 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 lead = eval_fname_script(start);
4054 if (lead > 2)
4055 start += lead;
4056
Bram Moolenaare38eab22019-12-05 21:50:01 +01004057 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01004058 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004060 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00004061 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 {
4063 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004064 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 goto theend;
4066 }
4067 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
4068 {
4069 /*
4070 * Report an invalid expression in braces, unless the expression
4071 * evaluation has been cancelled due to an aborting error, an
4072 * interrupt, or an exception.
4073 */
4074 if (!aborting())
4075 {
4076 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004077 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078 }
4079 else
4080 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
4081 goto theend;
4082 }
4083
4084 if (lv.ll_tv != NULL)
4085 {
4086 if (fdp != NULL)
4087 {
4088 fdp->fd_dict = lv.ll_dict;
4089 fdp->fd_newkey = lv.ll_newkey;
4090 lv.ll_newkey = NULL;
4091 fdp->fd_di = lv.ll_di;
4092 }
4093 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
4094 {
4095 name = vim_strsave(lv.ll_tv->vval.v_string);
4096 *pp = end;
4097 }
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004098 else if (lv.ll_tv->v_type == VAR_CLASS
4099 && lv.ll_tv->vval.v_class != NULL)
4100 {
4101 name = vim_strsave(lv.ll_tv->vval.v_class->class_name);
4102 *pp = end;
4103 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 else if (lv.ll_tv->v_type == VAR_PARTIAL
4105 && lv.ll_tv->vval.v_partial != NULL)
4106 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004107 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 *pp = end;
4109 if (partial != NULL)
4110 *partial = lv.ll_tv->vval.v_partial;
4111 }
4112 else
4113 {
4114 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
4115 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00004116 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004117 else
4118 *pp = end;
4119 name = NULL;
4120 }
4121 goto theend;
4122 }
4123
4124 if (lv.ll_name == NULL)
4125 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004126 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004127 *pp = end;
4128 goto theend;
4129 }
4130
Bram Moolenaare38eab22019-12-05 21:50:01 +01004131 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004132 if (lv.ll_exp_name != NULL)
4133 {
4134 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004135 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004136 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004137 if (name == lv.ll_exp_name)
4138 name = NULL;
4139 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004140 else if (lv.ll_sid > 0)
4141 {
4142 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
4143 int cc = *lv.ll_name_end;
4144
4145 // function in another script. Prefix <SNR>99_ or the autoload prefix.
4146 *lv.ll_name_end = NUL;
4147 if (si->sn_autoload_prefix != NULL)
4148 {
4149 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
4150 }
4151 else
4152 {
4153 sid_buf[0] = K_SPECIAL;
4154 sid_buf[1] = KS_EXTRA;
4155 sid_buf[2] = (int)KE_SNR;
4156 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00004157 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004158 name = concat_str(sid_buf, lv.ll_name);
4159 }
4160 *lv.ll_name_end = cc;
4161 *pp = end;
4162 goto theend;
4163 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004164 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 {
4166 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004167 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004168 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 if (name == *pp)
4170 name = NULL;
4171 }
4172 if (name != NULL)
4173 {
4174 name = vim_strsave(name);
4175 *pp = end;
4176 if (STRNCMP(name, "<SNR>", 5) == 0)
4177 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004178 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 name[0] = K_SPECIAL;
4180 name[1] = KS_EXTRA;
4181 name[2] = (int)KE_SNR;
4182 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
4183 }
4184 goto theend;
4185 }
4186
4187 if (lv.ll_exp_name != NULL)
4188 {
4189 len = (int)STRLEN(lv.ll_exp_name);
4190 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
4191 && STRNCMP(lv.ll_name, "s:", 2) == 0)
4192 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004193 // When there was "s:" already or the name expanded to get a
4194 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 lv.ll_name += 2;
4196 len -= 2;
4197 lead = 2;
4198 }
4199 }
4200 else
4201 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004202 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004204 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004205 if (lv.ll_name[0] == 'g')
4206 {
4207 if (is_global != NULL)
4208 {
4209 *is_global = TRUE;
4210 }
4211 else
4212 {
4213 // dropping "g:" without setting "is_global" won't work in
4214 // Vim9script, put it back later
4215 prefix_g = TRUE;
4216 extra = 2;
4217 }
4218 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004219 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004220 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 len = (int)(end - lv.ll_name);
4222 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004223 if (len <= 0)
4224 {
4225 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004226 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004227 goto theend;
4228 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004230 // In Vim9 script a user function is script-local by default, unless it
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004231 // starts with a lower case character: dict.func(). Or when in a class.
4232 vim9_local = ASCII_ISUPPER(*start) && vim9script
4233 && (flags & TFN_IN_CLASS) == 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004234
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235 /*
4236 * Copy the function name to allocated memory.
4237 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4238 * Accept <SNR>123_name() outside a script.
4239 */
4240 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004241 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004242 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004244 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004245 {
Kota Kato948a3892022-08-16 16:09:59 +01004246 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4247 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004248 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004249 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004250 goto theend;
4251 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004252 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004253 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004254 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004255 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256 || eval_fname_sid(*pp))
4257 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004258 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004259 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004261 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004262 goto theend;
4263 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004264 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004265 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004266 extra = 3 + (int)STRLEN(sid_buf);
4267 else
4268 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004269 }
4270 }
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004271 else if (!(flags & TFN_INT)
4272 && (builtin_function(lv.ll_name, len)
4273 || (vim9script && *lv.ll_name == '_'))
4274 && !((flags & TFN_IN_CLASS) && STRNCMP(lv.ll_name, "new", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004276 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004277 : e_function_name_must_start_with_capital_or_s_str),
4278 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279 goto theend;
4280 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004281 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 {
4283 char_u *cp = vim_strchr(lv.ll_name, ':');
4284
4285 if (cp != NULL && cp < end)
4286 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004287 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288 goto theend;
4289 }
4290 }
4291
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004292 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293 if (name != NULL)
4294 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004295 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296 {
4297 name[0] = K_SPECIAL;
4298 name[1] = KS_EXTRA;
4299 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004300 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 STRCPY(name + 3, sid_buf);
4302 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004303 else if (prefix_g)
4304 {
4305 name[0] = 'g';
4306 name[1] = ':';
4307 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004308 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4309 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 }
4311 *pp = end;
4312
4313theend:
4314 clear_lval(&lv);
4315 return name;
4316}
4317
4318/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004319 * Assuming "name" is the result of trans_function_name() and it was prefixed
4320 * to use the script-local name, return the unmodified name (points into
4321 * "name"). Otherwise return NULL.
4322 * This can be used to first search for a script-local function and fall back
4323 * to the global function if not found.
4324 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004325 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004326untrans_function_name(char_u *name)
4327{
4328 char_u *p;
4329
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004330 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004331 {
4332 p = vim_strchr(name, '_');
4333 if (p != NULL)
4334 return p + 1;
4335 }
4336 return NULL;
4337}
4338
4339/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004340 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4341 * current script ID and returns the expanded function name. The caller should
4342 * free the returned name. If not called from a script context or the function
4343 * name doesn't start with these prefixes, then returns NULL.
4344 * This doesn't check whether the script-local function exists or not.
4345 */
4346 char_u *
4347get_scriptlocal_funcname(char_u *funcname)
4348{
4349 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004350 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004351 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004352 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004353
4354 if (funcname == NULL)
4355 return NULL;
4356
4357 if (STRNCMP(funcname, "s:", 2) != 0
4358 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004359 {
4360 ufunc_T *ufunc;
4361
4362 // The function name does not have a script-local prefix. Try finding
4363 // it when in a Vim9 script and there is no "g:" prefix.
4364 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4365 return NULL;
4366 ufunc = find_func(funcname, FALSE);
4367 if (ufunc == NULL || func_is_global(ufunc)
4368 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4369 return NULL;
4370 ++p;
4371 off = 0;
4372 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004373 else
4374 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004375
4376 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4377 {
4378 emsg(_(e_using_sid_not_in_script_context));
4379 return NULL;
4380 }
4381 // Expand s: prefix into <SNR>nr_<name>
4382 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4383 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004384 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004385 if (newname == NULL)
4386 return NULL;
4387 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004388 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004389
4390 return newname;
4391}
4392
4393/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004394 * Return script-local "fname" with the 3-byte sequence replaced by
4395 * printable <SNR> in allocated memory.
4396 */
4397 char_u *
4398alloc_printable_func_name(char_u *fname)
4399{
4400 char_u *n = alloc(STRLEN(fname + 3) + 6);
4401
4402 if (n != NULL)
4403 {
4404 STRCPY(n, "<SNR>");
4405 STRCPY(n + 5, fname + 3);
4406 }
4407 return n;
4408}
4409
4410/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004411 * Call trans_function_name(), except that a lambda is returned as-is.
4412 * Returns the name in allocated memory.
4413 */
4414 char_u *
4415save_function_name(
4416 char_u **name,
4417 int *is_global,
4418 int skip,
4419 int flags,
4420 funcdict_T *fudi)
4421{
4422 char_u *p = *name;
4423 char_u *saved;
4424
4425 if (STRNCMP(p, "<lambda>", 8) == 0)
4426 {
4427 p += 8;
4428 (void)getdigits(&p);
4429 saved = vim_strnsave(*name, p - *name);
4430 if (fudi != NULL)
4431 CLEAR_POINTER(fudi);
4432 }
4433 else
4434 saved = trans_function_name(&p, is_global, skip,
4435 flags, fudi, NULL, NULL);
4436 *name = p;
4437 return saved;
4438}
4439
4440/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004441 * List functions. When "regmatch" is NULL all of then.
4442 * Otherwise functions matching "regmatch".
4443 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004444 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004445list_functions(regmatch_T *regmatch)
4446{
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004447 int prev_ht_changed = func_hashtab.ht_changed;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004448 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004449 hashitem_T *hi;
4450
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004451 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004452 {
4453 if (!HASHITEM_EMPTY(hi))
4454 {
4455 ufunc_T *fp = HI2UF(hi);
4456
4457 --todo;
4458 if ((fp->uf_flags & FC_DEAD) == 0
4459 && (regmatch == NULL
4460 ? !message_filtered(fp->uf_name)
4461 && !func_name_refcount(fp->uf_name)
4462 : !isdigit(*fp->uf_name)
4463 && vim_regexec(regmatch, fp->uf_name, 0)))
4464 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004465 if (list_func_head(fp, FALSE) == FAIL)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004466 return;
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004467 if (function_list_modified(prev_ht_changed))
4468 return;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004469 }
4470 }
4471 }
4472}
4473
4474/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004475 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004476 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4477 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004478 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar554d0312023-01-05 19:59:18 +00004479 * If "class_flags" has CF_CLASS then the function is defined inside a class.
4480 * With CF_INTERFACE the function is define inside an interface, only the
4481 * ":def"/":function" line is expected, no function body.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004482 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004484 ufunc_T *
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004485define_function(
4486 exarg_T *eap,
4487 char_u *name_arg,
4488 garray_T *lines_to_free,
Bram Moolenaar554d0312023-01-05 19:59:18 +00004489 int class_flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004490{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 int j;
4492 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004493 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004494 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004495 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496 char_u *p;
4497 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004498 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 char_u *line_arg = NULL;
4500 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004501 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004502 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004503 garray_T newlines;
4504 int varargs = FALSE;
4505 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004506 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004507 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004508 int fp_allocated = FALSE;
4509 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004510 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 dictitem_T *v;
4512 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004513 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004516 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004517 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004518 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519
4520 /*
4521 * ":function" without argument: list functions.
4522 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004523 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524 {
4525 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004526 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004527 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004528 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004529 }
4530
4531 /*
4532 * ":function /pat": list functions matching pattern.
4533 */
4534 if (*eap->arg == '/')
4535 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004536 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 if (!eap->skip)
4538 {
4539 regmatch_T regmatch;
4540
4541 c = *p;
4542 *p = NUL;
4543 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4544 *p = c;
4545 if (regmatch.regprog != NULL)
4546 {
4547 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004548 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 vim_regfree(regmatch.regprog);
4550 }
4551 }
4552 if (*p == '/')
4553 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004554 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004555 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004556 }
4557
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004558 ga_init(&newargs);
4559 ga_init(&argtypes);
4560 ga_init(&default_args);
4561
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004562 /*
4563 * Get the function name. There are these situations:
Bram Moolenaar554d0312023-01-05 19:59:18 +00004564 * func normal function name, also when "class_flags" is non-zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565 * "name" == func, "fudi.fd_dict" == NULL
4566 * dict.func new dictionary entry
4567 * "name" == NULL, "fudi.fd_dict" set,
4568 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4569 * dict.func existing dict entry with a Funcref
4570 * "name" == func, "fudi.fd_dict" set,
4571 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4572 * dict.func existing dict entry that's not a Funcref
4573 * "name" == NULL, "fudi.fd_dict" set,
4574 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4575 * s:func script-local function name
4576 * g:func global function name, same as "func"
4577 */
4578 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004579 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004580 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004581 // nested function, argument is (args).
4582 paren = TRUE;
4583 CLEAR_FIELD(fudi);
4584 }
4585 else
4586 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004587 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004588 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004589 if (p[0] == 's' && p[1] == ':')
4590 {
4591 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4592 return NULL;
4593 }
4594 p = to_name_end(p, TRUE);
4595 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4596 {
4597 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4598 eap->arg);
4599 return NULL;
4600 }
4601 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004602 }
4603
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004604 int tfn_flags = TFN_NO_AUTOLOAD | TFN_NEW_FUNC
Bram Moolenaar554d0312023-01-05 19:59:18 +00004605 | (class_flags != 0 ? TFN_IN_CLASS : 0);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004606 name = save_function_name(&p, &is_global, eap->skip, tfn_flags, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004607 paren = (vim_strchr(p, '(') != NULL);
4608 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004610 /*
4611 * Return on an invalid expression in braces, unless the expression
4612 * evaluation has been cancelled due to an aborting error, an
4613 * interrupt, or an exception.
4614 */
4615 if (!aborting())
4616 {
4617 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00004618 semsg(_(e_key_not_present_in_dictionary_str),
4619 fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004620 vim_free(fudi.fd_newkey);
4621 return NULL;
4622 }
4623 else
4624 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004626
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004627 // For "export def FuncName()" in an autoload script the function name
4628 // is stored with the legacy autoload name "dir#script#FuncName" so
4629 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004630 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004631 {
4632 char_u *prefixed = may_prefix_autoload(name);
4633
4634 if (prefixed != NULL && prefixed != name)
4635 {
4636 vim_free(name);
4637 name = prefixed;
4638 }
4639 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004640 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004641 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004642 {
4643 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4644 goto ret_free;
4645 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004646 }
4647
Bram Moolenaare38eab22019-12-05 21:50:01 +01004648 // An error in a function call during evaluation of an expression in magic
4649 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004650 saved_did_emsg = did_emsg;
4651 did_emsg = FALSE;
4652
4653 /*
4654 * ":function func" with only function name: list function.
4655 */
4656 if (!paren)
4657 {
4658 if (!ends_excmd(*skipwhite(p)))
4659 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004660 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661 goto ret_free;
4662 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004663 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664 if (eap->nextcmd != NULL)
4665 *p = NUL;
4666 if (!eap->skip && !got_int)
4667 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004668 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004669 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4670 {
4671 char_u *up = untrans_function_name(name);
4672
4673 // With Vim9 script the name was made script-local, if not
4674 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004675 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004676 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004677 }
4678
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679 if (fp != NULL)
4680 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004681 // Check no function was added or removed from a timer, e.g. at
4682 // the more prompt. "fp" may then be invalid.
4683 int prev_ht_changed = func_hashtab.ht_changed;
4684
4685 if (list_func_head(fp, TRUE) == OK)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004686 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004687 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4688 {
4689 if (FUNCLINE(fp, j) == NULL)
4690 continue;
4691 msg_putchar('\n');
4692 msg_outnum((long)(j + 1));
4693 if (j < 9)
4694 msg_putchar(' ');
4695 if (j < 99)
4696 msg_putchar(' ');
4697 if (function_list_modified(prev_ht_changed))
4698 break;
4699 msg_prt_line(FUNCLINE(fp, j), FALSE);
4700 out_flush(); // show a line at a time
4701 ui_breakcheck();
4702 }
4703 if (!got_int)
4704 {
4705 msg_putchar('\n');
4706 if (!function_list_modified(prev_ht_changed))
4707 {
4708 if (fp->uf_def_status != UF_NOT_COMPILED)
4709 msg_puts(" enddef");
4710 else
4711 msg_puts(" endfunction");
4712 }
4713 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004714 }
4715 }
4716 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004717 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718 }
4719 goto ret_free;
4720 }
4721
4722 /*
4723 * ":function name(arg1, arg2)" Define function.
4724 */
4725 p = skipwhite(p);
4726 if (*p != '(')
4727 {
4728 if (!eap->skip)
4729 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004730 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004731 goto ret_free;
4732 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004733 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004734 if (vim_strchr(p, '(') != NULL)
4735 p = vim_strchr(p, '(');
4736 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004737
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004738 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4739 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004740 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004741 goto ret_free;
4742 }
4743
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004744 // In Vim9 script only global functions can be redefined.
4745 if (vim9script && eap->forceit && !is_global)
4746 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004747 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004748 goto ret_free;
4749 }
4750
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004751 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752
Bram Moolenaar04b12692020-05-04 23:24:44 +02004753 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004755 // Check the name of the function. Unless it's a dictionary function
4756 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 if (name != NULL)
4758 arg = name;
4759 else
4760 arg = fudi.fd_newkey;
4761 if (arg != NULL && (fudi.fd_di == NULL
4762 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4763 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4764 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004765 char_u *name_base = arg;
4766 int i;
4767
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004769 {
4770 name_base = vim_strchr(arg, '_');
4771 if (name_base == NULL)
4772 name_base = arg + 3;
4773 else
4774 ++name_base;
4775 }
4776 for (i = 0; name_base[i] != NUL && (i == 0
4777 ? eval_isnamec1(name_base[i])
4778 : eval_isnamec(name_base[i])); ++i)
4779 ;
4780 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004781 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004782
4783 // In Vim9 script a function cannot have the same name as a
4784 // variable.
4785 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004786 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4787 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004788 + EVAL_VAR_NO_FUNC) == OK)
4789 {
4790 semsg(_(e_redefining_script_item_str), name_base);
4791 goto ret_free;
4792 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004794 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004796 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004797 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004798 goto ret_free;
4799 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 }
4801
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004802 // This may get more lines and make the pointers into the first line
4803 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004804 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004805 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarf0571712023-01-04 13:16:20 +00004806 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004807 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar554d0312023-01-05 19:59:18 +00004808 eap, class_flags, &newlines, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004810 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004812 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004814 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004815 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004816 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004817 if (*p != ':')
4818 {
4819 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4820 p = skipwhite(p);
4821 }
4822 else if (!IS_WHITE_OR_NUL(p[1]))
4823 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004824 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004825 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004826 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004827 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004828 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004829 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004830 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004831 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004832 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004833 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004834 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004835 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004836 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004837 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004838 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004839 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004840 else
4841 // find extra arguments "range", "dict", "abort" and "closure"
4842 for (;;)
4843 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004844 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004845 p = skipwhite(p);
4846 if (STRNCMP(p, "range", 5) == 0)
4847 {
4848 flags |= FC_RANGE;
4849 p += 5;
4850 }
4851 else if (STRNCMP(p, "dict", 4) == 0)
4852 {
4853 flags |= FC_DICT;
4854 p += 4;
4855 }
4856 else if (STRNCMP(p, "abort", 5) == 0)
4857 {
4858 flags |= FC_ABORT;
4859 p += 5;
4860 }
4861 else if (STRNCMP(p, "closure", 7) == 0)
4862 {
4863 flags |= FC_CLOSURE;
4864 p += 7;
4865 if (current_funccal == NULL)
4866 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00004867 emsg_funcname(e_closure_function_should_not_be_at_top_level_str,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004868 name == NULL ? (char_u *)"" : name);
4869 goto erret;
4870 }
4871 }
4872 else
4873 break;
4874 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875
Bram Moolenaare38eab22019-12-05 21:50:01 +01004876 // When there is a line break use what follows for the function body.
4877 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004878 if (*p == '\n')
4879 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004880 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004881 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4882 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004883 && !(VIM_ISWHITE(*whitep) && *p == '#'
4884 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004885 && !eap->skip
4886 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004887 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888
4889 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004890 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4891 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 */
4893 if (KeyTyped)
4894 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004895 // Check if the function already exists, don't let the user type the
4896 // whole function before telling him it doesn't work! For a script we
4897 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 if (!eap->skip && !eap->forceit)
4899 {
4900 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004901 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004902 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004903 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904 }
4905
4906 if (!eap->skip && did_emsg)
4907 goto erret;
4908
Bram Moolenaare38eab22019-12-05 21:50:01 +01004909 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910 cmdline_row = msg_row;
4911 }
4912
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004913 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004914 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004915
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004916 // Do not define the function when getting the body fails and when
4917 // skipping.
Bram Moolenaar554d0312023-01-05 19:59:18 +00004918 if (((class_flags & CF_INTERFACE) == 0
4919 && get_function_body(eap, &newlines, line_arg, lines_to_free)
4920 == FAIL)
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004921 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004922 goto erret;
4923
4924 /*
4925 * If there are no errors, add the function
4926 */
Bram Moolenaarffdaca92022-12-09 21:41:48 +00004927 if (fudi.fd_dict != NULL)
4928 {
4929 char numbuf[20];
4930
4931 fp = NULL;
4932 if (fudi.fd_newkey == NULL && !eap->forceit)
4933 {
4934 emsg(_(e_dictionary_entry_already_exists));
4935 goto erret;
4936 }
4937 if (fudi.fd_di == NULL)
4938 {
4939 // Can't add a function to a locked dictionary
4940 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
4941 goto erret;
4942 }
4943 // Can't change an existing function if it is locked
4944 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
4945 goto erret;
4946
4947 // Give the function a sequential number. Can only be used with a
4948 // Funcref!
4949 vim_free(name);
4950 sprintf(numbuf, "%d", ++func_nr);
4951 name = vim_strsave((char_u *)numbuf);
4952 if (name == NULL)
4953 goto erret;
4954 }
Bram Moolenaar554d0312023-01-05 19:59:18 +00004955 else if (class_flags == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004957 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004958 char_u *find_name = name;
4959 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004960 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004961
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004962 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004963 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004964 var_conflict = TRUE;
4965
4966 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4967 {
4968 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4969
4970 if (si->sn_autoload_prefix != NULL)
4971 {
4972 if (is_export)
4973 {
4974 find_name = name + STRLEN(si->sn_autoload_prefix);
4975 v = find_var(find_name, &ht, TRUE);
4976 if (v != NULL)
4977 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004978 // Only check if the function already exists in the script,
4979 // global functions can be shadowed.
4980 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004981 }
4982 else
4983 {
4984 char_u *prefixed = may_prefix_autoload(name);
4985
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004986 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004987 {
4988 v = find_var(prefixed, &ht, TRUE);
4989 if (v != NULL)
4990 var_conflict = TRUE;
4991 vim_free(prefixed);
4992 }
4993 }
4994 }
4995 }
4996 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004997 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004998 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004999 goto erret;
5000 }
5001
Bram Moolenaaracc4b562022-01-24 13:54:45 +00005002 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02005003 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004 {
Bram Moolenaareef21022020-08-01 22:16:43 +02005005 char_u *uname = untrans_function_name(name);
5006
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00005007 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02005008 }
5009
5010 if (fp != NULL || import != NULL)
5011 {
5012 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005013
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005014 // Function can be replaced with "function!" and when sourcing the
5015 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02005016 // A name that is used by an import can not be overruled.
5017 if (import != NULL
5018 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005019 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02005020 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005021 {
Bram Moolenaard604d782021-11-20 21:46:20 +00005022 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02005023 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02005024 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02005025 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00005026 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005027 goto erret;
5028 }
5029 if (fp->uf_calls > 0)
5030 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01005031 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00005032 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005033 goto erret;
5034 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005035 if (fp->uf_refcount > 1)
5036 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005037 // This function is referenced somewhere, don't redefine it but
5038 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005039 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005040 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005041 fp = NULL;
5042 overwrite = TRUE;
5043 }
5044 else
5045 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005046 char_u *exp_name = fp->uf_name_exp;
5047
5048 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01005049 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005050 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02005051 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01005052 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005053 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02005054#ifdef FEAT_PROFILE
5055 fp->uf_profiling = FALSE;
5056 fp->uf_prof_initialized = FALSE;
5057#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005058 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005059 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005060 }
5061 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005062
5063 if (fp == NULL)
5064 {
5065 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
5066 {
5067 int slen, plen;
5068 char_u *scriptname;
5069
Bram Moolenaare38eab22019-12-05 21:50:01 +01005070 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005071 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005072 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005073 {
5074 scriptname = autoload_name(name);
5075 if (scriptname != NULL)
5076 {
5077 p = vim_strchr(scriptname, '/');
5078 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005079 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005080 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005081 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005082 j = OK;
5083 vim_free(scriptname);
5084 }
5085 }
5086 if (j == FAIL)
5087 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02005088 linenr_T save_lnum = SOURCING_LNUM;
5089
5090 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00005091 semsg(_(e_function_name_does_not_match_script_file_name_str),
5092 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02005093 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005094 goto erret;
5095 }
5096 }
5097
Bram Moolenaare01e5212023-01-08 20:31:18 +00005098 fp = alloc_ufunc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005099 if (fp == NULL)
5100 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005101 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005102
5103 if (fudi.fd_dict != NULL)
5104 {
5105 if (fudi.fd_di == NULL)
5106 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005107 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005108 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
5109 if (fudi.fd_di == NULL)
5110 {
5111 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02005112 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005113 goto erret;
5114 }
5115 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
5116 {
5117 vim_free(fudi.fd_di);
5118 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02005119 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005120 goto erret;
5121 }
5122 }
5123 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005124 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005125 clear_tv(&fudi.fd_di->di_tv);
5126 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128
Bram Moolenaare38eab22019-12-05 21:50:01 +01005129 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130 flags |= FC_DICT;
5131 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005132 }
5133 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005134 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005135 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02005136 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005137
5138 if (eap->cmdidx == CMD_def)
5139 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02005140 int lnum_save = SOURCING_LNUM;
5141 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005142
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005143 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02005144
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005145 // error messages are for the first function line
5146 SOURCING_LNUM = sourcing_lnum_top;
5147
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02005148 // The function may use script variables from the context.
5149 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02005150
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005151 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005152 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005153 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005154 free_fp = fp_allocated;
5155 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005157 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005158
5159 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005160 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005161 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005162 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005163 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005164 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005165 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02005166 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005167 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005168 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005169 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005170
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005171 if (fp_allocated)
5172 {
5173 // insert the new function in the function list
5174 set_ufunc_name(fp, name);
5175 if (overwrite)
5176 {
5177 hi = hash_find(&func_hashtab, name);
5178 hi->hi_key = UF2HIKEY(fp);
5179 }
Bram Moolenaar554d0312023-01-05 19:59:18 +00005180 else if (class_flags == 0 && hash_add(&func_hashtab,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005181 UF2HIKEY(fp), "add function") == FAIL)
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005182 {
5183 free_fp = TRUE;
5184 goto erret;
5185 }
5186 fp->uf_refcount = 1;
5187 }
5188
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005189 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005190 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005191 if ((flags & FC_CLOSURE) != 0)
5192 {
Bram Moolenaar58016442016-07-31 18:30:22 +02005193 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005194 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005195 }
5196 else
5197 fp->uf_scoped = NULL;
5198
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005199#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200 if (prof_def_func())
5201 func_do_profile(fp);
5202#endif
5203 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02005204 if (sandbox)
5205 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02005206 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005207 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208 fp->uf_flags = flags;
5209 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01005210 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005211 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02005212 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02005213 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005214 if (is_export)
5215 {
5216 fp->uf_flags |= FC_EXPORT;
dundargocc57b5bc2022-11-02 13:30:51 +00005217 // let do_one_cmd() know the export worked.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005218 is_export = FALSE;
5219 }
5220
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005221 if (eap->cmdidx == CMD_def)
5222 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02005223 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
5224 // :func does not use Vim9 script syntax, even in a Vim9 script file
5225 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005226
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005227 goto ret_free;
5228
5229erret:
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005230 if (fp != NULL)
5231 {
Bram Moolenaarf0571712023-01-04 13:16:20 +00005232 // these were set to "newargs" and "default_args", which are cleared
5233 // below
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005234 ga_init(&fp->uf_args);
5235 ga_init(&fp->uf_def_args);
5236 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005237errret_2:
Bram Moolenaarf0571712023-01-04 13:16:20 +00005238 ga_clear_strings(&newargs);
5239 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005240 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005241 if (fp != NULL)
Bram Moolenaarf0571712023-01-04 13:16:20 +00005242 {
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005243 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarf0571712023-01-04 13:16:20 +00005244 VIM_CLEAR(fp->uf_va_name);
5245 clear_type_list(&fp->uf_type_list);
5246 }
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005247 if (free_fp)
5248 {
5249 vim_free(fp);
5250 fp = NULL;
5251 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005252ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005253 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005254 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005255 if (name != name_arg)
5256 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005257 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005259
5260 return fp;
5261}
5262
5263/*
5264 * ":function"
5265 */
5266 void
5267ex_function(exarg_T *eap)
5268{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005269 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005270
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005271 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Bram Moolenaar554d0312023-01-05 19:59:18 +00005272 (void)define_function(eap, NULL, &lines_to_free, 0);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005273 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005274}
5275
5276/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005277 * Find a function by name, including "<lambda>123".
5278 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005279 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005280 * Return NULL if not found.
5281 */
5282 ufunc_T *
5283find_func_by_name(char_u *name, compiletype_T *compile_type)
5284{
5285 char_u *arg = name;
5286 char_u *fname;
5287 ufunc_T *ufunc;
5288 int is_global = FALSE;
5289
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005290 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5291 {
5292 *compile_type = CT_PROFILE;
5293 arg = skipwhite(arg + 7);
5294 }
5295 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5296 {
5297 *compile_type = CT_DEBUG;
5298 arg = skipwhite(arg + 5);
5299 }
5300
5301 if (STRNCMP(arg, "<lambda>", 8) == 0)
5302 {
5303 arg += 8;
5304 (void)getdigits(&arg);
5305 fname = vim_strnsave(name, arg - name);
5306 }
5307 else
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005308 {
5309 // First try finding a method in a class, find_func_by_name() will give
5310 // an error if the function is not found.
5311 ufunc = find_class_func(&arg);
5312 if (ufunc != NULL)
5313 return ufunc;
5314
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005315 fname = trans_function_name(&arg, &is_global, FALSE,
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005316 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD | TFN_NO_DECL,
5317 NULL, NULL, NULL);
5318 }
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005319 if (fname == NULL)
5320 {
5321 semsg(_(e_invalid_argument_str), name);
5322 return NULL;
5323 }
5324 if (!ends_excmd2(name, arg))
5325 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005326 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005327 emsg(ex_errmsg(e_trailing_characters_str, arg));
5328 return NULL;
5329 }
5330
5331 ufunc = find_func(fname, is_global);
5332 if (ufunc == NULL)
5333 {
5334 char_u *p = untrans_function_name(fname);
5335
5336 if (p != NULL)
5337 // Try again without making it script-local.
5338 ufunc = find_func(p, FALSE);
5339 }
5340 vim_free(fname);
5341 if (ufunc == NULL)
5342 semsg(_(e_cannot_find_function_str), name);
5343 return ufunc;
5344}
5345
5346/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005347 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005348 * be compiled or the one specified by the argument.
5349 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005350 */
5351 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005352ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005353{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005354 ufunc_T *ufunc;
5355
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005356 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005357 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005358 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005359
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005360 ufunc = find_func_by_name(eap->arg, &compile_type);
5361 if (ufunc != NULL)
5362 {
5363 if (func_needs_compiling(ufunc, compile_type))
5364 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5365 else
5366 smsg(_("Function %s does not need compiling"), eap->arg);
5367 }
5368 }
5369 else
5370 {
5371 long todo = (long)func_hashtab.ht_used;
5372 int changed = func_hashtab.ht_changed;
5373 hashitem_T *hi;
5374
5375 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5376 {
5377 if (!HASHITEM_EMPTY(hi))
5378 {
5379 --todo;
5380 ufunc = HI2UF(hi);
5381 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5382 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5383 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005384 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005385 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5386
5387 if (func_hashtab.ht_changed != changed)
5388 {
5389 // a function has been added or removed, need to start
5390 // over
5391 todo = (long)func_hashtab.ht_used;
5392 changed = func_hashtab.ht_changed;
5393 hi = func_hashtab.ht_array;
5394 --hi;
5395 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005396 }
5397 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005398 }
5399 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005400}
5401
5402/*
5403 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5404 * Return 2 if "p" starts with "s:".
5405 * Return 0 otherwise.
5406 */
5407 int
5408eval_fname_script(char_u *p)
5409{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005410 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5411 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005412 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5413 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5414 return 5;
5415 if (p[0] == 's' && p[1] == ':')
5416 return 2;
5417 return 0;
5418}
5419
5420 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005421translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005422{
5423 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005424 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005425 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005426}
5427
5428/*
5429 * Return TRUE when "ufunc" has old-style "..." varargs
5430 * or named varargs "...name: type".
5431 */
5432 int
5433has_varargs(ufunc_T *ufunc)
5434{
5435 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005436}
5437
5438/*
5439 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005440 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005441 */
5442 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005443function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005444{
5445 char_u *nm = name;
5446 char_u *p;
5447 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005448 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005449 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005450
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005451 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5452 if (no_deref)
5453 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005454 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005455 nm = skipwhite(nm);
5456
Bram Moolenaare38eab22019-12-05 21:50:01 +01005457 // Only accept "funcname", "funcname ", "funcname (..." and
5458 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005459 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005460 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461 vim_free(p);
5462 return n;
5463}
5464
Bram Moolenaar113e1072019-01-20 15:30:40 +01005465#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005466 char_u *
5467get_expanded_name(char_u *name, int check)
5468{
5469 char_u *nm = name;
5470 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005471 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005472
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005473 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005474 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005475
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005476 if (p != NULL && *nm == NUL
5477 && (!check || translated_function_exists(p, is_global)))
5478 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005479
5480 vim_free(p);
5481 return NULL;
5482}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005483#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005484
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005485/*
5486 * Function given to ExpandGeneric() to obtain the list of user defined
5487 * function names.
5488 */
5489 char_u *
5490get_user_func_name(expand_T *xp, int idx)
5491{
5492 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005493 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005494 static hashitem_T *hi;
5495 ufunc_T *fp;
5496
5497 if (idx == 0)
5498 {
5499 done = 0;
5500 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005501 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005502 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005503 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005504 {
5505 if (done++ > 0)
5506 ++hi;
5507 while (HASHITEM_EMPTY(hi))
5508 ++hi;
5509 fp = HI2UF(hi);
5510
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005511 // don't show dead, dict and lambda functions
5512 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005513 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005514 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515
5516 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005517 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005518
5519 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005520 if (xp->xp_context != EXPAND_USER_FUNC
5521 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005522 {
5523 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005524 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005525 STRCAT(IObuff, ")");
5526 }
5527 return IObuff;
5528 }
5529 return NULL;
5530}
5531
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005532/*
Bram Moolenaar83677162023-01-08 19:54:10 +00005533 * Make a copy of a function.
5534 * Intended to be used for a function defined on a base class that has a copy
5535 * on the child class.
5536 * The copy has uf_refcount set to one.
5537 * Returns NULL when out of memory.
5538 */
5539 ufunc_T *
5540copy_function(ufunc_T *fp)
5541{
Bram Moolenaare01e5212023-01-08 20:31:18 +00005542 ufunc_T *ufunc = alloc_ufunc(fp->uf_name);
Bram Moolenaar83677162023-01-08 19:54:10 +00005543 if (ufunc == NULL)
5544 return NULL;
5545
5546 // Most things can just be copied.
5547 *ufunc = *fp;
5548
5549 ufunc->uf_def_status = UF_TO_BE_COMPILED;
5550 ufunc->uf_dfunc_idx = 0;
5551 ufunc->uf_class = NULL;
5552
5553 ga_copy_strings(&fp->uf_args, &ufunc->uf_args);
5554 ga_copy_strings(&fp->uf_def_args, &ufunc->uf_def_args);
5555
5556 if (ufunc->uf_arg_types != NULL)
5557 {
5558 // "uf_arg_types" is an allocated array, make a copy.
5559 type_T **at = ALLOC_CLEAR_MULT(type_T *, ufunc->uf_args.ga_len);
5560 if (at != NULL)
5561 {
5562 mch_memmove(at, ufunc->uf_arg_types,
5563 sizeof(type_T *) * ufunc->uf_args.ga_len);
5564 ufunc->uf_arg_types = at;
5565 }
5566 }
5567
5568 // TODO: how about the types themselves? they can be freed when the
5569 // original function is freed:
5570 // type_T **uf_arg_types;
5571 // type_T *uf_ret_type;
5572
5573 ufunc->uf_type_list.ga_len = 0;
5574 ufunc->uf_type_list.ga_data = NULL;
5575
5576 // TODO: partial_T *uf_partial;
5577
5578 if (ufunc->uf_va_name != NULL)
5579 ufunc->uf_va_name = vim_strsave(ufunc->uf_va_name);
5580
5581 // TODO:
5582 // type_T *uf_va_type;
5583 // type_T *uf_func_type;
5584
5585 ufunc->uf_block_depth = 0;
5586 ufunc->uf_block_ids = NULL;
5587
5588 ga_copy_strings(&fp->uf_lines, &ufunc->uf_lines);
5589
5590 ufunc->uf_refcount = 1;
5591 ufunc->uf_name_exp = NULL;
5592 STRCPY(ufunc->uf_name, fp->uf_name);
5593
5594 return ufunc;
5595}
5596
5597/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005598 * ":delfunction {name}"
5599 */
5600 void
5601ex_delfunction(exarg_T *eap)
5602{
5603 ufunc_T *fp = NULL;
5604 char_u *p;
5605 char_u *name;
5606 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005607 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005608
5609 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005610 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5611 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005612 vim_free(fudi.fd_newkey);
5613 if (name == NULL)
5614 {
5615 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005616 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005617 return;
5618 }
5619 if (!ends_excmd(*skipwhite(p)))
5620 {
5621 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005622 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005623 return;
5624 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005625 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005626 if (eap->nextcmd != NULL)
5627 *p = NUL;
5628
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005629 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005630 {
5631 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005632 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005633 vim_free(name);
5634 return;
5635 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005636 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005637 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005638 vim_free(name);
5639
5640 if (!eap->skip)
5641 {
5642 if (fp == NULL)
5643 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005644 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005645 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005646 return;
5647 }
5648 if (fp->uf_calls > 0)
5649 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005650 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005651 return;
5652 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005653 if (fp->uf_flags & FC_VIM9)
5654 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005655 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005656 return;
5657 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005658
5659 if (fudi.fd_dict != NULL)
5660 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005661 // Delete the dict item that refers to the function, it will
5662 // invoke func_unref() and possibly delete the function.
Bram Moolenaaref2c3252022-11-25 16:31:51 +00005663 dictitem_remove(fudi.fd_dict, fudi.fd_di, "delfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005664 }
5665 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005666 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005667 // A normal function (not a numbered function or lambda) has a
5668 // refcount of 1 for the entry in the hashtable. When deleting
5669 // it and the refcount is more than one, it should be kept.
5670 // A numbered function and lambda should be kept if the refcount is
5671 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005672 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005673 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005674 // Function is still referenced somewhere. Don't free it but
5675 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005676 if (func_remove(fp))
5677 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005678 }
5679 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005680 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005681 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005682 }
5683}
5684
5685/*
5686 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005687 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005688 */
5689 void
5690func_unref(char_u *name)
5691{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005692 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005693
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005694 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005695 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005696 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005697 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005698 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005699#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005700 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005701#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005702 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005703 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005704 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005705}
5706
5707/*
5708 * Unreference a Function: decrement the reference count and free it when it
5709 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005710 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005711 */
5712 void
5713func_ptr_unref(ufunc_T *fp)
5714{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005715 if (fp != NULL && (--fp->uf_refcount <= 0
5716 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5717 && fp->uf_partial->pt_refcount <= 1
5718 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005719 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005720 // Only delete it when it's not being used. Otherwise it's done
5721 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005722 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005723 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005724 }
5725}
5726
5727/*
5728 * Count a reference to a Function.
5729 */
5730 void
5731func_ref(char_u *name)
5732{
5733 ufunc_T *fp;
5734
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005735 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005736 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005737 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005738 if (fp != NULL)
5739 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005740 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005741 // Only give an error for a numbered function.
5742 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005743 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005744}
5745
5746/*
5747 * Count a reference to a Function.
5748 */
5749 void
5750func_ptr_ref(ufunc_T *fp)
5751{
5752 if (fp != NULL)
5753 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005754}
5755
5756/*
5757 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5758 * referenced from anywhere that is in use.
5759 */
5760 static int
5761can_free_funccal(funccall_T *fc, int copyID)
5762{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005763 return (fc->fc_l_varlist.lv_copyID != copyID
5764 && fc->fc_l_vars.dv_copyID != copyID
5765 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005766 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005767}
5768
5769/*
5770 * ":return [expr]"
5771 */
5772 void
5773ex_return(exarg_T *eap)
5774{
5775 char_u *arg = eap->arg;
5776 typval_T rettv;
5777 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005778 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005779
5780 if (current_funccal == NULL)
5781 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005782 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005783 return;
5784 }
5785
Bram Moolenaar844fb642021-10-23 13:32:30 +01005786 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005787 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5788
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005789 if (eap->skip)
5790 ++emsg_skip;
5791
5792 eap->nextcmd = NULL;
5793 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005794 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005795 {
5796 if (!eap->skip)
5797 returning = do_return(eap, FALSE, TRUE, &rettv);
5798 else
5799 clear_tv(&rettv);
5800 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005801 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005802 else if (!eap->skip)
5803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005804 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005805 update_force_abort();
5806
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005807 /*
5808 * Return unless the expression evaluation has been cancelled due to an
5809 * aborting error, an interrupt, or an exception.
5810 */
5811 if (!aborting())
5812 returning = do_return(eap, FALSE, TRUE, NULL);
5813 }
5814
Bram Moolenaare38eab22019-12-05 21:50:01 +01005815 // When skipping or the return gets pending, advance to the next command
5816 // in this line (!returning). Otherwise, ignore the rest of the line.
5817 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005818 if (returning)
5819 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005820 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005821 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005822
5823 if (eap->skip)
5824 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005825 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005826}
5827
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005828 static int
5829ex_call_inner(
5830 exarg_T *eap,
5831 char_u *name,
5832 char_u **arg,
5833 char_u *startarg,
5834 funcexe_T *funcexe_init,
5835 evalarg_T *evalarg)
5836{
5837 linenr_T lnum;
5838 int doesrange;
5839 typval_T rettv;
5840 int failed = FALSE;
5841
5842 /*
5843 * When skipping, evaluate the function once, to find the end of the
5844 * arguments.
5845 * When the function takes a range, this is discovered after the first
5846 * call, and the loop is broken.
5847 */
5848 if (eap->skip)
5849 {
5850 ++emsg_skip;
5851 lnum = eap->line2; // do it once, also with an invalid range
5852 }
5853 else
5854 lnum = eap->line1;
5855 for ( ; lnum <= eap->line2; ++lnum)
5856 {
5857 funcexe_T funcexe;
5858
5859 if (!eap->skip && eap->addr_count > 0)
5860 {
5861 if (lnum > curbuf->b_ml.ml_line_count)
5862 {
5863 // If the function deleted lines or switched to another buffer
5864 // the line number may become invalid.
5865 emsg(_(e_invalid_range));
5866 break;
5867 }
5868 curwin->w_cursor.lnum = lnum;
5869 curwin->w_cursor.col = 0;
5870 curwin->w_cursor.coladd = 0;
5871 }
5872 *arg = startarg;
5873
5874 funcexe = *funcexe_init;
5875 funcexe.fe_doesrange = &doesrange;
5876 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5877 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5878 {
5879 failed = TRUE;
5880 break;
5881 }
5882 if (has_watchexpr())
5883 dbg_check_breakpoint(eap);
5884
5885 // Handle a function returning a Funcref, Dictionary or List.
5886 if (handle_subscript(arg, NULL, &rettv,
5887 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5888 {
5889 failed = TRUE;
5890 break;
5891 }
5892
5893 clear_tv(&rettv);
5894 if (doesrange || eap->skip)
5895 break;
5896
5897 // Stop when immediately aborting on error, or when an interrupt
5898 // occurred or an exception was thrown but not caught.
5899 // get_func_tv() returned OK, so that the check for trailing
5900 // characters below is executed.
5901 if (aborting())
5902 break;
5903 }
5904 if (eap->skip)
5905 --emsg_skip;
5906 return failed;
5907}
5908
5909/*
5910 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5911 * Returns FAIL or OK.
5912 */
5913 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005914ex_defer_inner(
5915 char_u *name,
5916 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005917 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005918 partial_T *partial,
5919 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005920{
5921 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005922 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005923 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005924 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005925
5926 if (current_funccal == NULL)
5927 {
5928 semsg(_(e_str_not_inside_function), "defer");
5929 return FAIL;
5930 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005931 if (partial != NULL)
5932 {
5933 if (partial->pt_dict != NULL)
5934 {
5935 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5936 return FAIL;
5937 }
5938 if (partial->pt_argc > 0)
5939 {
5940 int i;
5941
5942 partial_argc = partial->pt_argc;
5943 for (i = 0; i < partial_argc; ++i)
5944 copy_tv(&partial->pt_argv[i], &argvars[i]);
5945 }
5946 }
5947 r = get_func_arguments(arg, evalarg, FALSE,
5948 argvars + partial_argc, &argcount);
5949 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005950
5951 if (r == OK)
5952 {
5953 if (type != NULL)
5954 {
5955 // Check that the arguments are OK for the types of the funcref.
5956 r = check_argument_types(type, argvars, argcount, NULL, name);
5957 }
5958 else if (builtin_function(name, -1))
5959 {
5960 int idx = find_internal_func(name);
5961
5962 if (idx < 0)
5963 {
5964 emsg_funcname(e_unknown_function_str, name);
5965 r = FAIL;
5966 }
5967 else if (check_internal_func(idx, argcount) == -1)
5968 r = FAIL;
5969 }
5970 else
5971 {
5972 ufunc_T *ufunc = find_func(name, FALSE);
5973
5974 // we tolerate an unknown function here, it might be defined later
5975 if (ufunc != NULL)
5976 {
5977 int error = check_user_func_argcount(ufunc, argcount);
5978
5979 if (error != FCERR_UNKNOWN)
5980 {
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01005981 user_func_error(error, name, FALSE);
Bram Moolenaar16900322022-09-08 19:51:45 +01005982 r = FAIL;
5983 }
5984 }
5985 }
5986 }
5987
Bram Moolenaar86d87252022-09-05 21:21:25 +01005988 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01005989 {
5990 while (--argcount >= 0)
5991 clear_tv(&argvars[argcount]);
5992 return FAIL;
5993 }
5994 return add_defer(name, argcount, argvars);
5995}
5996
5997/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01005998 * Return TRUE if currently inside a function call.
5999 * Give an error message and return FALSE when not.
6000 */
6001 int
6002can_add_defer(void)
6003{
6004 if (!in_def_function() && get_current_funccal() == NULL)
6005 {
6006 semsg(_(e_str_not_inside_function), "defer");
6007 return FALSE;
6008 }
6009 return TRUE;
6010}
6011
6012/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01006013 * Add a deferred call for "name" with arguments "argvars[argcount]".
6014 * Consumes "argvars[]".
6015 * Caller must check that in_def_function() returns TRUE or current_funccal is
6016 * not NULL.
6017 * Returns OK or FAIL.
6018 */
6019 int
6020add_defer(char_u *name, int argcount_arg, typval_T *argvars)
6021{
6022 char_u *saved_name = vim_strsave(name);
6023 int argcount = argcount_arg;
6024 defer_T *dr;
6025 int ret = FAIL;
6026
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006027 if (saved_name == NULL)
6028 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01006029 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006030 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01006031 if (add_defer_function(saved_name, argcount, argvars) == OK)
6032 argcount = 0;
6033 }
6034 else
6035 {
6036 if (current_funccal->fc_defer.ga_itemsize == 0)
6037 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
6038 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
6039 goto theend;
6040 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
6041 + current_funccal->fc_defer.ga_len++;
6042 dr->dr_name = saved_name;
6043 dr->dr_argcount = argcount;
6044 while (argcount > 0)
6045 {
6046 --argcount;
6047 dr->dr_argvars[argcount] = argvars[argcount];
6048 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006049 }
6050 ret = OK;
6051
6052theend:
6053 while (--argcount >= 0)
6054 clear_tv(&argvars[argcount]);
6055 return ret;
6056}
6057
6058/*
6059 * Invoked after a functions has finished: invoke ":defer" functions.
6060 */
Bram Moolenaar58779852022-09-06 18:31:14 +01006061 static void
6062handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006063{
6064 int idx;
6065
Bram Moolenaar58779852022-09-06 18:31:14 +01006066 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006067 {
6068 funcexe_T funcexe;
6069 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01006070 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006071 int i;
6072
6073 CLEAR_FIELD(funcexe);
6074 funcexe.fe_evaluate = TRUE;
6075
6076 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
6077 call_func(dr->dr_name, -1, &rettv,
6078 dr->dr_argcount, dr->dr_argvars, &funcexe);
6079 clear_tv(&rettv);
6080 vim_free(dr->dr_name);
6081 for (i = dr->dr_argcount - 1; i >= 0; --i)
6082 clear_tv(&dr->dr_argvars[i]);
6083 }
Bram Moolenaar58779852022-09-06 18:31:14 +01006084 ga_clear(&funccal->fc_defer);
6085}
6086
6087/*
6088 * Called when exiting: call all defer functions.
6089 */
6090 void
6091invoke_all_defer(void)
6092{
6093 funccall_T *funccal;
6094
Bram Moolenaarca16c602022-09-06 18:57:08 +01006095 for (funccal = current_funccal; funccal != NULL;
6096 funccal = funccal->fc_caller)
Bram Moolenaar58779852022-09-06 18:31:14 +01006097 if (funccal->fc_ectx != NULL)
6098 {
6099 // :def function
6100 unwind_def_callstack(funccal->fc_ectx);
6101 may_invoke_defer_funcs(funccal->fc_ectx);
6102 }
6103 else
6104 {
6105 // legacy function
6106 handle_defer_one(funccal);
6107 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006108}
6109
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006110/*
6111 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006112 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006113 */
6114 void
6115ex_call(exarg_T *eap)
6116{
6117 char_u *arg = eap->arg;
6118 char_u *startarg;
6119 char_u *name;
6120 char_u *tofree;
6121 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006122 int failed = FALSE;
6123 funcdict_T fudi;
6124 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006125 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006126 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00006127 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00006128 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006129
Bram Moolenaare6b53242020-07-01 17:28:33 +02006130 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006131 if (eap->skip)
6132 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006133 typval_T rettv;
6134
Bram Moolenaare38eab22019-12-05 21:50:01 +01006135 // trans_function_name() doesn't work well when skipping, use eval0()
6136 // instead to skip to any following command, e.g. for:
6137 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006138 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006139 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006140 clear_tv(&rettv);
6141 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02006142 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006143 return;
6144 }
6145
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006146 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00006147 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006148 if (fudi.fd_newkey != NULL)
6149 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006150 // Still need to give an error message for missing key.
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00006151 semsg(_(e_key_not_present_in_dictionary_str), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006152 vim_free(fudi.fd_newkey);
6153 }
6154 if (tofree == NULL)
6155 return;
6156
Bram Moolenaare38eab22019-12-05 21:50:01 +01006157 // Increase refcount on dictionary, it could get deleted when evaluating
6158 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006159 if (fudi.fd_dict != NULL)
6160 ++fudi.fd_dict->dv_refcount;
6161
Bram Moolenaare38eab22019-12-05 21:50:01 +01006162 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
6163 // contents. For VAR_PARTIAL get its partial, unless we already have one
6164 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006165 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01006166 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00006167 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00006168 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006169
Bram Moolenaare38eab22019-12-05 21:50:01 +01006170 // Skip white space to allow ":call func ()". Not good, but required for
6171 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006172 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006173 if (*startarg != '(')
6174 {
Bram Moolenaare1242042021-12-16 20:56:57 +00006175 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006176 goto end;
6177 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00006178 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02006179 {
6180 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
6181 goto end;
6182 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006183
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006184 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006185 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006186 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01006187 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006188 }
6189 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006190 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02006191 funcexe_T funcexe;
6192
Bram Moolenaara80faa82020-04-12 19:37:17 +02006193 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006194 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00006195 funcexe.fe_partial = partial;
6196 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006197 funcexe.fe_firstline = eap->line1;
6198 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00006199 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006200 funcexe.fe_evaluate = !eap->skip;
6201 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006202 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006203
Bram Moolenaar1d341892021-09-18 15:25:52 +02006204 // When inside :try we need to check for following "| catch" or "| endtry".
6205 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006206 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006207 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006208 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02006209 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02006210 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006211 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02006212 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006213 {
6214 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00006215 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006216 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006217 }
6218 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02006219 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006220 }
Bram Moolenaara929c922022-04-18 15:21:17 +01006221 // Must be after using "arg", it may point into memory cleared here.
6222 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006223
6224end:
6225 dict_unref(fudi.fd_dict);
6226 vim_free(tofree);
6227}
6228
6229/*
6230 * Return from a function. Possibly makes the return pending. Also called
6231 * for a pending return at the ":endtry" or after returning from an extra
6232 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
6233 * when called due to a ":return" command. "rettv" may point to a typval_T
6234 * with the return rettv. Returns TRUE when the return can be carried out,
6235 * FALSE when the return gets pending.
6236 */
6237 int
6238do_return(
6239 exarg_T *eap,
6240 int reanimate,
6241 int is_cmd,
6242 void *rettv)
6243{
6244 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01006245 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006246
6247 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006248 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006249 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006250
6251 /*
6252 * Cleanup (and inactivate) conditionals, but stop when a try conditional
6253 * not in its finally clause (which then is to be executed next) is found.
6254 * In this case, make the ":return" pending for execution at the ":endtry".
6255 * Otherwise, return normally.
6256 */
6257 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
6258 if (idx >= 0)
6259 {
6260 cstack->cs_pending[idx] = CSTP_RETURN;
6261
6262 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006263 // A pending return again gets pending. "rettv" points to an
6264 // allocated variable with the rettv of the original ":return"'s
6265 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006266 cstack->cs_rettv[idx] = rettv;
6267 else
6268 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006269 // When undoing a return in order to make it pending, get the stored
6270 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006271 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006272 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006273
6274 if (rettv != NULL)
6275 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006276 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006277 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
6278 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
6279 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02006280 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006281 }
6282 else
6283 cstack->cs_rettv[idx] = NULL;
6284
6285 if (reanimate)
6286 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006287 // The pending return value could be overwritten by a ":return"
6288 // without argument in a finally clause; reset the default
6289 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006290 current_funccal->fc_rettv->v_type = VAR_NUMBER;
6291 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006292 }
6293 }
6294 report_make_pending(CSTP_RETURN, rettv);
6295 }
6296 else
6297 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006298 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006299
Bram Moolenaare38eab22019-12-05 21:50:01 +01006300 // If the return is carried out now, store the return value. For
6301 // a return immediately after reanimation, the value is already
6302 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006303 if (!reanimate && rettv != NULL)
6304 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006305 clear_tv(current_funccal->fc_rettv);
6306 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006307 if (!is_cmd)
6308 vim_free(rettv);
6309 }
6310 }
6311
6312 return idx < 0;
6313}
6314
6315/*
6316 * Free the variable with a pending return value.
6317 */
6318 void
6319discard_pending_return(void *rettv)
6320{
6321 free_tv((typval_T *)rettv);
6322}
6323
6324/*
6325 * Generate a return command for producing the value of "rettv". The result
6326 * is an allocated string. Used by report_pending() for verbose messages.
6327 */
6328 char_u *
6329get_return_cmd(void *rettv)
6330{
6331 char_u *s = NULL;
6332 char_u *tofree = NULL;
6333 char_u numbuf[NUMBUFLEN];
6334
6335 if (rettv != NULL)
6336 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6337 if (s == NULL)
6338 s = (char_u *)"";
6339
6340 STRCPY(IObuff, ":return ");
6341 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6342 if (STRLEN(s) + 8 >= IOSIZE)
6343 STRCPY(IObuff + IOSIZE - 4, "...");
6344 vim_free(tofree);
6345 return vim_strsave(IObuff);
6346}
6347
6348/*
6349 * Get next function line.
6350 * Called by do_cmdline() to get the next line.
6351 * Returns allocated string, or NULL for end of function.
6352 */
6353 char_u *
6354get_func_line(
6355 int c UNUSED,
6356 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006357 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006358 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006359{
6360 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006361 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006362 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006363 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006364
Bram Moolenaare38eab22019-12-05 21:50:01 +01006365 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006366 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006367 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006368 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006369 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006370 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006371 }
6372#ifdef FEAT_PROFILE
6373 if (do_profiling == PROF_YES)
6374 func_line_end(cookie);
6375#endif
6376
6377 gap = &fp->uf_lines;
6378 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006379 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006380 retval = NULL;
6381 else
6382 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006383 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006384 while (fcp->fc_linenr < gap->ga_len
6385 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6386 ++fcp->fc_linenr;
6387 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006388 retval = NULL;
6389 else
6390 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006391 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6392 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006393#ifdef FEAT_PROFILE
6394 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006395 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006396#endif
6397 }
6398 }
6399
Bram Moolenaare38eab22019-12-05 21:50:01 +01006400 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006401 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006402 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006403 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006404 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006405 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006406 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006407 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006408 }
6409
6410 return retval;
6411}
6412
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006413/*
6414 * Return TRUE if the currently active function should be ended, because a
6415 * return was encountered or an error occurred. Used inside a ":while".
6416 */
6417 int
6418func_has_ended(void *cookie)
6419{
6420 funccall_T *fcp = (funccall_T *)cookie;
6421
Bram Moolenaare38eab22019-12-05 21:50:01 +01006422 // Ignore the "abort" flag if the abortion behavior has been changed due to
6423 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006424 return (((fcp->fc_func->uf_flags & FC_ABORT)
6425 && did_emsg && !aborted_in_try())
6426 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006427}
6428
6429/*
6430 * return TRUE if cookie indicates a function which "abort"s on errors.
6431 */
6432 int
6433func_has_abort(
6434 void *cookie)
6435{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006436 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006437}
6438
6439
6440/*
6441 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6442 * Don't do this when "Func" is already a partial that was bound
6443 * explicitly (pt_auto is FALSE).
6444 * Changes "rettv" in-place.
6445 * Returns the updated "selfdict_in".
6446 */
6447 dict_T *
6448make_partial(dict_T *selfdict_in, typval_T *rettv)
6449{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006450 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006451 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006452 char_u fname_buf[FLEN_FIXED + 1];
6453 int error;
6454 dict_T *selfdict = selfdict_in;
6455
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006456 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6457 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006458 fp = rettv->vval.v_partial->pt_func;
6459 else
6460 {
6461 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006462 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006463 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006464 if (fname == NULL)
6465 {
6466 // There is no point binding a dict to a NULL function, just create
6467 // a function reference.
6468 rettv->v_type = VAR_FUNC;
6469 rettv->vval.v_string = NULL;
6470 }
6471 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006472 {
6473 char_u *tofree = NULL;
6474
6475 // Translate "s:func" to the stored function name.
6476 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6477 fp = find_func(fname, FALSE);
6478 vim_free(tofree);
6479 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006480 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006481
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006482 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006483 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006484 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006485
6486 if (pt != NULL)
6487 {
6488 pt->pt_refcount = 1;
6489 pt->pt_dict = selfdict;
6490 pt->pt_auto = TRUE;
6491 selfdict = NULL;
6492 if (rettv->v_type == VAR_FUNC)
6493 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006494 // Just a function: Take over the function name and use
6495 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006496 pt->pt_name = rettv->vval.v_string;
6497 }
6498 else
6499 {
6500 partial_T *ret_pt = rettv->vval.v_partial;
6501 int i;
6502
Bram Moolenaare38eab22019-12-05 21:50:01 +01006503 // Partial: copy the function name, use selfdict and copy
6504 // args. Can't take over name or args, the partial might
6505 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006506 if (ret_pt->pt_name != NULL)
6507 {
6508 pt->pt_name = vim_strsave(ret_pt->pt_name);
6509 func_ref(pt->pt_name);
6510 }
6511 else
6512 {
6513 pt->pt_func = ret_pt->pt_func;
6514 func_ptr_ref(pt->pt_func);
6515 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006516 if (ret_pt->pt_argc > 0)
6517 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006518 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006519 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006520 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006521 pt->pt_argc = 0;
6522 else
6523 {
6524 pt->pt_argc = ret_pt->pt_argc;
6525 for (i = 0; i < pt->pt_argc; i++)
6526 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6527 }
6528 }
6529 partial_unref(ret_pt);
6530 }
6531 rettv->v_type = VAR_PARTIAL;
6532 rettv->vval.v_partial = pt;
6533 }
6534 }
6535 return selfdict;
6536}
6537
6538/*
6539 * Return the name of the executed function.
6540 */
6541 char_u *
6542func_name(void *cookie)
6543{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006544 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006545}
6546
6547/*
6548 * Return the address holding the next breakpoint line for a funccall cookie.
6549 */
6550 linenr_T *
6551func_breakpoint(void *cookie)
6552{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006553 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006554}
6555
6556/*
6557 * Return the address holding the debug tick for a funccall cookie.
6558 */
6559 int *
6560func_dbg_tick(void *cookie)
6561{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006562 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006563}
6564
6565/*
6566 * Return the nesting level for a funccall cookie.
6567 */
6568 int
6569func_level(void *cookie)
6570{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006571 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006572}
6573
6574/*
6575 * Return TRUE when a function was ended by a ":return" command.
6576 */
6577 int
6578current_func_returned(void)
6579{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006580 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006581}
6582
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006583 int
6584free_unref_funccal(int copyID, int testing)
6585{
6586 int did_free = FALSE;
6587 int did_free_funccal = FALSE;
6588 funccall_T *fc, **pfc;
6589
6590 for (pfc = &previous_funccal; *pfc != NULL; )
6591 {
6592 if (can_free_funccal(*pfc, copyID))
6593 {
6594 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006595 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006596 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006597 did_free = TRUE;
6598 did_free_funccal = TRUE;
6599 }
6600 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006601 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006602 }
6603 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006604 // When a funccal was freed some more items might be garbage
6605 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006606 (void)garbage_collect(testing);
6607
6608 return did_free;
6609}
6610
6611/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006612 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006613 */
6614 static funccall_T *
6615get_funccal(void)
6616{
6617 int i;
6618 funccall_T *funccal;
6619 funccall_T *temp_funccal;
6620
6621 funccal = current_funccal;
6622 if (debug_backtrace_level > 0)
6623 {
6624 for (i = 0; i < debug_backtrace_level; i++)
6625 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006626 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006627 if (temp_funccal)
6628 funccal = temp_funccal;
6629 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006630 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006631 debug_backtrace_level = i;
6632 }
6633 }
6634 return funccal;
6635}
6636
6637/*
6638 * Return the hashtable used for local variables in the current funccal.
6639 * Return NULL if there is no current funccal.
6640 */
6641 hashtab_T *
6642get_funccal_local_ht()
6643{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006644 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006645 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006646 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006647}
6648
6649/*
6650 * Return the l: scope variable.
6651 * Return NULL if there is no current funccal.
6652 */
6653 dictitem_T *
6654get_funccal_local_var()
6655{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006656 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006657 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006658 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006659}
6660
6661/*
6662 * Return the hashtable used for argument in the current funccal.
6663 * Return NULL if there is no current funccal.
6664 */
6665 hashtab_T *
6666get_funccal_args_ht()
6667{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006668 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006669 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006670 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006671}
6672
6673/*
6674 * Return the a: scope variable.
6675 * Return NULL if there is no current funccal.
6676 */
6677 dictitem_T *
6678get_funccal_args_var()
6679{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006680 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006681 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006682 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006683}
6684
6685/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006686 * List function variables, if there is a function.
6687 */
6688 void
6689list_func_vars(int *first)
6690{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006691 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6692 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006693 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006694}
6695
6696/*
6697 * If "ht" is the hashtable for local variables in the current funccal, return
6698 * the dict that contains it.
6699 * Otherwise return NULL.
6700 */
6701 dict_T *
6702get_current_funccal_dict(hashtab_T *ht)
6703{
6704 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006705 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6706 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006707 return NULL;
6708}
6709
6710/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006711 * Search hashitem in parent scope.
6712 */
6713 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006714find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006715{
6716 funccall_T *old_current_funccal = current_funccal;
6717 hashtab_T *ht;
6718 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006719 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006720
Bram Moolenaarca16c602022-09-06 18:57:08 +01006721 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006722 return NULL;
6723
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006724 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006725 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006726 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006727 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006728 ht = find_var_ht(name, &varname);
6729 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006730 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006731 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006732 if (!HASHITEM_EMPTY(hi))
6733 {
6734 *pht = ht;
6735 break;
6736 }
6737 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006738 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006739 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006740 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006741 }
6742 current_funccal = old_current_funccal;
6743
6744 return hi;
6745}
6746
6747/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006748 * Search variable in parent scope.
6749 */
6750 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006751find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006752{
6753 dictitem_T *v = NULL;
6754 funccall_T *old_current_funccal = current_funccal;
6755 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006756 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006757
Bram Moolenaarca16c602022-09-06 18:57:08 +01006758 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006759 return NULL;
6760
Bram Moolenaare38eab22019-12-05 21:50:01 +01006761 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006762 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006763 while (current_funccal)
6764 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006765 ht = find_var_ht(name, &varname);
6766 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006767 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006768 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006769 if (v != NULL)
6770 break;
6771 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006772 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006773 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006774 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006775 }
6776 current_funccal = old_current_funccal;
6777
6778 return v;
6779}
6780
6781/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006782 * Set "copyID + 1" in previous_funccal and callers.
6783 */
6784 int
6785set_ref_in_previous_funccal(int copyID)
6786{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006787 funccall_T *fc;
6788
Bram Moolenaarca16c602022-09-06 18:57:08 +01006789 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006790 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006791 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006792 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6793 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6794 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006795 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006796 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006797 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006798}
6799
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006800 static int
6801set_ref_in_funccal(funccall_T *fc, int copyID)
6802{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006803 if (fc->fc_copyID != copyID)
6804 {
6805 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006806 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6807 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6808 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6809 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006810 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006811 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006812 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006813}
6814
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006815/*
6816 * Set "copyID" in all local vars and arguments in the call stack.
6817 */
6818 int
6819set_ref_in_call_stack(int copyID)
6820{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006821 funccall_T *fc;
6822 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006823
Bram Moolenaarca16c602022-09-06 18:57:08 +01006824 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006825 if (set_ref_in_funccal(fc, copyID))
6826 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006827
6828 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006829 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006830 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006831 if (set_ref_in_funccal(fc, copyID))
6832 return TRUE;
6833 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006834}
6835
6836/*
6837 * Set "copyID" in all functions available by name.
6838 */
6839 int
6840set_ref_in_functions(int copyID)
6841{
6842 int todo;
6843 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006844 ufunc_T *fp;
6845
6846 todo = (int)func_hashtab.ht_used;
6847 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006848 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006849 if (!HASHITEM_EMPTY(hi))
6850 {
6851 --todo;
6852 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006853 if (!func_name_refcount(fp->uf_name)
6854 && set_ref_in_func(NULL, fp, copyID))
6855 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006856 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006857 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006858 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006859}
6860
6861/*
6862 * Set "copyID" in all function arguments.
6863 */
6864 int
6865set_ref_in_func_args(int copyID)
6866{
6867 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006868
6869 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006870 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6871 copyID, NULL, NULL))
6872 return TRUE;
6873 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006874}
6875
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006876/*
6877 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006878 * Returns TRUE if setting references failed somehow.
6879 */
6880 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006881set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006882{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006883 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006884 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006885 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006886 char_u fname_buf[FLEN_FIXED + 1];
6887 char_u *tofree = NULL;
6888 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006889 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006890
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006891 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006892 return FALSE;
6893
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006894 if (fp_in == NULL)
6895 {
6896 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006897 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006898 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006899 if (fp != NULL)
6900 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006901 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006902 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006903 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006904
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006905 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006906 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006907}
6908
Bram Moolenaare38eab22019-12-05 21:50:01 +01006909#endif // FEAT_EVAL