blob: f0e9cd7c751f5a01929373fc1eb886bc00b84398 [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
191 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
192 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000193 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000194 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000195 }
196
197 return theline;
198}
199
200/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100203 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200204 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100205 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206get_function_args(
207 char_u **argp,
208 char_u endchar,
209 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100210 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100211 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100212 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200213 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200214 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200215 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000216 exarg_T *eap, // can be NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000217 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200218{
219 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100220 char_u *arg;
221 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200223 int any_default = FALSE;
224 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100225 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200226
227 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000228 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100229 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000230 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200231 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000232 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200233
234 if (varargs != NULL)
235 *varargs = FALSE;
236
237 /*
238 * Isolate the arguments: "arg1, arg2, ...)"
239 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100240 arg = skipwhite(*argp);
241 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200242 while (*p != endchar)
243 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200244 while (eap != NULL && eap->getline != NULL
245 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200246 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200247 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000248 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000249 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000250
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 if (theline == NULL)
252 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200253 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200254 p = skipwhite(theline);
255 }
256
257 if (mustend && *p != endchar)
258 {
259 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000260 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100261 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200262 }
263 if (*p == endchar)
264 break;
265
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
267 {
268 if (varargs != NULL)
269 *varargs = TRUE;
270 p += 3;
271 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272
273 if (argtypes != NULL)
274 {
275 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200276 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100278 if (!skip)
279 emsg(_(e_missing_name_after_dots));
280 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100281 }
282
283 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100284 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000285 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100286 if (p == arg)
287 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100288 if (*skipwhite(p) == '=')
289 {
290 emsg(_(e_cannot_use_default_for_variable_arguments));
291 break;
292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 }
295 else
296 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200297 char_u *np;
298
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200299 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100300 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000301 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200303 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304
Bram Moolenaar015cf102021-06-26 21:52:02 +0200305 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200306 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200307 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200308 if (*np == '=' && np[1] != '=' && np[1] != '~'
309 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 {
311 typval_T rettv;
312
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100313 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 any_default = TRUE;
Bram Moolenaareb5adf12022-09-04 13:41:37 +0100315 p = skipwhite(np + 1);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200316 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200317 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200318 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200319 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200320 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200321 if (ga_grow(default_args, 1) == FAIL)
322 goto err_ret;
323
324 // trim trailing whitespace
325 while (p > expr && VIM_ISWHITE(p[-1]))
326 p--;
327 c = *p;
328 *p = NUL;
329 expr = vim_strsave(expr);
330 if (expr == NULL)
331 {
332 *p = c;
333 goto err_ret;
334 }
335 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200336 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200337 default_args->ga_len++;
338 *p = c;
339 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200340 }
341 else
342 mustend = TRUE;
343 }
344 else if (any_default)
345 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000346 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200347 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200348 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200349
350 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
351 {
352 // Be tolerant when skipping
353 if (!skip)
354 {
355 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
356 goto err_ret;
357 }
358 p = skipwhite(p);
359 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200360 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200361 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200363 // Don't give this error when skipping, it makes the "->" not
364 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100365 // Allow missing space after comma in legacy functions.
366 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200367 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
368 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100369 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200370 goto err_ret;
371 }
372 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200373 else
374 mustend = TRUE;
375 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200376 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200378 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200379
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200380 if (*p != endchar)
381 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100382 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200383
384 *argp = p;
385 return OK;
386
387err_ret:
388 if (newargs != NULL)
389 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200390 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200391 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200392 return FAIL;
393}
394
395/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100396 * Parse the argument types, filling "fp->uf_arg_types".
397 * Return OK or FAIL.
398 */
399 static int
400parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
401{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200402 int len = 0;
403
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100404 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
405 if (argtypes->ga_len > 0)
406 {
407 // When "varargs" is set the last name/type goes into uf_va_name
408 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200409 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100410
411 if (len > 0)
412 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
413 if (fp->uf_arg_types != NULL)
414 {
415 int i;
416 type_T *type;
417
418 for (i = 0; i < len; ++ i)
419 {
420 char_u *p = ((char_u **)argtypes->ga_data)[i];
421
422 if (p == NULL)
423 // will get the type from the default value
424 type = &t_unknown;
425 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100426 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100427 if (type == NULL)
428 return FAIL;
429 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000430 if (i < fp->uf_args.ga_len
431 && (type->tt_type == VAR_FUNC
432 || type->tt_type == VAR_PARTIAL)
433 && var_wrong_func_name(
434 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
435 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100436 }
437 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100438 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200439
440 if (varargs)
441 {
442 char_u *p;
443
444 // Move the last argument "...name: type" to uf_va_name and
445 // uf_va_type.
446 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
447 [fp->uf_args.ga_len - 1];
448 --fp->uf_args.ga_len;
449 p = ((char_u **)argtypes->ga_data)[len];
450 if (p == NULL)
451 // TODO: get type from default value
452 fp->uf_va_type = &t_list_any;
453 else
454 {
455 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
456 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
457 {
458 semsg(_(e_variable_arguments_type_must_be_list_str),
459 ((char_u **)argtypes->ga_data)[len]);
460 return FAIL;
461 }
462 }
463 if (fp->uf_va_type == NULL)
464 return FAIL;
465 }
466
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100467 return OK;
468}
469
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100470 static int
471parse_return_type(ufunc_T *fp, char_u *ret_type)
472{
473 if (ret_type == NULL)
474 fp->uf_ret_type = &t_void;
475 else
476 {
477 char_u *p = ret_type;
478
479 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
480 if (fp->uf_ret_type == NULL)
481 {
482 fp->uf_ret_type = &t_void;
483 return FAIL;
484 }
485 }
486 return OK;
487}
488
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100489/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200490 * Register function "fp" as using "current_funccal" as its scope.
491 */
492 static int
493register_closure(ufunc_T *fp)
494{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200495 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100496 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200498 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200499 fp->uf_scoped = current_funccal;
500 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200501
Bram Moolenaarca16c602022-09-06 18:57:08 +0100502 if (ga_grow(&current_funccal->fc_ufuncs, 1) == FAIL)
Bram Moolenaar58016442016-07-31 18:30:22 +0200503 return FAIL;
Bram Moolenaarca16c602022-09-06 18:57:08 +0100504 ((ufunc_T **)current_funccal->fc_ufuncs.ga_data)
505 [current_funccal->fc_ufuncs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200506 return OK;
507}
508
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100509 static void
510set_ufunc_name(ufunc_T *fp, char_u *name)
511{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100512 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
513 // actually extends beyond the struct.
514 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100515
516 if (name[0] == K_SPECIAL)
517 {
518 fp->uf_name_exp = alloc(STRLEN(name) + 3);
519 if (fp->uf_name_exp != NULL)
520 {
521 STRCPY(fp->uf_name_exp, "<SNR>");
522 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
523 }
524 }
525}
526
Bram Moolenaar58016442016-07-31 18:30:22 +0200527/*
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100528 * If "name" starts with K_SPECIAL and "buf[bufsize]" is big enough
529 * return "buf" filled with a readable function name.
530 * Otherwise just return "name", thus the return value can always be used.
531 * "name" and "buf" may be equal.
532 */
533 char_u *
534make_ufunc_name_readable(char_u *name, char_u *buf, size_t bufsize)
535{
536 size_t len;
537
538 if (name[0] != K_SPECIAL)
539 return name;
540 len = STRLEN(name);
541 if (len + 3 > bufsize)
542 return name;
543
Bram Moolenaar96e08e02022-03-31 21:40:33 +0100544 mch_memmove(buf + 5, name + 3, len - 2); // Include trailing NUL
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100545 mch_memmove(buf, "<SNR>", 5);
546 return buf;
547}
548
549/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200550 * Get a name for a lambda. Returned in static memory.
551 */
552 char_u *
553get_lambda_name(void)
554{
555 static char_u name[30];
556 static int lambda_no = 0;
557
558 sprintf((char*)name, "<lambda>%d", ++lambda_no);
559 return name;
560}
561
Bram Moolenaar801ab062020-06-25 19:27:56 +0200562#if defined(FEAT_LUA) || defined(PROTO)
563/*
564 * Registers a native C callback which can be called from Vim script.
565 * Returns the name of the Vim script function.
566 */
567 char_u *
568register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
569{
570 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200571 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200572
573 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
574 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200575 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200576
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200577 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200578 fp->uf_refcount = 1;
579 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000580 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200581 fp->uf_calls = 0;
582 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200583 fp->uf_cb = cb;
584 fp->uf_cb_free = cb_free;
585 fp->uf_cb_state = state;
586
587 set_ufunc_name(fp, name);
588 hash_add(&func_hashtab, UF2HIKEY(fp));
589
590 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200591}
592#endif
593
Bram Moolenaar04b12692020-05-04 23:24:44 +0200594/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100595 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100596 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100597 * If "white_error" is not NULL check for correct use of white space and set
598 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100599 * Return NULL if no valid arrow found.
600 */
601 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100602skip_arrow(
603 char_u *start,
604 int equal_arrow,
605 char_u **ret_type,
606 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100607{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100608 char_u *s = start;
609 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100610
611 if (equal_arrow)
612 {
613 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100614 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100615 if (white_error != NULL && !VIM_ISWHITE(s[1]))
616 {
617 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100618 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100619 return NULL;
620 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100621 s = skipwhite(s + 1);
622 *ret_type = s;
623 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100624 if (s == *ret_type)
625 {
626 emsg(_(e_missing_return_type));
627 return NULL;
628 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100629 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100630 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100631 s = skipwhite(s);
632 if (*s != '=')
633 return NULL;
634 ++s;
635 }
636 if (*s != '>')
637 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100638 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
639 || !IS_WHITE_OR_NUL(s[1])))
640 {
641 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100642 semsg(_(e_white_space_required_before_and_after_str_at_str),
643 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100644 return NULL;
645 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100646 return skipwhite(s + 1);
647}
648
649/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100650 * Check if "*cmd" points to a function command and if so advance "*cmd" and
651 * return TRUE.
652 * Otherwise return FALSE;
653 * Do not consider "function(" to be a command.
654 */
655 static int
656is_function_cmd(char_u **cmd)
657{
658 char_u *p = *cmd;
659
660 if (checkforcmd(&p, "function", 2))
661 {
662 if (*p == '(')
663 return FALSE;
664 *cmd = p;
665 return TRUE;
666 }
667 return FALSE;
668}
669
670/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200671 * Called when defining a function: The context may be needed for script
672 * variables declared in a block that is visible now but not when the function
673 * is compiled or called later.
674 */
675 static void
676function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
677{
678 if (cstack != NULL && cstack->cs_idx >= 0)
679 {
680 int count = cstack->cs_idx + 1;
681 int i;
682
683 fp->uf_block_ids = ALLOC_MULT(int, count);
684 if (fp->uf_block_ids != NULL)
685 {
686 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
687 sizeof(int) * count);
688 fp->uf_block_depth = count;
689 }
690
691 // Set flag in each block to indicate a function was defined. This
692 // is used to keep the variable when leaving the block, see
693 // hide_script_var().
694 for (i = 0; i <= cstack->cs_idx; ++i)
695 cstack->cs_flags[i] |= CSF_FUNC_DEF;
696 }
697}
698
699/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100700 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200701 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100702 * "newlines" must already have been initialized.
703 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
704 */
705 static int
706get_function_body(
707 exarg_T *eap,
708 garray_T *newlines,
709 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000710 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100711{
712 linenr_T sourcing_lnum_top = SOURCING_LNUM;
713 linenr_T sourcing_lnum_off;
714 int saved_wait_return = need_wait_return;
715 char_u *line_arg = line_arg_in;
716 int vim9_function = eap->cmdidx == CMD_def
717 || eap->cmdidx == CMD_block;
718#define MAX_FUNC_NESTING 50
719 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200720 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100721 int nesting = 0;
722 getline_opt_T getline_options;
723 int indent = 2;
724 char_u *skip_until = NULL;
725 int ret = FAIL;
726 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200727 int heredoc_concat_len = 0;
728 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100729 char_u *heredoc_trimmed = NULL;
730
Bram Moolenaar20677332021-06-06 17:02:53 +0200731 ga_init2(&heredoc_ga, 1, 500);
732
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100733 // Detect having skipped over comment lines to find the return
734 // type. Add NULL lines to keep the line count correct.
735 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
736 if (SOURCING_LNUM < sourcing_lnum_off)
737 {
738 sourcing_lnum_off -= SOURCING_LNUM;
739 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
740 goto theend;
741 while (sourcing_lnum_off-- > 0)
742 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
743 }
744
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200745 nesting_def[0] = vim9_function;
746 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100747 getline_options = vim9_function
748 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
749 for (;;)
750 {
751 char_u *theline;
752 char_u *p;
753 char_u *arg;
754
755 if (KeyTyped)
756 {
757 msg_scroll = TRUE;
758 saved_wait_return = FALSE;
759 }
760 need_wait_return = FALSE;
761
762 if (line_arg != NULL)
763 {
764 // Use eap->arg, split up in parts by line breaks.
765 theline = line_arg;
766 p = vim_strchr(theline, '\n');
767 if (p == NULL)
768 line_arg += STRLEN(line_arg);
769 else
770 {
771 *p = NUL;
772 line_arg = p + 1;
773 }
774 }
775 else
776 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000777 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100778 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100779 }
780 if (KeyTyped)
781 lines_left = Rows - 1;
782 if (theline == NULL)
783 {
784 // Use the start of the function for the line number.
785 SOURCING_LNUM = sourcing_lnum_top;
786 if (skip_until != NULL)
787 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200788 else if (nesting_inline[nesting])
789 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100790 else if (eap->cmdidx == CMD_def)
791 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100792 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000793 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 goto theend;
795 }
796
797 // Detect line continuation: SOURCING_LNUM increased more than one.
798 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
799 if (SOURCING_LNUM < sourcing_lnum_off)
800 sourcing_lnum_off -= SOURCING_LNUM;
801 else
802 sourcing_lnum_off = 0;
803
804 if (skip_until != NULL)
805 {
806 // Don't check for ":endfunc"/":enddef" between
807 // * ":append" and "."
808 // * ":python <<EOF" and "EOF"
809 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
810 if (heredoc_trimmed == NULL
811 || (is_heredoc && skipwhite(theline) == theline)
812 || STRNCMP(theline, heredoc_trimmed,
813 STRLEN(heredoc_trimmed)) == 0)
814 {
815 if (heredoc_trimmed == NULL)
816 p = theline;
817 else if (is_heredoc)
818 p = skipwhite(theline) == theline
819 ? theline : theline + STRLEN(heredoc_trimmed);
820 else
821 p = theline + STRLEN(heredoc_trimmed);
822 if (STRCMP(p, skip_until) == 0)
823 {
824 VIM_CLEAR(skip_until);
825 VIM_CLEAR(heredoc_trimmed);
826 getline_options = vim9_function
827 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
828 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200829
830 if (heredoc_concat_len > 0)
831 {
832 // Replace the starting line with all the concatenated
833 // lines.
834 ga_concat(&heredoc_ga, theline);
835 vim_free(((char_u **)(newlines->ga_data))[
836 heredoc_concat_len - 1]);
837 ((char_u **)(newlines->ga_data))[
838 heredoc_concat_len - 1] = heredoc_ga.ga_data;
839 ga_init(&heredoc_ga);
840 heredoc_concat_len = 0;
841 theline += STRLEN(theline); // skip the "EOF"
842 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100843 }
844 }
845 }
846 else
847 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200848 int c;
849 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000850 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100851
852 // skip ':' and blanks
853 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
854 ;
855
856 // Check for "endfunction", "enddef" or "}".
857 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000858 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200859 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100860 ? *p == '}'
861 : (checkforcmd(&p, nesting_def[nesting]
862 ? "enddef" : "endfunction", 4)
863 && *p != ':'))
864 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000865 if (!nesting_inline[nesting] && nesting_def[nesting]
866 && p < cmd + 6)
867 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 if (nesting-- == 0)
869 {
870 char_u *nextcmd = NULL;
871
872 if (*p == '|' || *p == '}')
873 nextcmd = p + 1;
874 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
875 nextcmd = line_arg;
876 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100877 && (vim9_function || p_verbose > 0))
878 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200879 SOURCING_LNUM = sourcing_lnum_top
880 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100881 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000882 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100883 else
884 give_warning2((char_u *)
885 _("W22: Text found after :endfunction: %s"),
886 p, TRUE);
887 }
888 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100889 {
890 // Another command follows. If the line came from "eap"
891 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000892 // change "eap->cmdlinep" to point to the last fetched
893 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100894 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000895 if (lines_to_free->ga_len > 0
896 && *eap->cmdlinep !=
897 ((char_u **)lines_to_free->ga_data)
898 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100899 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000900 // *cmdlinep will be freed later, thus remove the
901 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100902 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000903 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
904 [lines_to_free->ga_len - 1];
905 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100906 }
907 }
908 break;
909 }
910 }
911
912 // Check for mismatched "endfunc" or "enddef".
913 // We don't check for "def" inside "func" thus we also can't check
914 // for "enddef".
915 // We continue to find the end of the function, although we might
916 // not find it.
917 else if (nesting_def[nesting])
918 {
919 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
920 emsg(_(e_mismatched_endfunction));
921 }
922 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
923 emsg(_(e_mismatched_enddef));
924
925 // Increase indent inside "if", "while", "for" and "try", decrease
926 // at "end".
927 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
928 indent -= 2;
929 else if (STRNCMP(p, "if", 2) == 0
930 || STRNCMP(p, "wh", 2) == 0
931 || STRNCMP(p, "for", 3) == 0
932 || STRNCMP(p, "try", 3) == 0)
933 indent += 2;
934
935 // Check for defining a function inside this function.
936 // Only recognize "def" inside "def", not inside "function",
937 // For backwards compatibility, see Test_function_python().
938 c = *p;
939 if (is_function_cmd(&p)
940 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
941 {
942 if (*p == '!')
943 p = skipwhite(p + 1);
944 p += eval_fname_script(p);
945 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
946 NULL, NULL));
947 if (*skipwhite(p) == '(')
948 {
949 if (nesting == MAX_FUNC_NESTING - 1)
950 emsg(_(e_function_nesting_too_deep));
951 else
952 {
953 ++nesting;
954 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200955 nesting_inline[nesting] = FALSE;
956 indent += 2;
957 }
958 }
959 }
960
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200961 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200962 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200963 // Not a comment line: check for nested inline function.
964 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200965 while (end > p && VIM_ISWHITE(*end))
966 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200967 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200968 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200969 int is_block;
970
971 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200972 --end;
973 while (end > p && VIM_ISWHITE(*end))
974 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200975 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
976 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200977 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200978 char_u *s = p;
979
980 // check for line starting with "au" for :autocmd or
981 // "com" for :command, these can use a {} block
982 is_block = checkforcmd_noparen(&s, "autocmd", 2)
983 || checkforcmd_noparen(&s, "command", 3);
984 }
985
986 if (is_block)
987 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200988 if (nesting == MAX_FUNC_NESTING - 1)
989 emsg(_(e_function_nesting_too_deep));
990 else
991 {
992 ++nesting;
993 nesting_def[nesting] = TRUE;
994 nesting_inline[nesting] = TRUE;
995 indent += 2;
996 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 }
998 }
999 }
1000
1001 // Check for ":append", ":change", ":insert". Not for :def.
1002 p = skip_range(p, FALSE, NULL);
1003 if (!vim9_function
1004 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1005 || (p[0] == 'c'
1006 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1007 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1008 && (STRNCMP(&p[3], "nge", 3) != 0
1009 || !ASCII_ISALPHA(p[6])))))))
1010 || (p[0] == 'i'
1011 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1012 && (!ASCII_ISALPHA(p[2])
1013 || (p[2] == 's'
1014 && (!ASCII_ISALPHA(p[3])
1015 || p[3] == 'e'))))))))
1016 skip_until = vim_strsave((char_u *)".");
1017
1018 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1019 arg = skipwhite(skiptowhite(p));
1020 if (arg[0] == '<' && arg[1] =='<'
1021 && ((p[0] == 'p' && p[1] == 'y'
1022 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1023 || ((p[2] == '3' || p[2] == 'x')
1024 && !ASCII_ISALPHA(p[3]))))
1025 || (p[0] == 'p' && p[1] == 'e'
1026 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1027 || (p[0] == 't' && p[1] == 'c'
1028 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1029 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1030 && !ASCII_ISALPHA(p[3]))
1031 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1032 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1033 || (p[0] == 'm' && p[1] == 'z'
1034 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1035 ))
1036 {
1037 // ":python <<" continues until a dot, like ":append"
1038 p = skipwhite(arg + 2);
1039 if (STRNCMP(p, "trim", 4) == 0)
1040 {
1041 // Ignore leading white space.
1042 p = skipwhite(p + 4);
1043 heredoc_trimmed = vim_strnsave(theline,
1044 skipwhite(theline) - theline);
1045 }
1046 if (*p == NUL)
1047 skip_until = vim_strsave((char_u *)".");
1048 else
1049 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1050 getline_options = GETLINE_NONE;
1051 is_heredoc = TRUE;
Bram Moolenaard881d152022-05-13 13:50:36 +01001052 if (eap->cmdidx == CMD_def && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001053 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001054 }
1055
Bram Moolenaard881d152022-05-13 13:50:36 +01001056 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001057 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001058 // Check for ":cmd v =<< [trim] EOF"
1059 // and ":cmd [a, b] =<< [trim] EOF"
1060 // and "lines =<< [trim] EOF" for Vim9
1061 // Where "cmd" can be "let", "var", "final" or "const".
1062 arg = skipwhite(skiptowhite(p));
1063 if (*arg == '[')
1064 arg = vim_strchr(arg, ']');
1065 if (arg != NULL)
1066 {
1067 int found = (eap->cmdidx == CMD_def && arg[0] == '='
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001068 && arg[1] == '<' && arg[2] =='<');
1069
Bram Moolenaard881d152022-05-13 13:50:36 +01001070 if (!found)
1071 // skip over the argument after "cmd"
1072 arg = skipwhite(skiptowhite(arg));
1073 if (found || (arg[0] == '=' && arg[1] == '<'
1074 && arg[2] =='<'
1075 && (checkforcmd(&p, "let", 2)
1076 || checkforcmd(&p, "var", 3)
1077 || checkforcmd(&p, "final", 5)
1078 || checkforcmd(&p, "const", 5))))
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001079 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001080 p = skipwhite(arg + 3);
1081 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001082 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001083 if (STRNCMP(p, "trim", 4) == 0)
1084 {
1085 // Ignore leading white space.
1086 p = skipwhite(p + 4);
1087 heredoc_trimmed = vim_strnsave(theline,
1088 skipwhite(theline) - theline);
1089 continue;
1090 }
1091 if (STRNCMP(p, "eval", 4) == 0)
1092 {
1093 // Ignore leading white space.
1094 p = skipwhite(p + 4);
1095 continue;
1096 }
1097 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001098 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001099 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1100 getline_options = GETLINE_NONE;
1101 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001102 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001103 }
1104 }
1105 }
1106
1107 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001108 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001109 goto theend;
1110
Bram Moolenaar20677332021-06-06 17:02:53 +02001111 if (heredoc_concat_len > 0)
1112 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001113 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001114 // to be used for the instruction later.
1115 ga_concat(&heredoc_ga, theline);
1116 ga_concat(&heredoc_ga, (char_u *)"\n");
1117 p = vim_strsave((char_u *)"");
1118 }
1119 else
1120 {
1121 // Copy the line to newly allocated memory. get_one_sourceline()
1122 // allocates 250 bytes per line, this saves 80% on average. The
1123 // cost is an extra alloc/free.
1124 p = vim_strsave(theline);
1125 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001126 if (p == NULL)
1127 goto theend;
1128 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1129
1130 // Add NULL lines for continuation lines, so that the line count is
1131 // equal to the index in the growarray.
1132 while (sourcing_lnum_off-- > 0)
1133 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1134
1135 // Check for end of eap->arg.
1136 if (line_arg != NULL && *line_arg == NUL)
1137 line_arg = NULL;
1138 }
1139
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001140 // Return OK when no error was detected.
1141 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 ret = OK;
1143
1144theend:
1145 vim_free(skip_until);
1146 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001147 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001148 need_wait_return |= saved_wait_return;
1149 return ret;
1150}
1151
1152/*
1153 * Handle the body of a lambda. *arg points to the "{", process statements
1154 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001155 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001156 * When successful "rettv" is set to a funcref.
1157 */
1158 static int
1159lambda_function_body(
1160 char_u **arg,
1161 typval_T *rettv,
1162 evalarg_T *evalarg,
1163 garray_T *newargs,
1164 garray_T *argtypes,
1165 int varargs,
1166 garray_T *default_args,
1167 char_u *ret_type)
1168{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001169 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001170 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001171 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001172 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001173 exarg_T eap;
1174 garray_T newlines;
1175 char_u *cmdline = NULL;
1176 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001177 partial_T *pt;
1178 char_u *name;
1179 int lnum_save = -1;
1180 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1181
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001182 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1183 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001184 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001185 return FAIL;
1186 }
1187
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001188 CLEAR_FIELD(eap);
1189 eap.cmdidx = CMD_block;
1190 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001191 eap.cmdlinep = &cmdline;
1192 eap.skip = !evaluate;
1193 if (evalarg->eval_cctx != NULL)
1194 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1195 else
1196 {
1197 eap.getline = evalarg->eval_getline;
1198 eap.cookie = evalarg->eval_cookie;
1199 }
1200
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001201 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001202 if (get_function_body(&eap, &newlines, NULL,
1203 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001204 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001205
1206 // When inside a lambda must add the function lines to evalarg.eval_ga.
1207 evalarg->eval_break_count += newlines.ga_len;
1208 if (gap->ga_itemsize > 0)
1209 {
1210 int idx;
1211 char_u *last;
1212 size_t plen;
1213 char_u *pnl;
1214
1215 for (idx = 0; idx < newlines.ga_len; ++idx)
1216 {
1217 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1218
Bram Moolenaarecb66452021-05-18 15:09:18 +02001219 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001220 goto erret;
1221
1222 // Going to concatenate the lines after parsing. For an empty or
1223 // comment line use an empty string.
1224 // Insert NL characters at the start of each line, the string will
1225 // be split again later in .get_lambda_tv().
1226 if (*p == NUL || vim9_comment_start(p))
1227 p = (char_u *)"";
1228 plen = STRLEN(p);
1229 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1230 if (pnl != NULL)
1231 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001232 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1233 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001234 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001235 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001237 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001238 // more is following after the "}", which was skipped
1239 last = cmdline;
1240 else
1241 // nothing is following the "}"
1242 last = (char_u *)"}";
1243 plen = STRLEN(last);
1244 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1245 if (pnl != NULL)
1246 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001247 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1248 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001249 }
1250
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001251 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001252 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001253 garray_T *tfgap = &evalarg->eval_tofree_ga;
1254
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001255 // Something comes after the "}".
1256 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001257
1258 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001259 if (ga_grow(tfgap, 1) == OK)
1260 {
1261 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1262 evalarg->eval_using_cmdline = TRUE;
1263 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001264 }
1265 else
1266 *arg = (char_u *)"";
1267
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001268 if (!evaluate)
1269 {
1270 ret = OK;
1271 goto erret;
1272 }
1273
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001274 name = get_lambda_name();
1275 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1276 if (ufunc == NULL)
1277 goto erret;
1278 set_ufunc_name(ufunc, name);
1279 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001280 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001281 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 ufunc->uf_refcount = 1;
1283 ufunc->uf_args = *newargs;
1284 newargs->ga_data = NULL;
1285 ufunc->uf_def_args = *default_args;
1286 default_args->ga_data = NULL;
1287 ufunc->uf_func_type = &t_func_any;
1288
1289 // error messages are for the first function line
1290 lnum_save = SOURCING_LNUM;
1291 SOURCING_LNUM = sourcing_lnum_top;
1292
1293 // parse argument types
1294 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1295 {
1296 SOURCING_LNUM = lnum_save;
1297 goto erret;
1298 }
1299
1300 // parse the return type, if any
1301 if (parse_return_type(ufunc, ret_type) == FAIL)
1302 goto erret;
1303
1304 pt = ALLOC_CLEAR_ONE(partial_T);
1305 if (pt == NULL)
1306 goto erret;
1307 pt->pt_func = ufunc;
1308 pt->pt_refcount = 1;
1309
1310 ufunc->uf_lines = newlines;
1311 newlines.ga_data = NULL;
1312 if (sandbox)
1313 ufunc->uf_flags |= FC_SANDBOX;
1314 if (!ASCII_ISUPPER(*ufunc->uf_name))
1315 ufunc->uf_flags |= FC_VIM9;
1316 ufunc->uf_script_ctx = current_sctx;
1317 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1318 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1319 set_function_type(ufunc);
1320
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001321 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1322
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001323 rettv->vval.v_partial = pt;
1324 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001325 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001326 ret = OK;
1327
1328erret:
1329 if (lnum_save >= 0)
1330 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001331 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001332 if (newargs != NULL)
1333 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001334 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001335 if (ufunc != NULL)
1336 {
1337 func_clear(ufunc, TRUE);
1338 func_free(ufunc, TRUE);
1339 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001340 return ret;
1341}
1342
1343/*
1344 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001345 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001346 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1348 */
1349 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001350get_lambda_tv(
1351 char_u **arg,
1352 typval_T *rettv,
1353 int types_optional,
1354 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001355{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001356 int evaluate = evalarg != NULL
1357 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001358 garray_T newargs;
1359 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001360 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001361 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001362 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001364 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001366 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001368 char_u *s;
1369 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001370 int *old_eval_lavars = eval_lavars_used;
1371 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001372 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001373 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001374 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001375 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001376 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001377 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001378
Bram Moolenaar4525a572022-02-13 11:57:33 +00001379 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001381
1382 ga_init(&newargs);
1383 ga_init(&newlines);
1384
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001385 // First, check if this is really a lambda expression. "->" or "=>" must
1386 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001387 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001388 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001389 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001390 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001391 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001392 {
1393 if (types_optional)
1394 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001395 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001396 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001397
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001398 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001399 if (evaluate)
1400 pnewargs = &newargs;
1401 else
1402 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001403 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001404 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001405 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001406 &varargs, &default_args,
1407 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001408 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001409 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001410 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001411 {
1412 if (types_optional)
1413 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001414 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001415 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001416 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001417 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001419 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1420 if (ret_type != NULL)
1421 {
1422 ret_type = vim_strsave(ret_type);
1423 tofree2 = ret_type;
1424 }
1425
Bram Moolenaare38eab22019-12-05 21:50:01 +01001426 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001427 if (evaluate)
1428 eval_lavars_used = &eval_lavars;
1429
Bram Moolenaar65c44152020-12-24 15:14:01 +01001430 *arg = skipwhite_and_linebreak(*arg, evalarg);
1431
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001432 // Recognize "{" as the start of a function body.
1433 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001434 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001435 if (evalarg == NULL)
1436 // cannot happen?
1437 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001438 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001439 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1440 types_optional ? &argtypes : NULL, varargs,
1441 &default_args, ret_type) == FAIL)
1442 goto errret;
1443 goto theend;
1444 }
1445 if (default_args.ga_len > 0)
1446 {
1447 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001448 goto errret;
1449 }
1450
Bram Moolenaare38eab22019-12-05 21:50:01 +01001451 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001452 start = *arg;
1453 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454 if (ret == FAIL)
1455 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001456
Bram Moolenaar65c44152020-12-24 15:14:01 +01001457 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001458 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001459 *arg = skipwhite_and_linebreak(*arg, evalarg);
1460 if (**arg != '}')
1461 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001462 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001463 goto errret;
1464 }
1465 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001467
1468 if (evaluate)
1469 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001470 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001471 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001472 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001473 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001474 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001475
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001476 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477 if (fp == NULL)
1478 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001479 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001480 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001481 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001482 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001484 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485 if (ga_grow(&newlines, 1) == FAIL)
1486 goto errret;
1487
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001488 // If there are line breaks, we need to split up the string.
1489 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001490 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001491 line_end = end;
1492
1493 // Add "return " before the expression (or the first line).
1494 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001495 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496 if (p == NULL)
1497 goto errret;
1498 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1499 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001500 vim_strncpy(p + 7, start, line_end - start);
1501
1502 if (line_end != end)
1503 {
1504 // Add more lines, split by line breaks. Thus is used when a
1505 // lambda with { cmds } is encountered.
1506 while (*line_end == '\n')
1507 {
1508 if (ga_grow(&newlines, 1) == FAIL)
1509 goto errret;
1510 start = line_end + 1;
1511 line_end = vim_strchr(start, '\n');
1512 if (line_end == NULL)
1513 line_end = end;
1514 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1515 vim_strnsave(start, line_end - start);
1516 }
1517 }
1518
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001519 if (strstr((char *)p + 7, "a:") == NULL)
1520 // No a: variables are used for sure.
1521 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522
1523 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001524 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001526 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001527 if (types_optional)
1528 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001529 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001530 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001531 goto errret;
1532 if (ret_type != NULL)
1533 {
1534 fp->uf_ret_type = parse_type(&ret_type,
1535 &fp->uf_type_list, TRUE);
1536 if (fp->uf_ret_type == NULL)
1537 goto errret;
1538 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001539 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001540 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001541 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001542
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001544 if (current_funccal != NULL && eval_lavars)
1545 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001546 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001547 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001548 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001549 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001550
1551#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 if (prof_def_func())
1553 func_do_profile(fp);
1554#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001555 if (sandbox)
1556 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001557 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001558 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001559 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001560 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001562 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001563 // Use the line number of the arguments.
1564 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001566 function_using_block_scopes(fp, evalarg->eval_cstack);
1567
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001568 pt->pt_func = fp;
1569 pt->pt_refcount = 1;
1570 rettv->vval.v_partial = pt;
1571 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001572
1573 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001576theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001577 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001578 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001579 if (types_optional)
1580 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 return OK;
1583
1584errret:
1585 ga_clear_strings(&newargs);
1586 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001587 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001588 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001589 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001590 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001591 if (fp != NULL)
1592 vim_free(fp->uf_arg_types);
1593 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001595 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001596 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001597 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 return FAIL;
1599}
1600
1601/*
1602 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1603 * name it contains, otherwise return "name".
1604 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1605 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001606 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1607 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001608 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001609 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610 */
1611 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001612deref_func_name(
1613 char_u *name,
1614 int *lenp,
1615 partial_T **partialp,
1616 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001617 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001618 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001619 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620{
1621 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001622 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001624 char_u *s = NULL;
1625 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001626 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627
1628 if (partialp != NULL)
1629 *partialp = NULL;
1630
1631 cc = name[*lenp];
1632 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001633
Bram Moolenaar71f21932022-01-07 18:20:55 +00001634 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001638 tv = &v->di_tv;
1639 }
1640 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1641 {
1642 imported_T *import;
1643 char_u *p = name;
1644 int len = *lenp;
1645
1646 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001648 p = name + 2;
1649 len -= 2;
1650 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001651 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001652
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001653 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001654 if (import != NULL)
1655 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001656 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001657 if (new_function)
1658 semsg(_(e_redefining_imported_item_str), name);
1659 else
1660 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001661 name[len] = cc;
1662 *lenp = 0;
1663 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001664 }
1665 }
1666
1667 if (tv != NULL)
1668 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001669 if (found_var != NULL)
1670 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001671 if (tv->v_type == VAR_FUNC)
1672 {
1673 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001674 {
1675 *lenp = 0;
1676 return (char_u *)""; // just in case
1677 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001678 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001679 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001682 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001684 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001685
1686 if (pt == NULL)
1687 {
1688 *lenp = 0;
1689 return (char_u *)""; // just in case
1690 }
1691 if (partialp != NULL)
1692 *partialp = pt;
1693 s = partial_name(pt);
1694 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001695 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001696
1697 if (s != NULL)
1698 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001699 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001700 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001701 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001702
1703 if (sv != NULL)
1704 *type = sv->sv_type;
1705 }
1706 return s;
1707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 }
1709
1710 return name;
1711}
1712
1713/*
1714 * Give an error message with a function name. Handle <SNR> things.
1715 * "ermsg" is to be passed without translation, use N_() instead of _().
1716 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001717 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718emsg_funcname(char *ermsg, char_u *name)
1719{
Bram Moolenaar54598062022-01-13 12:05:09 +00001720 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721
Bram Moolenaar54598062022-01-13 12:05:09 +00001722 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001724 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 if (p != name)
1726 vim_free(p);
1727}
1728
1729/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001730 * Get function arguments at "*arg" and advance it.
1731 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001732 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 */
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001734 static int
1735get_func_arguments(
1736 char_u **arg,
1737 evalarg_T *evalarg,
1738 int partial_argc,
1739 typval_T *argvars,
1740 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001742 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001744 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001745 int evaluate = evalarg == NULL
1746 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001747
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001748 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001750 // skip the '(' or ',' and possibly line breaks
1751 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1752
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753 if (*argp == ')' || *argp == ',' || *argp == NUL)
1754 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001755 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001756 {
1757 ret = FAIL;
1758 break;
1759 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001760 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001761 // The comma should come right after the argument, but this wasn't
1762 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001763 if (vim9script)
1764 {
1765 if (*argp != ',' && *skipwhite(argp) == ',')
1766 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001767 if (evaluate)
1768 semsg(_(e_no_white_space_allowed_before_str_str),
1769 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001770 ret = FAIL;
1771 break;
1772 }
1773 }
1774 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001775 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 if (*argp != ',')
1777 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001778 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1779 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001780 if (evaluate)
1781 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001782 ret = FAIL;
1783 break;
1784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001786
Bram Moolenaare6b53242020-07-01 17:28:33 +02001787 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 if (*argp == ')')
1789 ++argp;
1790 else
1791 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001792 *arg = argp;
1793 return ret;
1794}
1795
1796/*
1797 * Call a function and put the result in "rettv".
1798 * Return OK or FAIL.
1799 */
1800 int
1801get_func_tv(
1802 char_u *name, // name of the function
1803 int len, // length of "name" or -1 to use strlen()
1804 typval_T *rettv,
1805 char_u **arg, // argument, pointing to the '('
1806 evalarg_T *evalarg, // for line continuation
1807 funcexe_T *funcexe) // various values
1808{
1809 char_u *argp;
1810 int ret = OK;
1811 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1812 int argcount = 0; // number of arguments found
1813 int vim9script = in_vim9script();
1814 int evaluate = evalarg == NULL
1815 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1816
1817 argp = *arg;
1818 ret = get_func_arguments(&argp, evalarg,
1819 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1820 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821
1822 if (ret == OK)
1823 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001824 int i = 0;
1825 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826
1827 if (get_vim_var_nr(VV_TESTING))
1828 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001829 // Prepare for calling test_garbagecollect_now(), need to know
1830 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001832 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 for (i = 0; i < argcount; ++i)
1834 if (ga_grow(&funcargs, 1) == OK)
1835 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1836 &argvars[i];
1837 }
1838
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001839 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001840 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001841 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001842 // An error in a builtin function does not return FAIL, but we do
1843 // want to abort further processing if an error was given.
1844 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001845 clear_tv(rettv);
1846 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001847
1848 funcargs.ga_len -= i;
1849 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001850 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 {
1852 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001853 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001855 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 }
1857
1858 while (--argcount >= 0)
1859 clear_tv(&argvars[argcount]);
1860
Bram Moolenaar4525a572022-02-13 11:57:33 +00001861 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001862 *arg = argp;
1863 else
1864 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001865 return ret;
1866}
1867
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868/*
1869 * Return TRUE if "p" starts with "<SID>" or "s:".
1870 * Only works if eval_fname_script() returned non-zero for "p"!
1871 */
1872 static int
1873eval_fname_sid(char_u *p)
1874{
1875 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1876}
1877
1878/*
1879 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1880 * Change <SNR>123_name() to K_SNR 123_name().
1881 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1882 * (slow).
1883 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001884 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1886{
1887 int llen;
1888 char_u *fname;
1889 int i;
1890
1891 llen = eval_fname_script(name);
1892 if (llen > 0)
1893 {
1894 fname_buf[0] = K_SPECIAL;
1895 fname_buf[1] = KS_EXTRA;
1896 fname_buf[2] = (int)KE_SNR;
1897 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001898 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001899 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001900 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001901 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902 else
1903 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001904 sprintf((char *)fname_buf + 3, "%ld_",
1905 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906 i = (int)STRLEN(fname_buf);
1907 }
1908 }
1909 if (i + STRLEN(name + llen) < FLEN_FIXED)
1910 {
1911 STRCPY(fname_buf + i, name + llen);
1912 fname = fname_buf;
1913 }
1914 else
1915 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001916 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001918 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 else
1920 {
1921 *tofree = fname;
1922 mch_memmove(fname, fname_buf, (size_t)i);
1923 STRCPY(fname + i, name + llen);
1924 }
1925 }
1926 }
1927 else
1928 fname = name;
1929 return fname;
1930}
1931
1932/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001933 * Concatenate the script ID and function name into "<SNR>99_name".
1934 * "buffer" must have size MAX_FUNC_NAME_LEN.
1935 */
1936 void
1937func_name_with_sid(char_u *name, int sid, char_u *buffer)
1938{
1939 // A script-local function is stored as "<SNR>99_name".
1940 buffer[0] = K_SPECIAL;
1941 buffer[1] = KS_EXTRA;
1942 buffer[2] = (int)KE_SNR;
1943 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1944 (long)sid, name);
1945}
1946
1947/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948 * Find a function "name" in script "sid".
1949 */
1950 static ufunc_T *
1951find_func_with_sid(char_u *name, int sid)
1952{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001953 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001954 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955
Bram Moolenaarb8822442022-01-11 15:24:05 +00001956 if (!SCRIPT_ID_VALID(sid))
1957 return NULL; // not in a script
1958
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001959 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 hi = hash_find(&func_hashtab, buffer);
1961 if (!HASHITEM_EMPTY(hi))
1962 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001963 return NULL;
1964}
1965
1966/*
1967 * Find a function "name" in script "sid" prefixing the autoload prefix.
1968 */
1969 static ufunc_T *
1970find_func_with_prefix(char_u *name, int sid)
1971{
1972 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001973 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001974 scriptitem_T *si;
1975
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001976 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001977 return NULL; // already has the prefix
1978 if (!SCRIPT_ID_VALID(sid))
1979 return NULL; // not in a script
1980 si = SCRIPT_ITEM(sid);
1981 if (si->sn_autoload_prefix != NULL)
1982 {
1983 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1984 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001985 char_u *namep;
1986
1987 // skip a "<SNR>99_" prefix
1988 namep = untrans_function_name(name);
1989 if (namep == NULL)
1990 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001991
1992 // An exported function in an autoload script is stored as
1993 // "dir#path#name".
1994 if (len < sizeof(buffer))
1995 auto_name = buffer;
1996 else
1997 auto_name = alloc(len);
1998 if (auto_name != NULL)
1999 {
2000 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002001 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002002 hi = hash_find(&func_hashtab, auto_name);
2003 if (auto_name != buffer)
2004 vim_free(auto_name);
2005 if (!HASHITEM_EMPTY(hi))
2006 return HI2UF(hi);
2007 }
2008 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009
2010 return NULL;
2011}
2012
2013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002015 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2016 * functions.
2017 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002018 * Return NULL for unknown function.
2019 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002020 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002021find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002022{
2023 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002025
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002026 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002028 // Find script-local function before global one.
2029 if (in_vim9script() && eval_isnamec1(*name)
2030 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002032 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2033 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002034 if (func != NULL)
2035 return func;
2036 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002037 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2038 {
2039 char_u *p = name + 5;
2040 long sid;
2041
2042 // printable "<SNR>123_Name" form
2043 sid = getdigits(&p);
2044 if (*p == '_')
2045 {
2046 func = find_func_with_sid(p + 1, (int)sid);
2047 if (func != NULL)
2048 return func;
2049 }
2050 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002052
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002053 if ((flags & FFED_NO_GLOBAL) == 0)
2054 {
2055 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002056 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002057 if (!HASHITEM_EMPTY(hi))
2058 return HI2UF(hi);
2059 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002060
Bram Moolenaarb8822442022-01-11 15:24:05 +00002061 // Find autoload function if this is an autoload script.
2062 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2063 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002064}
2065
2066/*
2067 * Find a function by name, return pointer to it in ufuncs.
2068 * "cctx" is passed in a :def function to find imported functions.
2069 * Return NULL for unknown or dead function.
2070 */
2071 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002072find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002073{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002074 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002075
2076 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2077 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 return NULL;
2079}
2080
2081/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002082 * Return TRUE if "ufunc" is a global function.
2083 */
2084 int
2085func_is_global(ufunc_T *ufunc)
2086{
2087 return ufunc->uf_name[0] != K_SPECIAL;
2088}
2089
2090/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002091 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2092 */
2093 int
2094func_requires_g_prefix(ufunc_T *ufunc)
2095{
2096 return ufunc->uf_name[0] != K_SPECIAL
2097 && (ufunc->uf_flags & FC_LAMBDA) == 0
2098 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2099}
2100
2101/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102 * Copy the function name of "fp" to buffer "buf".
2103 * "buf" must be able to hold the function name plus three bytes.
2104 * Takes care of script-local function names.
2105 */
2106 static void
2107cat_func_name(char_u *buf, ufunc_T *fp)
2108{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002109 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 {
2111 STRCPY(buf, "<SNR>");
2112 STRCAT(buf, fp->uf_name + 3);
2113 }
2114 else
2115 STRCPY(buf, fp->uf_name);
2116}
2117
2118/*
2119 * Add a number variable "name" to dict "dp" with value "nr".
2120 */
2121 static void
2122add_nr_var(
2123 dict_T *dp,
2124 dictitem_T *v,
2125 char *name,
2126 varnumber_T nr)
2127{
2128 STRCPY(v->di_key, name);
2129 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2130 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2131 v->di_tv.v_type = VAR_NUMBER;
2132 v->di_tv.v_lock = VAR_FIXED;
2133 v->di_tv.vval.v_number = nr;
2134}
2135
2136/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002137 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002138 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002139 static void
2140free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002143
Bram Moolenaarca16c602022-09-06 18:57:08 +01002144 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002145 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002146 ufunc_T *fp = ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002147
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002148 // When garbage collecting a funccall_T may be freed before the
2149 // function that references it, clear its uf_scoped field.
2150 // The function may have been redefined and point to another
2151 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002152 if (fp != NULL && fp->uf_scoped == fc)
2153 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002154 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002155 ga_clear(&fc->fc_ufuncs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156
Bram Moolenaarca16c602022-09-06 18:57:08 +01002157 func_ptr_unref(fc->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002158 vim_free(fc);
2159}
2160
2161/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002162 * Free "fc" and what it contains.
2163 * Can be called only when "fc" is kept beyond the period of it called,
2164 * i.e. after cleanup_function_call(fc).
2165 */
2166 static void
2167free_funccal_contents(funccall_T *fc)
2168{
2169 listitem_T *li;
2170
2171 // Free all l: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002172 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002173
2174 // Free all a: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002175 vars_clear(&fc->fc_l_avars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002176
2177 // Free the a:000 variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002178 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002179 clear_tv(&li->li_tv);
2180
2181 free_funccal(fc);
2182}
2183
2184/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002185 * Handle the last part of returning from a function: free the local hashtable.
2186 * Unless it is still in use by a closure.
2187 */
2188 static void
2189cleanup_function_call(funccall_T *fc)
2190{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002191 int may_free_fc = fc->fc_refcount <= 0;
2192 int free_fc = TRUE;
2193
Bram Moolenaarca16c602022-09-06 18:57:08 +01002194 current_funccal = fc->fc_caller;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002195
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002196 // Free all l: variables if not referred.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002197 if (may_free_fc && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT)
2198 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002199 else
2200 free_fc = FALSE;
2201
2202 // If the a:000 list and the l: and a: dicts are not referenced and
2203 // there is no closure using it, we can free the funccall_T and what's
2204 // in it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002205 if (may_free_fc && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)
2206 vars_clear_ext(&fc->fc_l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002207 else
2208 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002209 int todo;
2210 hashitem_T *hi;
2211 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002212
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002213 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002214
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002215 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002216 todo = (int)fc->fc_l_avars.dv_hashtab.ht_used;
2217 for (hi = fc->fc_l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002218 {
2219 if (!HASHITEM_EMPTY(hi))
2220 {
2221 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002222 di = HI2DI(hi);
2223 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002224 }
2225 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002226 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002227
Bram Moolenaarca16c602022-09-06 18:57:08 +01002228 if (may_free_fc && fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2229 fc->fc_l_varlist.lv_first = NULL;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002230 else
2231 {
2232 listitem_T *li;
2233
2234 free_fc = FALSE;
2235
2236 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002237 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002238 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002239 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002240
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002241 if (free_fc)
2242 free_funccal(fc);
2243 else
2244 {
2245 static int made_copy = 0;
2246
2247 // "fc" is still in use. This can happen when returning "a:000",
2248 // assigning "l:" to a global variable or defining a closure.
2249 // Link "fc" in the list for garbage collection later.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002250 fc->fc_caller = previous_funccal;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002251 previous_funccal = fc;
2252
2253 if (want_garbage_collect)
2254 // If garbage collector is ready, clear count.
2255 made_copy = 0;
2256 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002257 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002258 // We have made a lot of copies, worth 4 Mbyte. This can happen
2259 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002260 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002261 // too much memory.
2262 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002263 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002264 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002265 }
2266}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002267
2268/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002269 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2270 */
2271 static int
2272numbered_function(char_u *name)
2273{
2274 return isdigit(*name)
2275 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2276}
2277
2278/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002279 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002280 * 1. ordinary names, function defined with :function or :def;
2281 * can start with "<SNR>123_" literally or with K_SPECIAL.
2282 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002283 * For the first we only count the name stored in func_hashtab as a reference,
2284 * using function() does not count as a reference, because the function is
2285 * looked up by name.
2286 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002287 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002288func_name_refcount(char_u *name)
2289{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002290 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002291}
2292
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293/*
2294 * Unreference "fc": decrement the reference count and free it when it
2295 * becomes zero. "fp" is detached from "fc".
2296 * When "force" is TRUE we are exiting.
2297 */
2298 static void
2299funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2300{
2301 funccall_T **pfc;
2302 int i;
2303
2304 if (fc == NULL)
2305 return;
2306
2307 if (--fc->fc_refcount <= 0 && (force || (
Bram Moolenaarca16c602022-09-06 18:57:08 +01002308 fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT
2309 && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT
2310 && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2311 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->fc_caller)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002312 {
2313 if (fc == *pfc)
2314 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002315 *pfc = fc->fc_caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002316 free_funccal_contents(fc);
2317 return;
2318 }
2319 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002320 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
2321 if (((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] == fp)
2322 ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323}
2324
2325/*
2326 * Remove the function from the function hashtable. If the function was
2327 * deleted while it still has references this was already done.
2328 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2329 */
2330 static int
2331func_remove(ufunc_T *fp)
2332{
2333 hashitem_T *hi;
2334
2335 // Return if it was already virtually deleted.
2336 if (fp->uf_flags & FC_DEAD)
2337 return FALSE;
2338
2339 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2340 if (!HASHITEM_EMPTY(hi))
2341 {
2342 // When there is a def-function index do not actually remove the
2343 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002344 // Do remove it when it's a copy.
2345 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002346 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002347 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002348 return FALSE;
2349 }
2350 hash_remove(&func_hashtab, hi);
2351 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002352 return TRUE;
2353 }
2354 return FALSE;
2355}
2356
2357 static void
2358func_clear_items(ufunc_T *fp)
2359{
2360 ga_clear_strings(&(fp->uf_args));
2361 ga_clear_strings(&(fp->uf_def_args));
2362 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002363 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002364 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002365 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002366 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002367
2368 // Increment the refcount of this function to avoid it being freed
2369 // recursively when the partial is freed.
2370 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002371 partial_unref(fp->uf_partial);
2372 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002373 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002374
2375#ifdef FEAT_LUA
2376 if (fp->uf_cb_free != NULL)
2377 {
2378 fp->uf_cb_free(fp->uf_cb_state);
2379 fp->uf_cb_free = NULL;
2380 }
2381
2382 fp->uf_cb_state = NULL;
2383 fp->uf_cb = NULL;
2384#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002385#ifdef FEAT_PROFILE
2386 VIM_CLEAR(fp->uf_tml_count);
2387 VIM_CLEAR(fp->uf_tml_total);
2388 VIM_CLEAR(fp->uf_tml_self);
2389#endif
2390}
2391
2392/*
2393 * Free all things that a function contains. Does not free the function
2394 * itself, use func_free() for that.
2395 * When "force" is TRUE we are exiting.
2396 */
2397 static void
2398func_clear(ufunc_T *fp, int force)
2399{
2400 if (fp->uf_cleared)
2401 return;
2402 fp->uf_cleared = TRUE;
2403
2404 // clear this function
2405 func_clear_items(fp);
2406 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002407 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002408}
2409
2410/*
2411 * Free a function and remove it from the list of functions. Does not free
2412 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002413 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002414 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002415 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002416 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002417func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002418{
2419 // Only remove it when not done already, otherwise we would remove a newer
2420 // version of the function with the same name.
2421 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2422 func_remove(fp);
2423
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002424 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002425 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002426 if (fp->uf_dfunc_idx > 0)
2427 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002428 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002429 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002430 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002431 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002432 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002433}
2434
2435/*
2436 * Free all things that a function contains and free the function itself.
2437 * When "force" is TRUE we are exiting.
2438 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002439 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002440func_clear_free(ufunc_T *fp, int force)
2441{
2442 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002443 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2444 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002445 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002446 else
2447 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002448}
2449
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002450/*
2451 * Copy already defined function "lambda" to a new function with name "global".
2452 * This is for when a compiled function defines a global function.
2453 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002454 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002455copy_lambda_to_global_func(
2456 char_u *lambda,
2457 char_u *global,
2458 short loop_var_idx,
2459 short loop_var_count,
2460 ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002461{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002462 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002463 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002464
2465 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002466 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002467 semsg(_(e_lambda_function_not_found_str), lambda);
2468 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002469 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002470
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002471 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002472 if (fp != NULL)
2473 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002474 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002475 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002476 return FAIL;
2477 }
2478
2479 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2480 if (fp == NULL)
2481 return FAIL;
2482
2483 fp->uf_varargs = ufunc->uf_varargs;
2484 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2485 fp->uf_def_status = ufunc->uf_def_status;
2486 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2487 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2488 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2489 == FAIL
2490 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2491 goto failed;
2492
2493 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2494 : vim_strsave(ufunc->uf_name_exp);
2495 if (ufunc->uf_arg_types != NULL)
2496 {
2497 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2498 if (fp->uf_arg_types == NULL)
2499 goto failed;
2500 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2501 sizeof(type_T *) * fp->uf_args.ga_len);
2502 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002503 if (ufunc->uf_va_name != NULL)
2504 {
2505 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2506 if (fp->uf_va_name == NULL)
2507 goto failed;
2508 }
2509 fp->uf_ret_type = ufunc->uf_ret_type;
2510
2511 fp->uf_refcount = 1;
2512 STRCPY(fp->uf_name, global);
2513 hash_add(&func_hashtab, UF2HIKEY(fp));
2514
2515 // the referenced dfunc_T is now used one more time
2516 link_def_function(fp);
2517
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002518 // Create a partial to store the context of the function where it was
2519 // instantiated. Only needs to be done once. Do this on the original
2520 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002521 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2522 {
2523 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2524
2525 if (pt == NULL)
2526 goto failed;
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002527 if (fill_partial_and_closure(pt, ufunc, loop_var_idx, loop_var_count,
2528 ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002529 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002530 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002531 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002532 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002533 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002534 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002535 }
2536
2537 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002538
2539failed:
2540 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002541 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002542}
2543
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002544static int funcdepth = 0;
2545
2546/*
2547 * Increment the function call depth count.
2548 * Return FAIL when going over 'maxfuncdepth'.
2549 * Otherwise return OK, must call funcdepth_decrement() later!
2550 */
2551 int
2552funcdepth_increment(void)
2553{
2554 if (funcdepth >= p_mfd)
2555 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002556 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002557 return FAIL;
2558 }
2559 ++funcdepth;
2560 return OK;
2561}
2562
2563 void
2564funcdepth_decrement(void)
2565{
2566 --funcdepth;
2567}
2568
2569/*
2570 * Get the current function call depth.
2571 */
2572 int
2573funcdepth_get(void)
2574{
2575 return funcdepth;
2576}
2577
2578/*
2579 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002580 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002581 * times as funcdepth_increment().
2582 */
2583 void
2584funcdepth_restore(int depth)
2585{
2586 funcdepth = depth;
2587}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002588
2589/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002590 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2591 * "rettv".
2592 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2593 * Returns NULL when allocation fails.
2594 */
2595 funccall_T *
2596create_funccal(ufunc_T *fp, typval_T *rettv)
2597{
2598 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2599
2600 if (fc == NULL)
2601 return NULL;
2602 fc->fc_caller = current_funccal;
2603 current_funccal = fc;
2604 fc->fc_func = fp;
2605 func_ptr_ref(fp);
2606 fc->fc_rettv = rettv;
2607 return fc;
2608}
2609
2610/*
2611 * To be called when returning from a compiled function; restores
2612 * current_funccal.
2613 */
2614 void
2615remove_funccal()
2616{
2617 funccall_T *fc = current_funccal;
2618
2619 current_funccal = fc->fc_caller;
2620 free_funccal(fc);
2621}
2622
2623/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002624 * Call a user function.
2625 */
2626 static void
2627call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002628 ufunc_T *fp, // pointer to function
2629 int argcount, // nr of args
2630 typval_T *argvars, // arguments
2631 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002632 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002633 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002635 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002636 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002637 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002638 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 funccall_T *fc;
2640 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002641 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 dictitem_T *v;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002643 int fixvar_idx = 0; // index in fc_fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 int i;
2645 int ai;
2646 int islambda = FALSE;
2647 char_u numbuf[NUMBUFLEN];
2648 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002649 typval_T *tv_to_free[MAX_FUNC_ARGS];
2650 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002652 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002654 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655
Bram Moolenaarb2049902021-01-24 12:53:53 +01002656#ifdef FEAT_PROFILE
2657 CLEAR_FIELD(profile_info);
2658#endif
2659
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002660 // If depth of calling is getting too high, don't execute the function.
2661 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663 rettv->v_type = VAR_NUMBER;
2664 rettv->vval.v_number = -1;
2665 return;
2666 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667
Bram Moolenaare38eab22019-12-05 21:50:01 +01002668 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002669
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002670 fc = create_funccal(fp, rettv);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002671 if (fc == NULL)
2672 return;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002673 fc->fc_level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002674 // Check if this function has a breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002675 fc->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2676 fc->fc_dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002677 // Set up fields for closure.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002678 ga_init2(&fc->fc_ufuncs, sizeof(ufunc_T *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002680 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002681 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002682#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01002683 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002684#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002685 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002686#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002687 if (do_profiling == PROF_YES)
2688 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002689#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002690 sticky_cmdmod_flags = 0;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01002691 call_def_function(fp, argcount, argvars, 0, funcexe->fe_partial,
Bram Moolenaar58779852022-09-06 18:31:14 +01002692 fc, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002693 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002694#ifdef FEAT_PROFILE
2695 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002696 || (caller != NULL && caller->uf_profiling)))
2697 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002698#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002699 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002700 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002701 return;
2702 }
2703
Bram Moolenaar38453522021-11-28 22:00:12 +00002704 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705
2706 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002707 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2708 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2709 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 */
2711 /*
2712 * Init l: variables.
2713 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002714 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002715 if (selfdict != NULL)
2716 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002717 // Set l:self to "selfdict". Use "name" to avoid a warning from
2718 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002719 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 name = v->di_key;
2721 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002722 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002723 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 v->di_tv.v_type = VAR_DICT;
2725 v->di_tv.v_lock = 0;
2726 v->di_tv.vval.v_dict = selfdict;
2727 ++selfdict->dv_refcount;
2728 }
2729
2730 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002731 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002732 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 * Set a:000 to a list with room for the "..." arguments.
2734 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002735 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002736 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002737 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002738 (varnumber_T)(argcount >= fp->uf_args.ga_len
2739 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002740 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002741 if ((fp->uf_flags & FC_NOARGS) == 0)
2742 {
2743 // Use "name" to avoid a warning from some compiler that checks the
2744 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002745 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002746 name = v->di_key;
2747 STRCPY(name, "000");
2748 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002749 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002750 v->di_tv.v_type = VAR_LIST;
2751 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002752 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002753 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002754 CLEAR_FIELD(fc->fc_l_varlist);
2755 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2756 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757
2758 /*
2759 * Set a:firstline to "firstline" and a:lastline to "lastline".
2760 * Set a:name to named arguments.
2761 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002762 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002764 if ((fp->uf_flags & FC_NOARGS) == 0)
2765 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002766 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2767 "firstline", (varnumber_T)funcexe->fe_firstline);
2768 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2769 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002770 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002771 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 {
2773 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002774 typval_T def_rettv;
2775 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776
2777 ai = i - fp->uf_args.ga_len;
2778 if (ai < 0)
2779 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002780 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 name = FUNCARG(fp, i);
2782 if (islambda)
2783 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002784
2785 // evaluate named argument default expression
2786 isdefault = ai + fp->uf_def_args.ga_len >= 0
2787 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2788 && argvars[i].vval.v_number == VVAL_NONE));
2789 if (isdefault)
2790 {
2791 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002792
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002793 def_rettv.v_type = VAR_NUMBER;
2794 def_rettv.vval.v_number = -1;
2795
2796 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2797 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002798 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002799 {
2800 default_arg_err = 1;
2801 break;
2802 }
2803 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 }
2805 else
2806 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002807 if ((fp->uf_flags & FC_NOARGS) != 0)
2808 // Bail out if no a: arguments used (in lambda).
2809 break;
2810
Bram Moolenaare38eab22019-12-05 21:50:01 +01002811 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 sprintf((char *)numbuf, "%d", ai + 1);
2813 name = numbuf;
2814 }
2815 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2816 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002817 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002819 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 }
2821 else
2822 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002823 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 if (v == NULL)
2825 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002826 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002829 // Note: the values are copied directly to avoid alloc/free.
2830 // "argvars" must have VAR_FIXED for v_lock.
2831 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 v->di_tv.v_lock = VAR_FIXED;
2833
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002834 if (isdefault)
2835 // Need to free this later, no matter where it's stored.
2836 tv_to_free[tv_to_free_len++] = &v->di_tv;
2837
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 if (addlocal)
2839 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002840 // Named arguments should be accessed without the "a:" prefix in
2841 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002842 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002843 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002845 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01002846 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847
2848 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2849 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002850 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002851
2852 li->li_tv = argvars[i];
2853 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002854 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 }
2856 }
2857
Bram Moolenaare38eab22019-12-05 21:50:01 +01002858 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002860
2861 if (fp->uf_flags & FC_SANDBOX)
2862 {
2863 using_sandbox = TRUE;
2864 ++sandbox;
2865 }
2866
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002867 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002868 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002869 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002871 ++no_wait_return;
2872 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002874 smsg(_("calling %s"), SOURCING_NAME);
2875 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002877 char_u buf[MSG_BUF_LEN];
2878 char_u numbuf2[NUMBUFLEN];
2879 char_u *tofree;
2880 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002882 msg_puts("(");
2883 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002885 if (i > 0)
2886 msg_puts(", ");
2887 if (argvars[i].v_type == VAR_NUMBER)
2888 msg_outnum((long)argvars[i].vval.v_number);
2889 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002891 // Do not want errors such as E724 here.
2892 ++emsg_off;
2893 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2894 --emsg_off;
2895 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002897 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002899 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2900 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002902 msg_puts((char *)s);
2903 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002904 }
2905 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002907 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002908 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002909 msg_puts("\n"); // don't overwrite this either
2910
2911 verbose_leave_scroll();
2912 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002913 }
2914#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002915 if (do_profiling == PROF_YES)
2916 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002917 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918#endif
2919
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002920 // "legacy" does not apply to commands in the function
2921 sticky_cmdmod_flags = 0;
2922
Bram Moolenaar98aff652022-09-06 21:02:35 +01002923 // If called from a compiled :def function the execution context must be
2924 // hidden, any deferred functions need to be added to the function being
2925 // executed here.
2926 save_current_ectx = clear_currrent_ectx();
2927
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002928 save_current_sctx = current_sctx;
2929 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930 save_did_emsg = did_emsg;
2931 did_emsg = FALSE;
2932
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002933 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2934 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002935 else if (islambda)
2936 {
2937 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2938
2939 // A Lambda always has the command "return {expr}". It is much faster
2940 // to evaluate {expr} directly.
2941 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002942 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002943 --ex_nesting_level;
2944 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002945 else
2946 // call do_cmdline() to execute the lines
2947 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002948 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2949
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002950 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01002951 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002952
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002953 --RedrawingDisabled;
2954
Bram Moolenaare38eab22019-12-05 21:50:01 +01002955 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2957 {
2958 clear_tv(rettv);
2959 rettv->v_type = VAR_NUMBER;
2960 rettv->vval.v_number = -1;
2961 }
2962
2963#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002964 if (do_profiling == PROF_YES)
2965 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002966 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002967
2968 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2969 profile_may_end_func(&profile_info, fp, caller);
2970 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971#endif
2972
Bram Moolenaare38eab22019-12-05 21:50:01 +01002973 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002974 if (p_verbose >= 12)
2975 {
2976 ++no_wait_return;
2977 verbose_enter_scroll();
2978
2979 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002980 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002981 else if (fc->fc_rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002982 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002983 (long)fc->fc_rettv->vval.v_number);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002984 else
2985 {
2986 char_u buf[MSG_BUF_LEN];
2987 char_u numbuf2[NUMBUFLEN];
2988 char_u *tofree;
2989 char_u *s;
2990
Bram Moolenaare38eab22019-12-05 21:50:01 +01002991 // The value may be very long. Skip the middle part, so that we
2992 // have some idea how it starts and ends. smsg() would always
2993 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994 ++emsg_off;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002995 s = tv2string(fc->fc_rettv, &tofree, numbuf2, 0);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002996 --emsg_off;
2997 if (s != NULL)
2998 {
2999 if (vim_strsize(s) > MSG_BUF_CLEN)
3000 {
3001 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
3002 s = buf;
3003 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003004 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005 vim_free(tofree);
3006 }
3007 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003008 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009
3010 verbose_leave_scroll();
3011 --no_wait_return;
3012 }
3013
Bram Moolenaare31ee862020-01-07 20:59:34 +01003014 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003015 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003016 current_sctx = save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01003017 restore_current_ectx(save_current_ectx);
3018
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019#ifdef FEAT_PROFILE
3020 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003021 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02003023 if (using_sandbox)
3024 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003025 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003027 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028 {
3029 ++no_wait_return;
3030 verbose_enter_scroll();
3031
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003032 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003033 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034
3035 verbose_leave_scroll();
3036 --no_wait_return;
3037 }
3038
3039 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01003040 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02003041 for (i = 0; i < tv_to_free_len; ++i)
3042 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003043 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044}
3045
3046/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003047 * Check the argument count for user function "fp".
3048 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3049 */
3050 int
3051check_user_func_argcount(ufunc_T *fp, int argcount)
3052{
3053 int regular_args = fp->uf_args.ga_len;
3054
3055 if (argcount < regular_args - fp->uf_def_args.ga_len)
3056 return FCERR_TOOFEW;
3057 else if (!has_varargs(fp) && argcount > regular_args)
3058 return FCERR_TOOMANY;
3059 return FCERR_UNKNOWN;
3060}
3061
3062/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003063 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003064 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003065 int
3066call_user_func_check(
3067 ufunc_T *fp,
3068 int argcount,
3069 typval_T *argvars,
3070 typval_T *rettv,
3071 funcexe_T *funcexe,
3072 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003073{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003074 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003075
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003076#ifdef FEAT_LUA
3077 if (fp->uf_flags & FC_CFUNC)
3078 {
3079 cfunc_T cb = fp->uf_cb;
3080
3081 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3082 }
3083#endif
3084
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003085 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3086 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003087 error = check_user_func_argcount(fp, argcount);
3088 if (error != FCERR_UNKNOWN)
3089 return error;
3090 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003091 error = FCERR_DICT;
3092 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003093 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003094 int did_save_redo = FALSE;
3095 save_redo_T save_redo;
3096
3097 /*
3098 * Call the user function.
3099 * Save and restore search patterns, script variables and
3100 * redo buffer.
3101 */
3102 save_search_patterns();
3103 if (!ins_compl_active())
3104 {
3105 saveRedobuff(&save_redo);
3106 did_save_redo = TRUE;
3107 }
3108 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003109 call_user_func(fp, argcount, argvars, rettv, funcexe,
3110 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003111 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3112 // Function was unreferenced while being used, free it now.
3113 func_clear_free(fp, FALSE);
3114 if (did_save_redo)
3115 restoreRedobuff(&save_redo);
3116 restore_search_patterns();
3117 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003118 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003119 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003120}
3121
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003122static funccal_entry_T *funccal_stack = NULL;
3123
3124/*
3125 * Save the current function call pointer, and set it to NULL.
3126 * Used when executing autocommands and for ":source".
3127 */
3128 void
3129save_funccal(funccal_entry_T *entry)
3130{
3131 entry->top_funccal = current_funccal;
3132 entry->next = funccal_stack;
3133 funccal_stack = entry;
3134 current_funccal = NULL;
3135}
3136
3137 void
3138restore_funccal(void)
3139{
3140 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003141 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003142 else
3143 {
3144 current_funccal = funccal_stack->top_funccal;
3145 funccal_stack = funccal_stack->next;
3146 }
3147}
3148
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003149 funccall_T *
3150get_current_funccal(void)
3151{
3152 return current_funccal;
3153}
3154
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003155/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003156 * Return TRUE when currently at the script level:
3157 * - not in a function
3158 * - not executing an autocommand
3159 * Note that when an autocommand sources a script the result is FALSE;
3160 */
3161 int
3162at_script_level(void)
3163{
3164 return current_funccal == NULL && autocmd_match == NULL;
3165}
3166
3167/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003168 * Mark all functions of script "sid" as deleted.
3169 */
3170 void
3171delete_script_functions(int sid)
3172{
3173 hashitem_T *hi;
3174 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003175 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003176 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003177 size_t len;
3178
3179 buf[0] = K_SPECIAL;
3180 buf[1] = KS_EXTRA;
3181 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003182 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003183 len = STRLEN(buf);
3184
Bram Moolenaarce658352020-07-31 23:47:12 +02003185 while (todo > 0)
3186 {
3187 todo = func_hashtab.ht_used;
3188 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3189 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003190 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003191 fp = HI2UF(hi);
3192 if (STRNCMP(fp->uf_name, buf, len) == 0)
3193 {
3194 int changed = func_hashtab.ht_changed;
3195
3196 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003197
3198 if (fp->uf_calls > 0)
3199 {
3200 // Function is executing, don't free it but do remove
3201 // it from the hashtable.
3202 if (func_remove(fp))
3203 fp->uf_refcount--;
3204 }
3205 else
3206 {
3207 func_clear(fp, TRUE);
3208 // When clearing a function another function can be
3209 // cleared as a side effect. When that happens start
3210 // over.
3211 if (changed != func_hashtab.ht_changed)
3212 break;
3213 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003214 }
3215 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003216 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003217 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003218}
3219
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003220#if defined(EXITFREE) || defined(PROTO)
3221 void
3222free_all_functions(void)
3223{
3224 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003225 ufunc_T *fp;
3226 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003227 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003228 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229
Bram Moolenaare38eab22019-12-05 21:50:01 +01003230 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003231 while (current_funccal != NULL)
3232 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003233 clear_tv(current_funccal->fc_rettv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003234 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003235 if (current_funccal == NULL && funccal_stack != NULL)
3236 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003237 }
3238
Bram Moolenaare38eab22019-12-05 21:50:01 +01003239 // First clear what the functions contain. Since this may lower the
3240 // reference count of a function, it may also free a function and change
3241 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003242 while (todo > 0)
3243 {
3244 todo = func_hashtab.ht_used;
3245 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3246 if (!HASHITEM_EMPTY(hi))
3247 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 // clear the def function index now
3249 fp = HI2UF(hi);
3250 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003251 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003252
Bram Moolenaare38eab22019-12-05 21:50:01 +01003253 // Only free functions that are not refcounted, those are
3254 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003255 if (func_name_refcount(fp->uf_name))
3256 ++skipped;
3257 else
3258 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003259 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003260 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003261 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003262 {
3263 skipped = 0;
3264 break;
3265 }
3266 }
3267 --todo;
3268 }
3269 }
3270
Bram Moolenaare38eab22019-12-05 21:50:01 +01003271 // Now actually free the functions. Need to start all over every time,
3272 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003273 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003274 while (func_hashtab.ht_used > skipped)
3275 {
3276 todo = func_hashtab.ht_used;
3277 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 if (!HASHITEM_EMPTY(hi))
3279 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003280 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003281 // Only free functions that are not refcounted, those are
3282 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003283 fp = HI2UF(hi);
3284 if (func_name_refcount(fp->uf_name))
3285 ++skipped;
3286 else
3287 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003288 if (func_free(fp, FALSE) == OK)
3289 {
3290 skipped = 0;
3291 break;
3292 }
3293 // did not actually free it
3294 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003295 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003297 }
3298 if (skipped == 0)
3299 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003300
3301 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003302}
3303#endif
3304
3305/*
3306 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003307 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3308 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 * "len" is the length of "name", or -1 for NUL terminated.
3310 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003311 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003312builtin_function(char_u *name, int len)
3313{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003314 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315
Bram Moolenaara26b9702020-04-18 19:53:28 +02003316 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003318 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3319 {
3320 if (name[i] == AUTOLOAD_CHAR)
3321 return FALSE;
3322 if (!eval_isnamec(name[i]))
3323 {
3324 // "name.something" is not a builtin function
3325 if (name[i] == '.')
3326 return FALSE;
3327 break;
3328 }
3329 }
3330 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331}
3332
3333 int
3334func_call(
3335 char_u *name,
3336 typval_T *args,
3337 partial_T *partial,
3338 dict_T *selfdict,
3339 typval_T *rettv)
3340{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003341 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342 listitem_T *item;
3343 typval_T argv[MAX_FUNC_ARGS + 1];
3344 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 int r = 0;
3346
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003347 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003348 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003349 {
3350 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3351 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003352 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 break;
3354 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003355 // Make a copy of each argument. This is needed to be able to set
3356 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 copy_tv(&item->li_tv, &argv[argc++]);
3358 }
3359
3360 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003361 {
3362 funcexe_T funcexe;
3363
Bram Moolenaara80faa82020-04-12 19:37:17 +02003364 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003365 funcexe.fe_firstline = curwin->w_cursor.lnum;
3366 funcexe.fe_lastline = curwin->w_cursor.lnum;
3367 funcexe.fe_evaluate = TRUE;
3368 funcexe.fe_partial = partial;
3369 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003370 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372
Bram Moolenaare38eab22019-12-05 21:50:01 +01003373 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003374 while (argc > 0)
3375 clear_tv(&argv[--argc]);
3376
3377 return r;
3378}
3379
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003380static int callback_depth = 0;
3381
3382 int
3383get_callback_depth(void)
3384{
3385 return callback_depth;
3386}
3387
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003389 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003390 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003391 */
3392 int
3393call_callback(
3394 callback_T *callback,
3395 int len, // length of "name" or -1 to use strlen()
3396 typval_T *rettv, // return value goes here
3397 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003398 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003399 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003400{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003401 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003402 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003403
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003404 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3405 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003406 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003407 funcexe.fe_evaluate = TRUE;
3408 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003409 ++callback_depth;
3410 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3411 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003412
3413 // When a :def function was called that uses :try an error would be turned
3414 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003415 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003416 {
3417 need_rethrow = FALSE;
3418 handle_did_throw();
3419 }
3420
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003421 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003422}
3423
3424/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003425 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003426 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003427 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3428 */
3429 varnumber_T
3430call_callback_retnr(
3431 callback_T *callback,
3432 int argcount, // number of "argvars"
3433 typval_T *argvars) // vars for arguments, must have "argcount"
3434 // PLUS ONE elements!
3435{
3436 typval_T rettv;
3437 varnumber_T retval;
3438
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003439 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003440 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003441
3442 retval = tv_get_number_chk(&rettv, NULL);
3443 clear_tv(&rettv);
3444 return retval;
3445}
3446
3447/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003448 * Give an error message for the result of a function.
3449 * Nothing if "error" is FCERR_NONE.
3450 */
3451 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003452user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003453{
3454 switch (error)
3455 {
3456 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003457 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003458 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003459 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003460 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003461 break;
3462 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003463 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 break;
3465 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003466 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003467 break;
3468 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003469 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 break;
3471 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003472 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003473 break;
3474 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003475 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003476 break;
3477 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003478 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3479 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003480 break;
3481 }
3482}
3483
3484/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003486 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003487 * Return FAIL when the function can't be called, OK otherwise.
3488 * Also returns OK when an error was encountered while executing the function.
3489 */
3490 int
3491call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003492 char_u *funcname, // name of the function
3493 int len, // length of "name" or -1 to use strlen()
3494 typval_T *rettv, // return value goes here
3495 int argcount_in, // number of "argvars"
3496 typval_T *argvars_in, // vars for arguments, must have "argcount"
3497 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003498 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499{
3500 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003501 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003503 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003504 char_u fname_buf[FLEN_FIXED + 1];
3505 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003506 char_u *fname = NULL;
3507 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003508 int argcount = argcount_in;
3509 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003510 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003511 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003512 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003514 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003515 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003516 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003517 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003518
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003519 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3520 // even when call_func() returns FAIL.
3521 rettv->v_type = VAR_UNKNOWN;
3522
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003523 if (partial != NULL)
3524 fp = partial->pt_func;
3525 if (fp == NULL)
3526 {
3527 // Make a copy of the name, if it comes from a funcref variable it
3528 // could be changed or deleted in the called function.
3529 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3530 if (name == NULL)
3531 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003533 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3534 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003536 if (funcexe->fe_doesrange != NULL)
3537 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538
3539 if (partial != NULL)
3540 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003541 // When the function has a partial with a dict and there is a dict
3542 // argument, use the dict argument. That is backwards compatible.
3543 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003544 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003546 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547 {
3548 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003549 {
3550 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3551 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003552 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003553 goto theend;
3554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003556 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 for (i = 0; i < argcount_in; ++i)
3558 argv[i + argv_clear] = argvars_in[i];
3559 argvars = argv;
3560 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003561
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003562 if (funcexe->fe_check_type != NULL
3563 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003564 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003565 // Now funcexe->fe_check_type is missing the added arguments,
3566 // make a copy of the type with the correction.
3567 check_type = *funcexe->fe_check_type;
3568 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003569 check_type.tt_args = check_type_args;
3570 CLEAR_FIELD(check_type_args);
3571 for (i = 0; i < check_type.tt_argcount; ++i)
3572 check_type_args[i + partial->pt_argc] =
3573 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003574 check_type.tt_argcount += partial->pt_argc;
3575 check_type.tt_min_argcount += partial->pt_argc;
3576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 }
3578 }
3579
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003580 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3581 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003582 {
3583 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003584 if (check_argument_types(funcexe->fe_check_type,
3585 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003586 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003587 error = FCERR_OTHER;
3588 }
3589
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003590 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 {
3592 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003593 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594
Bram Moolenaar333894b2020-08-01 18:53:07 +02003595 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003596 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003597 {
3598 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003600 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601
Bram Moolenaare38eab22019-12-05 21:50:01 +01003602 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003604 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003606 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 {
3608 /*
3609 * User defined function.
3610 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003611 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003612 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003613 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003614 if (fp != NULL && !is_global && in_vim9script()
3615 && func_requires_g_prefix(fp))
3616 // In Vim9 script g: is required to find a global
3617 // non-autoload function.
3618 fp = NULL;
3619 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620
Bram Moolenaare38eab22019-12-05 21:50:01 +01003621 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 if (fp == NULL
3623 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003624 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 && !aborting())
3626 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003627 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003628 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003630 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3632 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003633 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003634 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003636 if (fp == NULL)
3637 {
3638 char_u *p = untrans_function_name(rfname);
3639
3640 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003641 // Don't do this if the name starts with "s:".
3642 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003643 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003644 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003646 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003647 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003648 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003650 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003651 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003652 argcount = funcexe->fe_argv_func(argcount, argvars,
zeertzjq48db5da2022-09-16 12:10:03 +01003653 argv_clear, fp);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003654
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003655 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003656 {
3657 // Method call: base->Method()
3658 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003659 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003660 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003661 argvars = argv;
3662 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003663 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003664
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003665 error = call_user_func_check(fp, argcount, argvars, rettv,
3666 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667 }
3668 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003669 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003670 {
3671 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003672 * expr->method(): Find the method name in the table, call its
3673 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003674 */
3675 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003676 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003677 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 else
3679 {
3680 /*
3681 * Find the function name in the table, call its implementation.
3682 */
3683 error = call_internal_func(fname, argcount, argvars, rettv);
3684 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003685
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686 /*
3687 * The function call (or "FuncUndefined" autocommand sequence) might
3688 * have been aborted by an error, an interrupt, or an explicitly thrown
3689 * exception that has not been caught so far. This situation can be
3690 * tested for by calling aborting(). For an error in an internal
3691 * function or for the "E132" error in call_user_func(), however, the
3692 * throw point at which the "force_abort" flag (temporarily reset by
3693 * emsg()) is normally updated has not been reached yet. We need to
3694 * update that flag first to make aborting() reliable.
3695 */
3696 update_force_abort();
3697 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003698 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 ret = OK;
3700
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003701theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702 /*
3703 * Report an error unless the argument evaluation or function call has been
3704 * cancelled due to an aborting error, an interrupt, or an exception.
3705 */
3706 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003707 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003709 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003711 clear_tv(&argv[--argv_clear + argv_base]);
3712
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 vim_free(tofree);
3714 vim_free(name);
3715
3716 return ret;
3717}
3718
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003719 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003720printable_func_name(ufunc_T *fp)
3721{
3722 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3723}
3724
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003726 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 */
3728 static void
3729list_func_head(ufunc_T *fp, int indent)
3730{
3731 int j;
3732
3733 msg_start();
3734 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003735 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003736 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003737 msg_puts("def ");
3738 else
3739 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003740 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 msg_putchar('(');
3742 for (j = 0; j < fp->uf_args.ga_len; ++j)
3743 {
3744 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003745 msg_puts(", ");
3746 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003747 if (fp->uf_arg_types != NULL)
3748 {
3749 char *tofree;
3750
3751 msg_puts(": ");
3752 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3753 vim_free(tofree);
3754 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003755 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3756 {
3757 msg_puts(" = ");
3758 msg_puts(((char **)(fp->uf_def_args.ga_data))
3759 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 }
3762 if (fp->uf_varargs)
3763 {
3764 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003765 msg_puts(", ");
3766 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003768 if (fp->uf_va_name != NULL)
3769 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003770 if (!fp->uf_varargs)
3771 {
3772 if (j)
3773 msg_puts(", ");
3774 msg_puts("...");
3775 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003776 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003777 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778 {
3779 char *tofree;
3780
3781 msg_puts(": ");
3782 msg_puts(type_name(fp->uf_va_type, &tofree));
3783 vim_free(tofree);
3784 }
3785 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003787
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003788 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003789 {
3790 if (fp->uf_ret_type != &t_void)
3791 {
3792 char *tofree;
3793
3794 msg_puts(": ");
3795 msg_puts(type_name(fp->uf_ret_type, &tofree));
3796 vim_free(tofree);
3797 }
3798 }
3799 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003800 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003802 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003804 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003805 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003806 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 msg_clr_eos();
3808 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003809 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810}
3811
3812/*
3813 * Get a function name, translating "<SID>" and "<SNR>".
3814 * Also handles a Funcref in a List or Dictionary.
3815 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003816 * Set "*is_global" to TRUE when the function must be global, unless
3817 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003818 * flags:
3819 * TFN_INT: internal function name OK
3820 * TFN_QUIET: be quiet
3821 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003822 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 * Advances "pp" to just after the function name (if no error).
3824 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003825 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826trans_function_name(
3827 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003828 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003829 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003831 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003832 partial_T **partial, // return: partial of a FuncRef
3833 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003834{
3835 char_u *name = NULL;
3836 char_u *start;
3837 char_u *end;
3838 int lead;
3839 char_u sid_buf[20];
3840 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003842 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003844 int vim9script = in_vim9script();
3845 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846
3847 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003848 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 start = *pp;
3850
Bram Moolenaare38eab22019-12-05 21:50:01 +01003851 // Check for hard coded <SNR>: already translated function ID (from a user
3852 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3854 && (*pp)[2] == (int)KE_SNR)
3855 {
3856 *pp += 3;
3857 len = get_id_len(pp) + 3;
3858 return vim_strnsave(start, len);
3859 }
3860
Bram Moolenaare38eab22019-12-05 21:50:01 +01003861 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3862 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003863 lead = eval_fname_script(start);
3864 if (lead > 2)
3865 start += lead;
3866
Bram Moolenaare38eab22019-12-05 21:50:01 +01003867 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003868 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003870 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003871 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003872 {
3873 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003874 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003875 goto theend;
3876 }
3877 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3878 {
3879 /*
3880 * Report an invalid expression in braces, unless the expression
3881 * evaluation has been cancelled due to an aborting error, an
3882 * interrupt, or an exception.
3883 */
3884 if (!aborting())
3885 {
3886 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003887 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888 }
3889 else
3890 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3891 goto theend;
3892 }
3893
3894 if (lv.ll_tv != NULL)
3895 {
3896 if (fdp != NULL)
3897 {
3898 fdp->fd_dict = lv.ll_dict;
3899 fdp->fd_newkey = lv.ll_newkey;
3900 lv.ll_newkey = NULL;
3901 fdp->fd_di = lv.ll_di;
3902 }
3903 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3904 {
3905 name = vim_strsave(lv.ll_tv->vval.v_string);
3906 *pp = end;
3907 }
3908 else if (lv.ll_tv->v_type == VAR_PARTIAL
3909 && lv.ll_tv->vval.v_partial != NULL)
3910 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003911 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003912 *pp = end;
3913 if (partial != NULL)
3914 *partial = lv.ll_tv->vval.v_partial;
3915 }
3916 else
3917 {
3918 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3919 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003920 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003921 else
3922 *pp = end;
3923 name = NULL;
3924 }
3925 goto theend;
3926 }
3927
3928 if (lv.ll_name == NULL)
3929 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003930 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 *pp = end;
3932 goto theend;
3933 }
3934
Bram Moolenaare38eab22019-12-05 21:50:01 +01003935 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 if (lv.ll_exp_name != NULL)
3937 {
3938 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003939 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003940 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 if (name == lv.ll_exp_name)
3942 name = NULL;
3943 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003944 else if (lv.ll_sid > 0)
3945 {
3946 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3947 int cc = *lv.ll_name_end;
3948
3949 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3950 *lv.ll_name_end = NUL;
3951 if (si->sn_autoload_prefix != NULL)
3952 {
3953 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3954 }
3955 else
3956 {
3957 sid_buf[0] = K_SPECIAL;
3958 sid_buf[1] = KS_EXTRA;
3959 sid_buf[2] = (int)KE_SNR;
3960 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003961 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003962 name = concat_str(sid_buf, lv.ll_name);
3963 }
3964 *lv.ll_name_end = cc;
3965 *pp = end;
3966 goto theend;
3967 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003968 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003969 {
3970 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003971 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003972 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973 if (name == *pp)
3974 name = NULL;
3975 }
3976 if (name != NULL)
3977 {
3978 name = vim_strsave(name);
3979 *pp = end;
3980 if (STRNCMP(name, "<SNR>", 5) == 0)
3981 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003982 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 name[0] = K_SPECIAL;
3984 name[1] = KS_EXTRA;
3985 name[2] = (int)KE_SNR;
3986 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3987 }
3988 goto theend;
3989 }
3990
3991 if (lv.ll_exp_name != NULL)
3992 {
3993 len = (int)STRLEN(lv.ll_exp_name);
3994 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3995 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3996 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003997 // When there was "s:" already or the name expanded to get a
3998 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 lv.ll_name += 2;
4000 len -= 2;
4001 lead = 2;
4002 }
4003 }
4004 else
4005 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004006 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004007 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004008 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004009 if (lv.ll_name[0] == 'g')
4010 {
4011 if (is_global != NULL)
4012 {
4013 *is_global = TRUE;
4014 }
4015 else
4016 {
4017 // dropping "g:" without setting "is_global" won't work in
4018 // Vim9script, put it back later
4019 prefix_g = TRUE;
4020 extra = 2;
4021 }
4022 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004024 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 len = (int)(end - lv.ll_name);
4026 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004027 if (len <= 0)
4028 {
4029 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004030 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004031 goto theend;
4032 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004033
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004034 // In Vim9 script a user function is script-local by default, unless it
4035 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00004036 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004037
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 /*
4039 * Copy the function name to allocated memory.
4040 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4041 * Accept <SNR>123_name() outside a script.
4042 */
4043 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004044 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004045 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004047 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004048 {
Kota Kato948a3892022-08-16 16:09:59 +01004049 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4050 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004051 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004052 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004053 goto theend;
4054 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004055 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004056 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004057 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004058 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 || eval_fname_sid(*pp))
4060 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004061 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004062 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004064 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 goto theend;
4066 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004067 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004068 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004069 extra = 3 + (int)STRLEN(sid_buf);
4070 else
4071 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072 }
4073 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004074 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004075 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004077 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004078 : e_function_name_must_start_with_capital_or_s_str),
4079 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 goto theend;
4081 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004082 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004083 {
4084 char_u *cp = vim_strchr(lv.ll_name, ':');
4085
4086 if (cp != NULL && cp < end)
4087 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004088 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089 goto theend;
4090 }
4091 }
4092
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004093 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094 if (name != NULL)
4095 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004096 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097 {
4098 name[0] = K_SPECIAL;
4099 name[1] = KS_EXTRA;
4100 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004101 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 STRCPY(name + 3, sid_buf);
4103 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004104 else if (prefix_g)
4105 {
4106 name[0] = 'g';
4107 name[1] = ':';
4108 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004109 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4110 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 }
4112 *pp = end;
4113
4114theend:
4115 clear_lval(&lv);
4116 return name;
4117}
4118
4119/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004120 * Assuming "name" is the result of trans_function_name() and it was prefixed
4121 * to use the script-local name, return the unmodified name (points into
4122 * "name"). Otherwise return NULL.
4123 * This can be used to first search for a script-local function and fall back
4124 * to the global function if not found.
4125 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004126 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004127untrans_function_name(char_u *name)
4128{
4129 char_u *p;
4130
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004131 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004132 {
4133 p = vim_strchr(name, '_');
4134 if (p != NULL)
4135 return p + 1;
4136 }
4137 return NULL;
4138}
4139
4140/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004141 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4142 * current script ID and returns the expanded function name. The caller should
4143 * free the returned name. If not called from a script context or the function
4144 * name doesn't start with these prefixes, then returns NULL.
4145 * This doesn't check whether the script-local function exists or not.
4146 */
4147 char_u *
4148get_scriptlocal_funcname(char_u *funcname)
4149{
4150 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004151 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004152 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004153 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004154
4155 if (funcname == NULL)
4156 return NULL;
4157
4158 if (STRNCMP(funcname, "s:", 2) != 0
4159 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004160 {
4161 ufunc_T *ufunc;
4162
4163 // The function name does not have a script-local prefix. Try finding
4164 // it when in a Vim9 script and there is no "g:" prefix.
4165 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4166 return NULL;
4167 ufunc = find_func(funcname, FALSE);
4168 if (ufunc == NULL || func_is_global(ufunc)
4169 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4170 return NULL;
4171 ++p;
4172 off = 0;
4173 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004174 else
4175 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004176
4177 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4178 {
4179 emsg(_(e_using_sid_not_in_script_context));
4180 return NULL;
4181 }
4182 // Expand s: prefix into <SNR>nr_<name>
4183 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4184 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004185 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004186 if (newname == NULL)
4187 return NULL;
4188 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004189 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004190
4191 return newname;
4192}
4193
4194/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004195 * Return script-local "fname" with the 3-byte sequence replaced by
4196 * printable <SNR> in allocated memory.
4197 */
4198 char_u *
4199alloc_printable_func_name(char_u *fname)
4200{
4201 char_u *n = alloc(STRLEN(fname + 3) + 6);
4202
4203 if (n != NULL)
4204 {
4205 STRCPY(n, "<SNR>");
4206 STRCPY(n + 5, fname + 3);
4207 }
4208 return n;
4209}
4210
4211/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004212 * Call trans_function_name(), except that a lambda is returned as-is.
4213 * Returns the name in allocated memory.
4214 */
4215 char_u *
4216save_function_name(
4217 char_u **name,
4218 int *is_global,
4219 int skip,
4220 int flags,
4221 funcdict_T *fudi)
4222{
4223 char_u *p = *name;
4224 char_u *saved;
4225
4226 if (STRNCMP(p, "<lambda>", 8) == 0)
4227 {
4228 p += 8;
4229 (void)getdigits(&p);
4230 saved = vim_strnsave(*name, p - *name);
4231 if (fudi != NULL)
4232 CLEAR_POINTER(fudi);
4233 }
4234 else
4235 saved = trans_function_name(&p, is_global, skip,
4236 flags, fudi, NULL, NULL);
4237 *name = p;
4238 return saved;
4239}
4240
4241/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004242 * List functions. When "regmatch" is NULL all of then.
4243 * Otherwise functions matching "regmatch".
4244 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004245 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004246list_functions(regmatch_T *regmatch)
4247{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004248 int changed = func_hashtab.ht_changed;
4249 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004250 hashitem_T *hi;
4251
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004252 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004253 {
4254 if (!HASHITEM_EMPTY(hi))
4255 {
4256 ufunc_T *fp = HI2UF(hi);
4257
4258 --todo;
4259 if ((fp->uf_flags & FC_DEAD) == 0
4260 && (regmatch == NULL
4261 ? !message_filtered(fp->uf_name)
4262 && !func_name_refcount(fp->uf_name)
4263 : !isdigit(*fp->uf_name)
4264 && vim_regexec(regmatch, fp->uf_name, 0)))
4265 {
4266 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004267 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004268 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004269 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004270 return;
4271 }
4272 }
4273 }
4274 }
4275}
4276
4277/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004278 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004279 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4280 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004281 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004282 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004283 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004284 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004285define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004287 int j;
4288 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004289 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004290 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004291 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 char_u *p;
4293 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004294 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004295 char_u *line_arg = NULL;
4296 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004297 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004298 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 garray_T newlines;
4300 int varargs = FALSE;
4301 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004302 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004303 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004304 int fp_allocated = FALSE;
4305 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004306 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307 dictitem_T *v;
4308 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004309 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004312 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004313 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004314 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315
4316 /*
4317 * ":function" without argument: list functions.
4318 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004319 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320 {
4321 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004322 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004323 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004324 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 }
4326
4327 /*
4328 * ":function /pat": list functions matching pattern.
4329 */
4330 if (*eap->arg == '/')
4331 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004332 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333 if (!eap->skip)
4334 {
4335 regmatch_T regmatch;
4336
4337 c = *p;
4338 *p = NUL;
4339 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4340 *p = c;
4341 if (regmatch.regprog != NULL)
4342 {
4343 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004344 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 vim_regfree(regmatch.regprog);
4346 }
4347 }
4348 if (*p == '/')
4349 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004350 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004351 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 }
4353
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004354 ga_init(&newargs);
4355 ga_init(&argtypes);
4356 ga_init(&default_args);
4357
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 /*
4359 * Get the function name. There are these situations:
4360 * func normal function name
4361 * "name" == func, "fudi.fd_dict" == NULL
4362 * dict.func new dictionary entry
4363 * "name" == NULL, "fudi.fd_dict" set,
4364 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4365 * dict.func existing dict entry with a Funcref
4366 * "name" == func, "fudi.fd_dict" set,
4367 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4368 * dict.func existing dict entry that's not a Funcref
4369 * "name" == NULL, "fudi.fd_dict" set,
4370 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4371 * s:func script-local function name
4372 * g:func global function name, same as "func"
4373 */
4374 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004375 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004377 // nested function, argument is (args).
4378 paren = TRUE;
4379 CLEAR_FIELD(fudi);
4380 }
4381 else
4382 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004383 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004384 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004385 if (p[0] == 's' && p[1] == ':')
4386 {
4387 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4388 return NULL;
4389 }
4390 p = to_name_end(p, TRUE);
4391 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4392 {
4393 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4394 eap->arg);
4395 return NULL;
4396 }
4397 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004398 }
4399
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004400 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004401 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004402 paren = (vim_strchr(p, '(') != NULL);
4403 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004404 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004405 /*
4406 * Return on an invalid expression in braces, unless the expression
4407 * evaluation has been cancelled due to an aborting error, an
4408 * interrupt, or an exception.
4409 */
4410 if (!aborting())
4411 {
4412 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004413 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004414 vim_free(fudi.fd_newkey);
4415 return NULL;
4416 }
4417 else
4418 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004420
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004421 // For "export def FuncName()" in an autoload script the function name
4422 // is stored with the legacy autoload name "dir#script#FuncName" so
4423 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004424 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004425 {
4426 char_u *prefixed = may_prefix_autoload(name);
4427
4428 if (prefixed != NULL && prefixed != name)
4429 {
4430 vim_free(name);
4431 name = prefixed;
4432 }
4433 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004434 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004435 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004436 {
4437 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4438 goto ret_free;
4439 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 }
4441
Bram Moolenaare38eab22019-12-05 21:50:01 +01004442 // An error in a function call during evaluation of an expression in magic
4443 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004444 saved_did_emsg = did_emsg;
4445 did_emsg = FALSE;
4446
4447 /*
4448 * ":function func" with only function name: list function.
4449 */
4450 if (!paren)
4451 {
4452 if (!ends_excmd(*skipwhite(p)))
4453 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004454 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 goto ret_free;
4456 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004457 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458 if (eap->nextcmd != NULL)
4459 *p = NUL;
4460 if (!eap->skip && !got_int)
4461 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004462 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004463 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4464 {
4465 char_u *up = untrans_function_name(name);
4466
4467 // With Vim9 script the name was made script-local, if not
4468 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004469 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004470 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004471 }
4472
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 if (fp != NULL)
4474 {
4475 list_func_head(fp, TRUE);
4476 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4477 {
4478 if (FUNCLINE(fp, j) == NULL)
4479 continue;
4480 msg_putchar('\n');
4481 msg_outnum((long)(j + 1));
4482 if (j < 9)
4483 msg_putchar(' ');
4484 if (j < 99)
4485 msg_putchar(' ');
4486 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004487 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488 ui_breakcheck();
4489 }
4490 if (!got_int)
4491 {
4492 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004493 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004494 msg_puts(" enddef");
4495 else
4496 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 }
4498 }
4499 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004500 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501 }
4502 goto ret_free;
4503 }
4504
4505 /*
4506 * ":function name(arg1, arg2)" Define function.
4507 */
4508 p = skipwhite(p);
4509 if (*p != '(')
4510 {
4511 if (!eap->skip)
4512 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004513 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 goto ret_free;
4515 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004516 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517 if (vim_strchr(p, '(') != NULL)
4518 p = vim_strchr(p, '(');
4519 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004520
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004521 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4522 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004523 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004524 goto ret_free;
4525 }
4526
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004527 // In Vim9 script only global functions can be redefined.
4528 if (vim9script && eap->forceit && !is_global)
4529 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004530 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004531 goto ret_free;
4532 }
4533
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004534 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535
Bram Moolenaar04b12692020-05-04 23:24:44 +02004536 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004538 // Check the name of the function. Unless it's a dictionary function
4539 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004540 if (name != NULL)
4541 arg = name;
4542 else
4543 arg = fudi.fd_newkey;
4544 if (arg != NULL && (fudi.fd_di == NULL
4545 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4546 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4547 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004548 char_u *name_base = arg;
4549 int i;
4550
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004551 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004552 {
4553 name_base = vim_strchr(arg, '_');
4554 if (name_base == NULL)
4555 name_base = arg + 3;
4556 else
4557 ++name_base;
4558 }
4559 for (i = 0; name_base[i] != NUL && (i == 0
4560 ? eval_isnamec1(name_base[i])
4561 : eval_isnamec(name_base[i])); ++i)
4562 ;
4563 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004564 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004565
4566 // In Vim9 script a function cannot have the same name as a
4567 // variable.
4568 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004569 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4570 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004571 + EVAL_VAR_NO_FUNC) == OK)
4572 {
4573 semsg(_(e_redefining_script_item_str), name_base);
4574 goto ret_free;
4575 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004577 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004579 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004580 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004581 goto ret_free;
4582 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 }
4584
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004585 // This may get more lines and make the pointers into the first line
4586 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004587 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004588 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004589 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004590 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004591 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004593 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004594
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004595 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004597 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004598 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004600 if (*p != ':')
4601 {
4602 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4603 p = skipwhite(p);
4604 }
4605 else if (!IS_WHITE_OR_NUL(p[1]))
4606 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004607 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004608 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004609 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004610 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004611 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004612 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004613 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004614 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004615 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004616 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004617 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004618 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004619 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004620 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004621 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004623 else
4624 // find extra arguments "range", "dict", "abort" and "closure"
4625 for (;;)
4626 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004627 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004628 p = skipwhite(p);
4629 if (STRNCMP(p, "range", 5) == 0)
4630 {
4631 flags |= FC_RANGE;
4632 p += 5;
4633 }
4634 else if (STRNCMP(p, "dict", 4) == 0)
4635 {
4636 flags |= FC_DICT;
4637 p += 4;
4638 }
4639 else if (STRNCMP(p, "abort", 5) == 0)
4640 {
4641 flags |= FC_ABORT;
4642 p += 5;
4643 }
4644 else if (STRNCMP(p, "closure", 7) == 0)
4645 {
4646 flags |= FC_CLOSURE;
4647 p += 7;
4648 if (current_funccal == NULL)
4649 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004650 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004651 name == NULL ? (char_u *)"" : name);
4652 goto erret;
4653 }
4654 }
4655 else
4656 break;
4657 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658
Bram Moolenaare38eab22019-12-05 21:50:01 +01004659 // When there is a line break use what follows for the function body.
4660 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661 if (*p == '\n')
4662 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004663 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004664 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4665 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004666 && !(VIM_ISWHITE(*whitep) && *p == '#'
4667 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004668 && !eap->skip
4669 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004670 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671
4672 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004673 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4674 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675 */
4676 if (KeyTyped)
4677 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004678 // Check if the function already exists, don't let the user type the
4679 // whole function before telling him it doesn't work! For a script we
4680 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 if (!eap->skip && !eap->forceit)
4682 {
4683 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004684 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004685 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004686 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004687 }
4688
4689 if (!eap->skip && did_emsg)
4690 goto erret;
4691
Bram Moolenaare38eab22019-12-05 21:50:01 +01004692 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 cmdline_row = msg_row;
4694 }
4695
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004696 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004697 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004698
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004699 // Do not define the function when getting the body fails and when
4700 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004701 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004702 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004703 goto erret;
4704
4705 /*
4706 * If there are no errors, add the function
4707 */
4708 if (fudi.fd_dict == NULL)
4709 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004710 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004711 char_u *find_name = name;
4712 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004713 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004714
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004715 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004716 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004717 var_conflict = TRUE;
4718
4719 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4720 {
4721 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4722
4723 if (si->sn_autoload_prefix != NULL)
4724 {
4725 if (is_export)
4726 {
4727 find_name = name + STRLEN(si->sn_autoload_prefix);
4728 v = find_var(find_name, &ht, TRUE);
4729 if (v != NULL)
4730 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004731 // Only check if the function already exists in the script,
4732 // global functions can be shadowed.
4733 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004734 }
4735 else
4736 {
4737 char_u *prefixed = may_prefix_autoload(name);
4738
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004739 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004740 {
4741 v = find_var(prefixed, &ht, TRUE);
4742 if (v != NULL)
4743 var_conflict = TRUE;
4744 vim_free(prefixed);
4745 }
4746 }
4747 }
4748 }
4749 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004751 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752 goto erret;
4753 }
4754
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004755 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004756 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004758 char_u *uname = untrans_function_name(name);
4759
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004760 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004761 }
4762
4763 if (fp != NULL || import != NULL)
4764 {
4765 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004766
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004767 // Function can be replaced with "function!" and when sourcing the
4768 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004769 // A name that is used by an import can not be overruled.
4770 if (import != NULL
4771 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004772 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004773 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004775 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004776 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004777 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004778 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004779 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780 goto erret;
4781 }
4782 if (fp->uf_calls > 0)
4783 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004784 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004785 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 goto erret;
4787 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004788 if (fp->uf_refcount > 1)
4789 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004790 // This function is referenced somewhere, don't redefine it but
4791 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004792 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004793 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004794 fp = NULL;
4795 overwrite = TRUE;
4796 }
4797 else
4798 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004799 char_u *exp_name = fp->uf_name_exp;
4800
4801 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004802 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004803 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004804 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004805 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004806 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004807#ifdef FEAT_PROFILE
4808 fp->uf_profiling = FALSE;
4809 fp->uf_prof_initialized = FALSE;
4810#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004811 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004812 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 }
4814 }
4815 else
4816 {
4817 char numbuf[20];
4818
4819 fp = NULL;
4820 if (fudi.fd_newkey == NULL && !eap->forceit)
4821 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004822 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823 goto erret;
4824 }
4825 if (fudi.fd_di == NULL)
4826 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004827 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004828 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 goto erret;
4830 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004831 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004832 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 goto erret;
4834
Bram Moolenaare38eab22019-12-05 21:50:01 +01004835 // Give the function a sequential number. Can only be used with a
4836 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004837 vim_free(name);
4838 sprintf(numbuf, "%d", ++func_nr);
4839 name = vim_strsave((char_u *)numbuf);
4840 if (name == NULL)
4841 goto erret;
4842 }
4843
4844 if (fp == NULL)
4845 {
4846 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4847 {
4848 int slen, plen;
4849 char_u *scriptname;
4850
Bram Moolenaare38eab22019-12-05 21:50:01 +01004851 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004852 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004853 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004854 {
4855 scriptname = autoload_name(name);
4856 if (scriptname != NULL)
4857 {
4858 p = vim_strchr(scriptname, '/');
4859 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004860 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004861 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004862 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004863 j = OK;
4864 vim_free(scriptname);
4865 }
4866 }
4867 if (j == FAIL)
4868 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004869 linenr_T save_lnum = SOURCING_LNUM;
4870
4871 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004872 semsg(_(e_function_name_does_not_match_script_file_name_str),
4873 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004874 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875 goto erret;
4876 }
4877 }
4878
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004879 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880 if (fp == NULL)
4881 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004882 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004883
4884 if (fudi.fd_dict != NULL)
4885 {
4886 if (fudi.fd_di == NULL)
4887 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004888 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004889 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4890 if (fudi.fd_di == NULL)
4891 {
4892 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004893 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894 goto erret;
4895 }
4896 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4897 {
4898 vim_free(fudi.fd_di);
4899 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004900 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 goto erret;
4902 }
4903 }
4904 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004905 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906 clear_tv(&fudi.fd_di->di_tv);
4907 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004909
Bram Moolenaare38eab22019-12-05 21:50:01 +01004910 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911 flags |= FC_DICT;
4912 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 }
4914 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004915 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004916 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004917 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004918
4919 if (eap->cmdidx == CMD_def)
4920 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004921 int lnum_save = SOURCING_LNUM;
4922 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004923
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004924 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004925
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004926 // error messages are for the first function line
4927 SOURCING_LNUM = sourcing_lnum_top;
4928
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004929 // The function may use script variables from the context.
4930 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004931
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004932 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004933 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004934 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004935 free_fp = fp_allocated;
4936 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004937 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004938 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004939
4940 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004941 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004942 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004943 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004944 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004945 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004946 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004947 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004948 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004949 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004950 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004951
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004952 if (fp_allocated)
4953 {
4954 // insert the new function in the function list
4955 set_ufunc_name(fp, name);
4956 if (overwrite)
4957 {
4958 hi = hash_find(&func_hashtab, name);
4959 hi->hi_key = UF2HIKEY(fp);
4960 }
4961 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4962 {
4963 free_fp = TRUE;
4964 goto erret;
4965 }
4966 fp->uf_refcount = 1;
4967 }
4968
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004970 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004971 if ((flags & FC_CLOSURE) != 0)
4972 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004973 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004974 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004975 }
4976 else
4977 fp->uf_scoped = NULL;
4978
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980 if (prof_def_func())
4981 func_do_profile(fp);
4982#endif
4983 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004984 if (sandbox)
4985 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004986 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004987 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988 fp->uf_flags = flags;
4989 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004990 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004991 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004992 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004993 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004994 if (is_export)
4995 {
4996 fp->uf_flags |= FC_EXPORT;
4997 // let ex_export() know the export worked.
4998 is_export = FALSE;
4999 }
5000
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005001 if (eap->cmdidx == CMD_def)
5002 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02005003 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
5004 // :func does not use Vim9 script syntax, even in a Vim9 script file
5005 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005006
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005007 goto ret_free;
5008
5009erret:
5010 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005011 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005012 if (fp != NULL)
5013 {
5014 ga_init(&fp->uf_args);
5015 ga_init(&fp->uf_def_args);
5016 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017errret_2:
5018 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005019 if (fp != NULL)
5020 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005021 if (free_fp)
5022 {
5023 vim_free(fp);
5024 fp = NULL;
5025 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005027 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005029 if (name != name_arg)
5030 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005031 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005033
5034 return fp;
5035}
5036
5037/*
5038 * ":function"
5039 */
5040 void
5041ex_function(exarg_T *eap)
5042{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005043 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005044
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005045 ga_init2(&lines_to_free, sizeof(char_u *), 50);
5046 (void)define_function(eap, NULL, &lines_to_free);
5047 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005048}
5049
5050/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005051 * Find a function by name, including "<lambda>123".
5052 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005053 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005054 * Return NULL if not found.
5055 */
5056 ufunc_T *
5057find_func_by_name(char_u *name, compiletype_T *compile_type)
5058{
5059 char_u *arg = name;
5060 char_u *fname;
5061 ufunc_T *ufunc;
5062 int is_global = FALSE;
5063
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005064 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5065 {
5066 *compile_type = CT_PROFILE;
5067 arg = skipwhite(arg + 7);
5068 }
5069 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5070 {
5071 *compile_type = CT_DEBUG;
5072 arg = skipwhite(arg + 5);
5073 }
5074
5075 if (STRNCMP(arg, "<lambda>", 8) == 0)
5076 {
5077 arg += 8;
5078 (void)getdigits(&arg);
5079 fname = vim_strnsave(name, arg - name);
5080 }
5081 else
5082 fname = trans_function_name(&arg, &is_global, FALSE,
5083 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5084 if (fname == NULL)
5085 {
5086 semsg(_(e_invalid_argument_str), name);
5087 return NULL;
5088 }
5089 if (!ends_excmd2(name, arg))
5090 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005091 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005092 emsg(ex_errmsg(e_trailing_characters_str, arg));
5093 return NULL;
5094 }
5095
5096 ufunc = find_func(fname, is_global);
5097 if (ufunc == NULL)
5098 {
5099 char_u *p = untrans_function_name(fname);
5100
5101 if (p != NULL)
5102 // Try again without making it script-local.
5103 ufunc = find_func(p, FALSE);
5104 }
5105 vim_free(fname);
5106 if (ufunc == NULL)
5107 semsg(_(e_cannot_find_function_str), name);
5108 return ufunc;
5109}
5110
5111/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005112 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005113 * be compiled or the one specified by the argument.
5114 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005115 */
5116 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005117ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005118{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005119 ufunc_T *ufunc;
5120
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005121 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005122 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005123 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005124
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005125 ufunc = find_func_by_name(eap->arg, &compile_type);
5126 if (ufunc != NULL)
5127 {
5128 if (func_needs_compiling(ufunc, compile_type))
5129 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5130 else
5131 smsg(_("Function %s does not need compiling"), eap->arg);
5132 }
5133 }
5134 else
5135 {
5136 long todo = (long)func_hashtab.ht_used;
5137 int changed = func_hashtab.ht_changed;
5138 hashitem_T *hi;
5139
5140 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5141 {
5142 if (!HASHITEM_EMPTY(hi))
5143 {
5144 --todo;
5145 ufunc = HI2UF(hi);
5146 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5147 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5148 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005149 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005150 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5151
5152 if (func_hashtab.ht_changed != changed)
5153 {
5154 // a function has been added or removed, need to start
5155 // over
5156 todo = (long)func_hashtab.ht_used;
5157 changed = func_hashtab.ht_changed;
5158 hi = func_hashtab.ht_array;
5159 --hi;
5160 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005161 }
5162 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005163 }
5164 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005165}
5166
5167/*
5168 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5169 * Return 2 if "p" starts with "s:".
5170 * Return 0 otherwise.
5171 */
5172 int
5173eval_fname_script(char_u *p)
5174{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005175 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5176 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005177 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5178 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5179 return 5;
5180 if (p[0] == 's' && p[1] == ':')
5181 return 2;
5182 return 0;
5183}
5184
5185 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005186translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005187{
5188 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005189 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005190 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005191}
5192
5193/*
5194 * Return TRUE when "ufunc" has old-style "..." varargs
5195 * or named varargs "...name: type".
5196 */
5197 int
5198has_varargs(ufunc_T *ufunc)
5199{
5200 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201}
5202
5203/*
5204 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005205 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005206 */
5207 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005208function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209{
5210 char_u *nm = name;
5211 char_u *p;
5212 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005213 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005214 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005216 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5217 if (no_deref)
5218 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005219 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005220 nm = skipwhite(nm);
5221
Bram Moolenaare38eab22019-12-05 21:50:01 +01005222 // Only accept "funcname", "funcname ", "funcname (..." and
5223 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005224 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005225 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005226 vim_free(p);
5227 return n;
5228}
5229
Bram Moolenaar113e1072019-01-20 15:30:40 +01005230#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005231 char_u *
5232get_expanded_name(char_u *name, int check)
5233{
5234 char_u *nm = name;
5235 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005236 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005237
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005238 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005239 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005240
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005241 if (p != NULL && *nm == NUL
5242 && (!check || translated_function_exists(p, is_global)))
5243 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005244
5245 vim_free(p);
5246 return NULL;
5247}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005248#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005250/*
5251 * Function given to ExpandGeneric() to obtain the list of user defined
5252 * function names.
5253 */
5254 char_u *
5255get_user_func_name(expand_T *xp, int idx)
5256{
5257 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005258 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005259 static hashitem_T *hi;
5260 ufunc_T *fp;
5261
5262 if (idx == 0)
5263 {
5264 done = 0;
5265 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005266 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005267 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005268 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005269 {
5270 if (done++ > 0)
5271 ++hi;
5272 while (HASHITEM_EMPTY(hi))
5273 ++hi;
5274 fp = HI2UF(hi);
5275
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005276 // don't show dead, dict and lambda functions
5277 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005278 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005279 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005280
5281 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005282 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005283
5284 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005285 if (xp->xp_context != EXPAND_USER_FUNC
5286 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005287 {
5288 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005289 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005290 STRCAT(IObuff, ")");
5291 }
5292 return IObuff;
5293 }
5294 return NULL;
5295}
5296
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297/*
5298 * ":delfunction {name}"
5299 */
5300 void
5301ex_delfunction(exarg_T *eap)
5302{
5303 ufunc_T *fp = NULL;
5304 char_u *p;
5305 char_u *name;
5306 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005307 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005308
5309 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005310 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5311 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005312 vim_free(fudi.fd_newkey);
5313 if (name == NULL)
5314 {
5315 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005316 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005317 return;
5318 }
5319 if (!ends_excmd(*skipwhite(p)))
5320 {
5321 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005322 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005323 return;
5324 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005325 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005326 if (eap->nextcmd != NULL)
5327 *p = NUL;
5328
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005329 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005330 {
5331 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005332 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005333 vim_free(name);
5334 return;
5335 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005336 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005337 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005338 vim_free(name);
5339
5340 if (!eap->skip)
5341 {
5342 if (fp == NULL)
5343 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005344 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005345 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005346 return;
5347 }
5348 if (fp->uf_calls > 0)
5349 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005350 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351 return;
5352 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005353 if (fp->uf_flags & FC_VIM9)
5354 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005355 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005356 return;
5357 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005358
5359 if (fudi.fd_dict != NULL)
5360 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005361 // Delete the dict item that refers to the function, it will
5362 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005363 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5364 }
5365 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005366 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005367 // A normal function (not a numbered function or lambda) has a
5368 // refcount of 1 for the entry in the hashtable. When deleting
5369 // it and the refcount is more than one, it should be kept.
5370 // A numbered function and lambda should be kept if the refcount is
5371 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005372 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005373 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005374 // Function is still referenced somewhere. Don't free it but
5375 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005376 if (func_remove(fp))
5377 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005378 }
5379 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005380 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005381 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382 }
5383}
5384
5385/*
5386 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005387 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005388 */
5389 void
5390func_unref(char_u *name)
5391{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005392 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005393
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005394 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005395 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005396 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005397 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005398 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005400 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005401#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005402 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005403 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005404 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005405}
5406
5407/*
5408 * Unreference a Function: decrement the reference count and free it when it
5409 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005410 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005411 */
5412 void
5413func_ptr_unref(ufunc_T *fp)
5414{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005415 if (fp != NULL && (--fp->uf_refcount <= 0
5416 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5417 && fp->uf_partial->pt_refcount <= 1
5418 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005419 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005420 // Only delete it when it's not being used. Otherwise it's done
5421 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005422 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005423 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005424 }
5425}
5426
5427/*
5428 * Count a reference to a Function.
5429 */
5430 void
5431func_ref(char_u *name)
5432{
5433 ufunc_T *fp;
5434
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005435 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005436 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005437 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005438 if (fp != NULL)
5439 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005440 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005441 // Only give an error for a numbered function.
5442 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005443 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005444}
5445
5446/*
5447 * Count a reference to a Function.
5448 */
5449 void
5450func_ptr_ref(ufunc_T *fp)
5451{
5452 if (fp != NULL)
5453 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005454}
5455
5456/*
5457 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5458 * referenced from anywhere that is in use.
5459 */
5460 static int
5461can_free_funccal(funccall_T *fc, int copyID)
5462{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005463 return (fc->fc_l_varlist.lv_copyID != copyID
5464 && fc->fc_l_vars.dv_copyID != copyID
5465 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005466 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005467}
5468
5469/*
5470 * ":return [expr]"
5471 */
5472 void
5473ex_return(exarg_T *eap)
5474{
5475 char_u *arg = eap->arg;
5476 typval_T rettv;
5477 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005478 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005479
5480 if (current_funccal == NULL)
5481 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005482 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005483 return;
5484 }
5485
Bram Moolenaar844fb642021-10-23 13:32:30 +01005486 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005487 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5488
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005489 if (eap->skip)
5490 ++emsg_skip;
5491
5492 eap->nextcmd = NULL;
5493 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005494 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005495 {
5496 if (!eap->skip)
5497 returning = do_return(eap, FALSE, TRUE, &rettv);
5498 else
5499 clear_tv(&rettv);
5500 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005501 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005502 else if (!eap->skip)
5503 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005504 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005505 update_force_abort();
5506
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005507 /*
5508 * Return unless the expression evaluation has been cancelled due to an
5509 * aborting error, an interrupt, or an exception.
5510 */
5511 if (!aborting())
5512 returning = do_return(eap, FALSE, TRUE, NULL);
5513 }
5514
Bram Moolenaare38eab22019-12-05 21:50:01 +01005515 // When skipping or the return gets pending, advance to the next command
5516 // in this line (!returning). Otherwise, ignore the rest of the line.
5517 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005518 if (returning)
5519 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005520 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005521 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005522
5523 if (eap->skip)
5524 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005525 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005526}
5527
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005528 static int
5529ex_call_inner(
5530 exarg_T *eap,
5531 char_u *name,
5532 char_u **arg,
5533 char_u *startarg,
5534 funcexe_T *funcexe_init,
5535 evalarg_T *evalarg)
5536{
5537 linenr_T lnum;
5538 int doesrange;
5539 typval_T rettv;
5540 int failed = FALSE;
5541
5542 /*
5543 * When skipping, evaluate the function once, to find the end of the
5544 * arguments.
5545 * When the function takes a range, this is discovered after the first
5546 * call, and the loop is broken.
5547 */
5548 if (eap->skip)
5549 {
5550 ++emsg_skip;
5551 lnum = eap->line2; // do it once, also with an invalid range
5552 }
5553 else
5554 lnum = eap->line1;
5555 for ( ; lnum <= eap->line2; ++lnum)
5556 {
5557 funcexe_T funcexe;
5558
5559 if (!eap->skip && eap->addr_count > 0)
5560 {
5561 if (lnum > curbuf->b_ml.ml_line_count)
5562 {
5563 // If the function deleted lines or switched to another buffer
5564 // the line number may become invalid.
5565 emsg(_(e_invalid_range));
5566 break;
5567 }
5568 curwin->w_cursor.lnum = lnum;
5569 curwin->w_cursor.col = 0;
5570 curwin->w_cursor.coladd = 0;
5571 }
5572 *arg = startarg;
5573
5574 funcexe = *funcexe_init;
5575 funcexe.fe_doesrange = &doesrange;
5576 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5577 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5578 {
5579 failed = TRUE;
5580 break;
5581 }
5582 if (has_watchexpr())
5583 dbg_check_breakpoint(eap);
5584
5585 // Handle a function returning a Funcref, Dictionary or List.
5586 if (handle_subscript(arg, NULL, &rettv,
5587 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5588 {
5589 failed = TRUE;
5590 break;
5591 }
5592
5593 clear_tv(&rettv);
5594 if (doesrange || eap->skip)
5595 break;
5596
5597 // Stop when immediately aborting on error, or when an interrupt
5598 // occurred or an exception was thrown but not caught.
5599 // get_func_tv() returned OK, so that the check for trailing
5600 // characters below is executed.
5601 if (aborting())
5602 break;
5603 }
5604 if (eap->skip)
5605 --emsg_skip;
5606 return failed;
5607}
5608
5609/*
5610 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5611 * Returns FAIL or OK.
5612 */
5613 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005614ex_defer_inner(
5615 char_u *name,
5616 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005617 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005618 partial_T *partial,
5619 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005620{
5621 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005622 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005623 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005624 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005625
5626 if (current_funccal == NULL)
5627 {
5628 semsg(_(e_str_not_inside_function), "defer");
5629 return FAIL;
5630 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005631 if (partial != NULL)
5632 {
5633 if (partial->pt_dict != NULL)
5634 {
5635 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5636 return FAIL;
5637 }
5638 if (partial->pt_argc > 0)
5639 {
5640 int i;
5641
5642 partial_argc = partial->pt_argc;
5643 for (i = 0; i < partial_argc; ++i)
5644 copy_tv(&partial->pt_argv[i], &argvars[i]);
5645 }
5646 }
5647 r = get_func_arguments(arg, evalarg, FALSE,
5648 argvars + partial_argc, &argcount);
5649 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005650
5651 if (r == OK)
5652 {
5653 if (type != NULL)
5654 {
5655 // Check that the arguments are OK for the types of the funcref.
5656 r = check_argument_types(type, argvars, argcount, NULL, name);
5657 }
5658 else if (builtin_function(name, -1))
5659 {
5660 int idx = find_internal_func(name);
5661
5662 if (idx < 0)
5663 {
5664 emsg_funcname(e_unknown_function_str, name);
5665 r = FAIL;
5666 }
5667 else if (check_internal_func(idx, argcount) == -1)
5668 r = FAIL;
5669 }
5670 else
5671 {
5672 ufunc_T *ufunc = find_func(name, FALSE);
5673
5674 // we tolerate an unknown function here, it might be defined later
5675 if (ufunc != NULL)
5676 {
5677 int error = check_user_func_argcount(ufunc, argcount);
5678
5679 if (error != FCERR_UNKNOWN)
5680 {
5681 user_func_error(error, name, NULL);
5682 r = FAIL;
5683 }
5684 }
5685 }
5686 }
5687
Bram Moolenaar86d87252022-09-05 21:21:25 +01005688 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01005689 {
5690 while (--argcount >= 0)
5691 clear_tv(&argvars[argcount]);
5692 return FAIL;
5693 }
5694 return add_defer(name, argcount, argvars);
5695}
5696
5697/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01005698 * Return TRUE if currently inside a function call.
5699 * Give an error message and return FALSE when not.
5700 */
5701 int
5702can_add_defer(void)
5703{
5704 if (!in_def_function() && get_current_funccal() == NULL)
5705 {
5706 semsg(_(e_str_not_inside_function), "defer");
5707 return FALSE;
5708 }
5709 return TRUE;
5710}
5711
5712/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01005713 * Add a deferred call for "name" with arguments "argvars[argcount]".
5714 * Consumes "argvars[]".
5715 * Caller must check that in_def_function() returns TRUE or current_funccal is
5716 * not NULL.
5717 * Returns OK or FAIL.
5718 */
5719 int
5720add_defer(char_u *name, int argcount_arg, typval_T *argvars)
5721{
5722 char_u *saved_name = vim_strsave(name);
5723 int argcount = argcount_arg;
5724 defer_T *dr;
5725 int ret = FAIL;
5726
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005727 if (saved_name == NULL)
5728 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01005729 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005730 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01005731 if (add_defer_function(saved_name, argcount, argvars) == OK)
5732 argcount = 0;
5733 }
5734 else
5735 {
5736 if (current_funccal->fc_defer.ga_itemsize == 0)
5737 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
5738 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
5739 goto theend;
5740 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
5741 + current_funccal->fc_defer.ga_len++;
5742 dr->dr_name = saved_name;
5743 dr->dr_argcount = argcount;
5744 while (argcount > 0)
5745 {
5746 --argcount;
5747 dr->dr_argvars[argcount] = argvars[argcount];
5748 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005749 }
5750 ret = OK;
5751
5752theend:
5753 while (--argcount >= 0)
5754 clear_tv(&argvars[argcount]);
5755 return ret;
5756}
5757
5758/*
5759 * Invoked after a functions has finished: invoke ":defer" functions.
5760 */
Bram Moolenaar58779852022-09-06 18:31:14 +01005761 static void
5762handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005763{
5764 int idx;
5765
Bram Moolenaar58779852022-09-06 18:31:14 +01005766 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005767 {
5768 funcexe_T funcexe;
5769 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01005770 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005771 int i;
5772
5773 CLEAR_FIELD(funcexe);
5774 funcexe.fe_evaluate = TRUE;
5775
5776 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5777 call_func(dr->dr_name, -1, &rettv,
5778 dr->dr_argcount, dr->dr_argvars, &funcexe);
5779 clear_tv(&rettv);
5780 vim_free(dr->dr_name);
5781 for (i = dr->dr_argcount - 1; i >= 0; --i)
5782 clear_tv(&dr->dr_argvars[i]);
5783 }
Bram Moolenaar58779852022-09-06 18:31:14 +01005784 ga_clear(&funccal->fc_defer);
5785}
5786
5787/*
5788 * Called when exiting: call all defer functions.
5789 */
5790 void
5791invoke_all_defer(void)
5792{
5793 funccall_T *funccal;
5794
Bram Moolenaarca16c602022-09-06 18:57:08 +01005795 for (funccal = current_funccal; funccal != NULL;
5796 funccal = funccal->fc_caller)
Bram Moolenaar58779852022-09-06 18:31:14 +01005797 if (funccal->fc_ectx != NULL)
5798 {
5799 // :def function
5800 unwind_def_callstack(funccal->fc_ectx);
5801 may_invoke_defer_funcs(funccal->fc_ectx);
5802 }
5803 else
5804 {
5805 // legacy function
5806 handle_defer_one(funccal);
5807 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005808}
5809
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005810/*
5811 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005812 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005813 */
5814 void
5815ex_call(exarg_T *eap)
5816{
5817 char_u *arg = eap->arg;
5818 char_u *startarg;
5819 char_u *name;
5820 char_u *tofree;
5821 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005822 int failed = FALSE;
5823 funcdict_T fudi;
5824 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005825 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005826 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005827 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005828 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005829
Bram Moolenaare6b53242020-07-01 17:28:33 +02005830 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005831 if (eap->skip)
5832 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005833 typval_T rettv;
5834
Bram Moolenaare38eab22019-12-05 21:50:01 +01005835 // trans_function_name() doesn't work well when skipping, use eval0()
5836 // instead to skip to any following command, e.g. for:
5837 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005838 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005839 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005840 clear_tv(&rettv);
5841 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005842 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005843 return;
5844 }
5845
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005846 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005847 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005848 if (fudi.fd_newkey != NULL)
5849 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005850 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005851 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005852 vim_free(fudi.fd_newkey);
5853 }
5854 if (tofree == NULL)
5855 return;
5856
Bram Moolenaare38eab22019-12-05 21:50:01 +01005857 // Increase refcount on dictionary, it could get deleted when evaluating
5858 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005859 if (fudi.fd_dict != NULL)
5860 ++fudi.fd_dict->dv_refcount;
5861
Bram Moolenaare38eab22019-12-05 21:50:01 +01005862 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5863 // contents. For VAR_PARTIAL get its partial, unless we already have one
5864 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005865 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005866 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005867 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005868 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005869
Bram Moolenaare38eab22019-12-05 21:50:01 +01005870 // Skip white space to allow ":call func ()". Not good, but required for
5871 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005872 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005873 if (*startarg != '(')
5874 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005875 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005876 goto end;
5877 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005878 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005879 {
5880 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5881 goto end;
5882 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005883
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005884 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005885 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005886 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01005887 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005888 }
5889 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005890 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005891 funcexe_T funcexe;
5892
Bram Moolenaara80faa82020-04-12 19:37:17 +02005893 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005894 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005895 funcexe.fe_partial = partial;
5896 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005897 funcexe.fe_firstline = eap->line1;
5898 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005899 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005900 funcexe.fe_evaluate = !eap->skip;
5901 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005902 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005903
Bram Moolenaar1d341892021-09-18 15:25:52 +02005904 // When inside :try we need to check for following "| catch" or "| endtry".
5905 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005906 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005907 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005908 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005909 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005910 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005911 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005912 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005913 {
5914 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005915 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005917 }
5918 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005919 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005920 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005921 // Must be after using "arg", it may point into memory cleared here.
5922 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005923
5924end:
5925 dict_unref(fudi.fd_dict);
5926 vim_free(tofree);
5927}
5928
5929/*
5930 * Return from a function. Possibly makes the return pending. Also called
5931 * for a pending return at the ":endtry" or after returning from an extra
5932 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5933 * when called due to a ":return" command. "rettv" may point to a typval_T
5934 * with the return rettv. Returns TRUE when the return can be carried out,
5935 * FALSE when the return gets pending.
5936 */
5937 int
5938do_return(
5939 exarg_T *eap,
5940 int reanimate,
5941 int is_cmd,
5942 void *rettv)
5943{
5944 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005945 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005946
5947 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005948 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005949 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005950
5951 /*
5952 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5953 * not in its finally clause (which then is to be executed next) is found.
5954 * In this case, make the ":return" pending for execution at the ":endtry".
5955 * Otherwise, return normally.
5956 */
5957 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5958 if (idx >= 0)
5959 {
5960 cstack->cs_pending[idx] = CSTP_RETURN;
5961
5962 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005963 // A pending return again gets pending. "rettv" points to an
5964 // allocated variable with the rettv of the original ":return"'s
5965 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005966 cstack->cs_rettv[idx] = rettv;
5967 else
5968 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005969 // When undoing a return in order to make it pending, get the stored
5970 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005971 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01005972 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005973
5974 if (rettv != NULL)
5975 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005976 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005977 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5978 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5979 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005980 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005981 }
5982 else
5983 cstack->cs_rettv[idx] = NULL;
5984
5985 if (reanimate)
5986 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005987 // The pending return value could be overwritten by a ":return"
5988 // without argument in a finally clause; reset the default
5989 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005990 current_funccal->fc_rettv->v_type = VAR_NUMBER;
5991 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005992 }
5993 }
5994 report_make_pending(CSTP_RETURN, rettv);
5995 }
5996 else
5997 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01005998 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005999
Bram Moolenaare38eab22019-12-05 21:50:01 +01006000 // If the return is carried out now, store the return value. For
6001 // a return immediately after reanimation, the value is already
6002 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006003 if (!reanimate && rettv != NULL)
6004 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006005 clear_tv(current_funccal->fc_rettv);
6006 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006007 if (!is_cmd)
6008 vim_free(rettv);
6009 }
6010 }
6011
6012 return idx < 0;
6013}
6014
6015/*
6016 * Free the variable with a pending return value.
6017 */
6018 void
6019discard_pending_return(void *rettv)
6020{
6021 free_tv((typval_T *)rettv);
6022}
6023
6024/*
6025 * Generate a return command for producing the value of "rettv". The result
6026 * is an allocated string. Used by report_pending() for verbose messages.
6027 */
6028 char_u *
6029get_return_cmd(void *rettv)
6030{
6031 char_u *s = NULL;
6032 char_u *tofree = NULL;
6033 char_u numbuf[NUMBUFLEN];
6034
6035 if (rettv != NULL)
6036 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6037 if (s == NULL)
6038 s = (char_u *)"";
6039
6040 STRCPY(IObuff, ":return ");
6041 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6042 if (STRLEN(s) + 8 >= IOSIZE)
6043 STRCPY(IObuff + IOSIZE - 4, "...");
6044 vim_free(tofree);
6045 return vim_strsave(IObuff);
6046}
6047
6048/*
6049 * Get next function line.
6050 * Called by do_cmdline() to get the next line.
6051 * Returns allocated string, or NULL for end of function.
6052 */
6053 char_u *
6054get_func_line(
6055 int c UNUSED,
6056 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006057 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006058 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006059{
6060 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006061 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006062 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006063 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006064
Bram Moolenaare38eab22019-12-05 21:50:01 +01006065 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006066 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006067 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006068 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006069 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006070 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006071 }
6072#ifdef FEAT_PROFILE
6073 if (do_profiling == PROF_YES)
6074 func_line_end(cookie);
6075#endif
6076
6077 gap = &fp->uf_lines;
6078 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006079 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006080 retval = NULL;
6081 else
6082 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006083 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006084 while (fcp->fc_linenr < gap->ga_len
6085 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6086 ++fcp->fc_linenr;
6087 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006088 retval = NULL;
6089 else
6090 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006091 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6092 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006093#ifdef FEAT_PROFILE
6094 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006095 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006096#endif
6097 }
6098 }
6099
Bram Moolenaare38eab22019-12-05 21:50:01 +01006100 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006101 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006102 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006103 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006104 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006105 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006106 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006107 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006108 }
6109
6110 return retval;
6111}
6112
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006113/*
6114 * Return TRUE if the currently active function should be ended, because a
6115 * return was encountered or an error occurred. Used inside a ":while".
6116 */
6117 int
6118func_has_ended(void *cookie)
6119{
6120 funccall_T *fcp = (funccall_T *)cookie;
6121
Bram Moolenaare38eab22019-12-05 21:50:01 +01006122 // Ignore the "abort" flag if the abortion behavior has been changed due to
6123 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006124 return (((fcp->fc_func->uf_flags & FC_ABORT)
6125 && did_emsg && !aborted_in_try())
6126 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006127}
6128
6129/*
6130 * return TRUE if cookie indicates a function which "abort"s on errors.
6131 */
6132 int
6133func_has_abort(
6134 void *cookie)
6135{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006136 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006137}
6138
6139
6140/*
6141 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6142 * Don't do this when "Func" is already a partial that was bound
6143 * explicitly (pt_auto is FALSE).
6144 * Changes "rettv" in-place.
6145 * Returns the updated "selfdict_in".
6146 */
6147 dict_T *
6148make_partial(dict_T *selfdict_in, typval_T *rettv)
6149{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006150 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006151 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006152 char_u fname_buf[FLEN_FIXED + 1];
6153 int error;
6154 dict_T *selfdict = selfdict_in;
6155
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006156 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6157 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006158 fp = rettv->vval.v_partial->pt_func;
6159 else
6160 {
6161 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006162 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006163 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006164 if (fname == NULL)
6165 {
6166 // There is no point binding a dict to a NULL function, just create
6167 // a function reference.
6168 rettv->v_type = VAR_FUNC;
6169 rettv->vval.v_string = NULL;
6170 }
6171 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006172 {
6173 char_u *tofree = NULL;
6174
6175 // Translate "s:func" to the stored function name.
6176 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6177 fp = find_func(fname, FALSE);
6178 vim_free(tofree);
6179 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006180 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006181
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006182 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006183 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006184 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006185
6186 if (pt != NULL)
6187 {
6188 pt->pt_refcount = 1;
6189 pt->pt_dict = selfdict;
6190 pt->pt_auto = TRUE;
6191 selfdict = NULL;
6192 if (rettv->v_type == VAR_FUNC)
6193 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006194 // Just a function: Take over the function name and use
6195 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006196 pt->pt_name = rettv->vval.v_string;
6197 }
6198 else
6199 {
6200 partial_T *ret_pt = rettv->vval.v_partial;
6201 int i;
6202
Bram Moolenaare38eab22019-12-05 21:50:01 +01006203 // Partial: copy the function name, use selfdict and copy
6204 // args. Can't take over name or args, the partial might
6205 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006206 if (ret_pt->pt_name != NULL)
6207 {
6208 pt->pt_name = vim_strsave(ret_pt->pt_name);
6209 func_ref(pt->pt_name);
6210 }
6211 else
6212 {
6213 pt->pt_func = ret_pt->pt_func;
6214 func_ptr_ref(pt->pt_func);
6215 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006216 if (ret_pt->pt_argc > 0)
6217 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006218 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006219 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006220 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006221 pt->pt_argc = 0;
6222 else
6223 {
6224 pt->pt_argc = ret_pt->pt_argc;
6225 for (i = 0; i < pt->pt_argc; i++)
6226 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6227 }
6228 }
6229 partial_unref(ret_pt);
6230 }
6231 rettv->v_type = VAR_PARTIAL;
6232 rettv->vval.v_partial = pt;
6233 }
6234 }
6235 return selfdict;
6236}
6237
6238/*
6239 * Return the name of the executed function.
6240 */
6241 char_u *
6242func_name(void *cookie)
6243{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006244 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006245}
6246
6247/*
6248 * Return the address holding the next breakpoint line for a funccall cookie.
6249 */
6250 linenr_T *
6251func_breakpoint(void *cookie)
6252{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006253 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006254}
6255
6256/*
6257 * Return the address holding the debug tick for a funccall cookie.
6258 */
6259 int *
6260func_dbg_tick(void *cookie)
6261{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006262 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006263}
6264
6265/*
6266 * Return the nesting level for a funccall cookie.
6267 */
6268 int
6269func_level(void *cookie)
6270{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006271 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006272}
6273
6274/*
6275 * Return TRUE when a function was ended by a ":return" command.
6276 */
6277 int
6278current_func_returned(void)
6279{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006280 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006281}
6282
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006283 int
6284free_unref_funccal(int copyID, int testing)
6285{
6286 int did_free = FALSE;
6287 int did_free_funccal = FALSE;
6288 funccall_T *fc, **pfc;
6289
6290 for (pfc = &previous_funccal; *pfc != NULL; )
6291 {
6292 if (can_free_funccal(*pfc, copyID))
6293 {
6294 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006295 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006296 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006297 did_free = TRUE;
6298 did_free_funccal = TRUE;
6299 }
6300 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006301 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006302 }
6303 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006304 // When a funccal was freed some more items might be garbage
6305 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006306 (void)garbage_collect(testing);
6307
6308 return did_free;
6309}
6310
6311/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006312 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006313 */
6314 static funccall_T *
6315get_funccal(void)
6316{
6317 int i;
6318 funccall_T *funccal;
6319 funccall_T *temp_funccal;
6320
6321 funccal = current_funccal;
6322 if (debug_backtrace_level > 0)
6323 {
6324 for (i = 0; i < debug_backtrace_level; i++)
6325 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006326 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006327 if (temp_funccal)
6328 funccal = temp_funccal;
6329 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006330 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006331 debug_backtrace_level = i;
6332 }
6333 }
6334 return funccal;
6335}
6336
6337/*
6338 * Return the hashtable used for local variables in the current funccal.
6339 * Return NULL if there is no current funccal.
6340 */
6341 hashtab_T *
6342get_funccal_local_ht()
6343{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006344 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006345 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006346 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006347}
6348
6349/*
6350 * Return the l: scope variable.
6351 * Return NULL if there is no current funccal.
6352 */
6353 dictitem_T *
6354get_funccal_local_var()
6355{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006356 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006357 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006358 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006359}
6360
6361/*
6362 * Return the hashtable used for argument in the current funccal.
6363 * Return NULL if there is no current funccal.
6364 */
6365 hashtab_T *
6366get_funccal_args_ht()
6367{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006368 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006369 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006370 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006371}
6372
6373/*
6374 * Return the a: scope variable.
6375 * Return NULL if there is no current funccal.
6376 */
6377 dictitem_T *
6378get_funccal_args_var()
6379{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006380 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006381 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006382 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006383}
6384
6385/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006386 * List function variables, if there is a function.
6387 */
6388 void
6389list_func_vars(int *first)
6390{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006391 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6392 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006393 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006394}
6395
6396/*
6397 * If "ht" is the hashtable for local variables in the current funccal, return
6398 * the dict that contains it.
6399 * Otherwise return NULL.
6400 */
6401 dict_T *
6402get_current_funccal_dict(hashtab_T *ht)
6403{
6404 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006405 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6406 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006407 return NULL;
6408}
6409
6410/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006411 * Search hashitem in parent scope.
6412 */
6413 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006414find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006415{
6416 funccall_T *old_current_funccal = current_funccal;
6417 hashtab_T *ht;
6418 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006419 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006420
Bram Moolenaarca16c602022-09-06 18:57:08 +01006421 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006422 return NULL;
6423
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006424 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006425 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006426 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006427 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006428 ht = find_var_ht(name, &varname);
6429 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006430 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006431 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006432 if (!HASHITEM_EMPTY(hi))
6433 {
6434 *pht = ht;
6435 break;
6436 }
6437 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006438 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006439 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006440 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006441 }
6442 current_funccal = old_current_funccal;
6443
6444 return hi;
6445}
6446
6447/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006448 * Search variable in parent scope.
6449 */
6450 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006451find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006452{
6453 dictitem_T *v = NULL;
6454 funccall_T *old_current_funccal = current_funccal;
6455 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006456 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006457
Bram Moolenaarca16c602022-09-06 18:57:08 +01006458 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006459 return NULL;
6460
Bram Moolenaare38eab22019-12-05 21:50:01 +01006461 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006462 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006463 while (current_funccal)
6464 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006465 ht = find_var_ht(name, &varname);
6466 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006467 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006468 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006469 if (v != NULL)
6470 break;
6471 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006472 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006473 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006474 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006475 }
6476 current_funccal = old_current_funccal;
6477
6478 return v;
6479}
6480
6481/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006482 * Set "copyID + 1" in previous_funccal and callers.
6483 */
6484 int
6485set_ref_in_previous_funccal(int copyID)
6486{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006487 funccall_T *fc;
6488
Bram Moolenaarca16c602022-09-06 18:57:08 +01006489 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006490 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006491 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006492 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6493 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6494 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006495 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006496 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006497 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006498}
6499
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006500 static int
6501set_ref_in_funccal(funccall_T *fc, int copyID)
6502{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006503 if (fc->fc_copyID != copyID)
6504 {
6505 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006506 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6507 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6508 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6509 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006510 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006511 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006512 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006513}
6514
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006515/*
6516 * Set "copyID" in all local vars and arguments in the call stack.
6517 */
6518 int
6519set_ref_in_call_stack(int copyID)
6520{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006521 funccall_T *fc;
6522 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006523
Bram Moolenaarca16c602022-09-06 18:57:08 +01006524 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006525 if (set_ref_in_funccal(fc, copyID))
6526 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006527
6528 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006529 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006530 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006531 if (set_ref_in_funccal(fc, copyID))
6532 return TRUE;
6533 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006534}
6535
6536/*
6537 * Set "copyID" in all functions available by name.
6538 */
6539 int
6540set_ref_in_functions(int copyID)
6541{
6542 int todo;
6543 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006544 ufunc_T *fp;
6545
6546 todo = (int)func_hashtab.ht_used;
6547 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006548 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006549 if (!HASHITEM_EMPTY(hi))
6550 {
6551 --todo;
6552 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006553 if (!func_name_refcount(fp->uf_name)
6554 && set_ref_in_func(NULL, fp, copyID))
6555 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006556 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006557 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006558 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006559}
6560
6561/*
6562 * Set "copyID" in all function arguments.
6563 */
6564 int
6565set_ref_in_func_args(int copyID)
6566{
6567 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006568
6569 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006570 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6571 copyID, NULL, NULL))
6572 return TRUE;
6573 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006574}
6575
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006576/*
6577 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006578 * Returns TRUE if setting references failed somehow.
6579 */
6580 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006581set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006582{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006583 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006584 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006585 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006586 char_u fname_buf[FLEN_FIXED + 1];
6587 char_u *tofree = NULL;
6588 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006589 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006590
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006591 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006592 return FALSE;
6593
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006594 if (fp_in == NULL)
6595 {
6596 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006597 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006598 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006599 if (fp != NULL)
6600 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006601 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006602 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006603 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006604
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006605 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006606 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006607}
6608
Bram Moolenaare38eab22019-12-05 21:50:01 +01006609#endif // FEAT_EVAL