blob: 00c17b8c002891549e05260c5332d61c462cd623 [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 Moolenaara9b579f2016-07-17 18:29:19 +020036
37 void
38func_init()
39{
40 hash_init(&func_hashtab);
41}
42
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020043/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020044 * Return the function hash table
45 */
46 hashtab_T *
47func_tbl_get(void)
48{
49 return &func_hashtab;
50}
51
52/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020053 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020054 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010055 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010056 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaardce24412022-02-08 20:35:30 +000057 * If "eap" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010067 evalarg_T *evalarg,
Bram Moolenaardce24412022-02-08 20:35:30 +000068 exarg_T *eap,
Bram Moolenaar2a389082021-04-09 20:24:31 +020069 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010070 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010071{
Bram Moolenaar6e949782020-04-13 17:21:00 +020072 char_u *p = arg;
73 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020074 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010075
76 while (ASCII_ISALNUM(*p) || *p == '_')
77 ++p;
78 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020079 || (argtypes == NULL
80 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
81 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010082 {
83 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000084 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010085 return arg;
86 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010087
Bram Moolenaar057e84a2021-02-28 16:55:11 +010088 // Vim9 script: cannot use script var name for argument. In function: also
89 // check local vars and arguments.
90 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
Bram Moolenaardce24412022-02-08 20:35:30 +000091 evalarg == NULL ? NULL : evalarg->eval_cctx,
92 eap == NULL ? NULL : eap->cstack, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010093 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010095 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
96 return arg;
97 if (newargs != NULL)
98 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010099 int c;
100 int i;
101
102 c = *p;
103 *p = NUL;
104 arg_copy = vim_strsave(arg);
105 if (arg_copy == NULL)
106 {
107 *p = c;
108 return arg;
109 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200110 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200111 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200112 // Check for duplicate argument name.
113 for (i = 0; i < newargs->ga_len; ++i)
114 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
115 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000116 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200117 vim_free(arg_copy);
118 return arg;
119 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100120 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
121 newargs->ga_len++;
122
123 *p = c;
124 }
125
126 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100127 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100128 {
129 char_u *type = NULL;
130
Bram Moolenaar6e949782020-04-13 17:21:00 +0200131 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
132 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200133 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200134 arg_copy == NULL ? arg : arg_copy);
135 p = skipwhite(p);
136 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100137 if (*p == ':')
138 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200139 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100140 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200141 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100142 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200143 return arg;
144 }
145 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200146 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100147 if (!skip)
148 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100149 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200150 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200151 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200152 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200153 arg_copy == NULL ? arg : arg_copy);
154 return arg;
155 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100156 if (!skip)
157 {
158 if (type == NULL && types_optional)
159 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200160 type = vim_strsave((char_u *)
161 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100162 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
163 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100164 }
165
166 return p;
167}
168
169/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000170 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000171 * Get a next line, store it in "eap" if appropriate and put the line in
172 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000173 */
174 static char_u *
175get_function_line(
176 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000177 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000178 int indent,
179 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000180{
181 char_u *theline;
182
183 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000184 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000185 else
186 theline = eap->getline(':', eap->cookie, indent, getline_options);
187 if (theline != NULL)
188 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000189 if (lines_to_free->ga_len > 0
190 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
191 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000192 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000193 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000194 }
195
196 return theline;
197}
198
199/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200200 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100201 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100202 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200203 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100204 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200205get_function_args(
206 char_u **argp,
207 char_u endchar,
208 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100209 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100210 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100211 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200212 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200213 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200214 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000215 exarg_T *eap, // can be NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000216 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200217{
218 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100219 char_u *arg;
220 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200221 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200222 int any_default = FALSE;
223 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100224 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200225
226 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000227 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000229 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200230 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000231 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200232
233 if (varargs != NULL)
234 *varargs = FALSE;
235
236 /*
237 * Isolate the arguments: "arg1, arg2, ...)"
238 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100239 arg = skipwhite(*argp);
240 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200241 while (*p != endchar)
242 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200243 while (eap != NULL && eap->getline != NULL
244 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200245 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200246 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000247 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000248 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000249
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200250 if (theline == NULL)
251 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200252 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200253 p = skipwhite(theline);
254 }
255
256 if (mustend && *p != endchar)
257 {
258 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000259 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100260 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200261 }
262 if (*p == endchar)
263 break;
264
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200265 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
266 {
267 if (varargs != NULL)
268 *varargs = TRUE;
269 p += 3;
270 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100271
272 if (argtypes != NULL)
273 {
274 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200275 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100276 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100277 if (!skip)
278 emsg(_(e_missing_name_after_dots));
279 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100280 }
281
282 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100283 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000284 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100285 if (p == arg)
286 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100287 if (*skipwhite(p) == '=')
288 {
289 emsg(_(e_cannot_use_default_for_variable_arguments));
290 break;
291 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100292 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200293 }
294 else
295 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200296 char_u *np;
297
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200298 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100299 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000300 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100301 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200302 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200303
Bram Moolenaar015cf102021-06-26 21:52:02 +0200304 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200305 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200306 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200307 if (*np == '=' && np[1] != '=' && np[1] != '~'
308 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200309 {
310 typval_T rettv;
311
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100312 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200313 any_default = TRUE;
314 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200315 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200316 p = skipwhite(p);
317 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200318 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200319 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200320 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200321 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200322 if (ga_grow(default_args, 1) == FAIL)
323 goto err_ret;
324
325 // trim trailing whitespace
326 while (p > expr && VIM_ISWHITE(p[-1]))
327 p--;
328 c = *p;
329 *p = NUL;
330 expr = vim_strsave(expr);
331 if (expr == NULL)
332 {
333 *p = c;
334 goto err_ret;
335 }
336 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200337 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200338 default_args->ga_len++;
339 *p = c;
340 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200341 }
342 else
343 mustend = TRUE;
344 }
345 else if (any_default)
346 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000347 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200348 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200349 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200350
351 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
352 {
353 // Be tolerant when skipping
354 if (!skip)
355 {
356 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
357 goto err_ret;
358 }
359 p = skipwhite(p);
360 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200361 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200362 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200363 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200364 // Don't give this error when skipping, it makes the "->" not
365 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100366 // Allow missing space after comma in legacy functions.
367 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200368 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
369 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100370 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200371 goto err_ret;
372 }
373 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200374 else
375 mustend = TRUE;
376 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200377 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200378 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200379 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200380
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200381 if (*p != endchar)
382 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100383 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200384
385 *argp = p;
386 return OK;
387
388err_ret:
389 if (newargs != NULL)
390 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200391 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200392 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200393 return FAIL;
394}
395
396/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100397 * Parse the argument types, filling "fp->uf_arg_types".
398 * Return OK or FAIL.
399 */
400 static int
401parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
402{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200403 int len = 0;
404
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100405 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
406 if (argtypes->ga_len > 0)
407 {
408 // When "varargs" is set the last name/type goes into uf_va_name
409 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200410 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100411
412 if (len > 0)
413 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
414 if (fp->uf_arg_types != NULL)
415 {
416 int i;
417 type_T *type;
418
419 for (i = 0; i < len; ++ i)
420 {
421 char_u *p = ((char_u **)argtypes->ga_data)[i];
422
423 if (p == NULL)
424 // will get the type from the default value
425 type = &t_unknown;
426 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100427 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100428 if (type == NULL)
429 return FAIL;
430 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000431 if (i < fp->uf_args.ga_len
432 && (type->tt_type == VAR_FUNC
433 || type->tt_type == VAR_PARTIAL)
434 && var_wrong_func_name(
435 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
436 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100437 }
438 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100439 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200440
441 if (varargs)
442 {
443 char_u *p;
444
445 // Move the last argument "...name: type" to uf_va_name and
446 // uf_va_type.
447 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
448 [fp->uf_args.ga_len - 1];
449 --fp->uf_args.ga_len;
450 p = ((char_u **)argtypes->ga_data)[len];
451 if (p == NULL)
452 // TODO: get type from default value
453 fp->uf_va_type = &t_list_any;
454 else
455 {
456 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
457 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
458 {
459 semsg(_(e_variable_arguments_type_must_be_list_str),
460 ((char_u **)argtypes->ga_data)[len]);
461 return FAIL;
462 }
463 }
464 if (fp->uf_va_type == NULL)
465 return FAIL;
466 }
467
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100468 return OK;
469}
470
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100471 static int
472parse_return_type(ufunc_T *fp, char_u *ret_type)
473{
474 if (ret_type == NULL)
475 fp->uf_ret_type = &t_void;
476 else
477 {
478 char_u *p = ret_type;
479
480 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
481 if (fp->uf_ret_type == NULL)
482 {
483 fp->uf_ret_type = &t_void;
484 return FAIL;
485 }
486 }
487 return OK;
488}
489
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100490/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200491 * Register function "fp" as using "current_funccal" as its scope.
492 */
493 static int
494register_closure(ufunc_T *fp)
495{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200496 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100497 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200498 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200499 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200500 fp->uf_scoped = current_funccal;
501 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200502
Bram Moolenaar58016442016-07-31 18:30:22 +0200503 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
504 return FAIL;
505 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
506 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200507 return OK;
508}
509
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100510 static void
511set_ufunc_name(ufunc_T *fp, char_u *name)
512{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100513 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
514 // actually extends beyond the struct.
515 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100516
517 if (name[0] == K_SPECIAL)
518 {
519 fp->uf_name_exp = alloc(STRLEN(name) + 3);
520 if (fp->uf_name_exp != NULL)
521 {
522 STRCPY(fp->uf_name_exp, "<SNR>");
523 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
524 }
525 }
526}
527
Bram Moolenaar58016442016-07-31 18:30:22 +0200528/*
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100529 * If "name" starts with K_SPECIAL and "buf[bufsize]" is big enough
530 * return "buf" filled with a readable function name.
531 * Otherwise just return "name", thus the return value can always be used.
532 * "name" and "buf" may be equal.
533 */
534 char_u *
535make_ufunc_name_readable(char_u *name, char_u *buf, size_t bufsize)
536{
537 size_t len;
538
539 if (name[0] != K_SPECIAL)
540 return name;
541 len = STRLEN(name);
542 if (len + 3 > bufsize)
543 return name;
544
Bram Moolenaar96e08e02022-03-31 21:40:33 +0100545 mch_memmove(buf + 5, name + 3, len - 2); // Include trailing NUL
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100546 mch_memmove(buf, "<SNR>", 5);
547 return buf;
548}
549
550/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200551 * Get a name for a lambda. Returned in static memory.
552 */
553 char_u *
554get_lambda_name(void)
555{
556 static char_u name[30];
557 static int lambda_no = 0;
558
559 sprintf((char*)name, "<lambda>%d", ++lambda_no);
560 return name;
561}
562
Bram Moolenaar801ab062020-06-25 19:27:56 +0200563#if defined(FEAT_LUA) || defined(PROTO)
564/*
565 * Registers a native C callback which can be called from Vim script.
566 * Returns the name of the Vim script function.
567 */
568 char_u *
569register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
570{
571 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200572 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200573
574 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
575 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200576 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200577
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200578 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200579 fp->uf_refcount = 1;
580 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000581 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200582 fp->uf_calls = 0;
583 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200584 fp->uf_cb = cb;
585 fp->uf_cb_free = cb_free;
586 fp->uf_cb_state = state;
587
588 set_ufunc_name(fp, name);
589 hash_add(&func_hashtab, UF2HIKEY(fp));
590
591 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200592}
593#endif
594
Bram Moolenaar04b12692020-05-04 23:24:44 +0200595/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100596 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100597 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100598 * If "white_error" is not NULL check for correct use of white space and set
599 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100600 * Return NULL if no valid arrow found.
601 */
602 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100603skip_arrow(
604 char_u *start,
605 int equal_arrow,
606 char_u **ret_type,
607 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100608{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100609 char_u *s = start;
610 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100611
612 if (equal_arrow)
613 {
614 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100615 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100616 if (white_error != NULL && !VIM_ISWHITE(s[1]))
617 {
618 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100619 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100620 return NULL;
621 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100622 s = skipwhite(s + 1);
623 *ret_type = s;
624 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100625 if (s == *ret_type)
626 {
627 emsg(_(e_missing_return_type));
628 return NULL;
629 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100630 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100631 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100632 s = skipwhite(s);
633 if (*s != '=')
634 return NULL;
635 ++s;
636 }
637 if (*s != '>')
638 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100639 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
640 || !IS_WHITE_OR_NUL(s[1])))
641 {
642 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100643 semsg(_(e_white_space_required_before_and_after_str_at_str),
644 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100645 return NULL;
646 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100647 return skipwhite(s + 1);
648}
649
650/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100651 * Check if "*cmd" points to a function command and if so advance "*cmd" and
652 * return TRUE.
653 * Otherwise return FALSE;
654 * Do not consider "function(" to be a command.
655 */
656 static int
657is_function_cmd(char_u **cmd)
658{
659 char_u *p = *cmd;
660
661 if (checkforcmd(&p, "function", 2))
662 {
663 if (*p == '(')
664 return FALSE;
665 *cmd = p;
666 return TRUE;
667 }
668 return FALSE;
669}
670
671/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200672 * Called when defining a function: The context may be needed for script
673 * variables declared in a block that is visible now but not when the function
674 * is compiled or called later.
675 */
676 static void
677function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
678{
679 if (cstack != NULL && cstack->cs_idx >= 0)
680 {
681 int count = cstack->cs_idx + 1;
682 int i;
683
684 fp->uf_block_ids = ALLOC_MULT(int, count);
685 if (fp->uf_block_ids != NULL)
686 {
687 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
688 sizeof(int) * count);
689 fp->uf_block_depth = count;
690 }
691
692 // Set flag in each block to indicate a function was defined. This
693 // is used to keep the variable when leaving the block, see
694 // hide_script_var().
695 for (i = 0; i <= cstack->cs_idx; ++i)
696 cstack->cs_flags[i] |= CSF_FUNC_DEF;
697 }
698}
699
700/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100701 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200702 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100703 * "newlines" must already have been initialized.
704 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
705 */
706 static int
707get_function_body(
708 exarg_T *eap,
709 garray_T *newlines,
710 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000711 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100712{
713 linenr_T sourcing_lnum_top = SOURCING_LNUM;
714 linenr_T sourcing_lnum_off;
715 int saved_wait_return = need_wait_return;
716 char_u *line_arg = line_arg_in;
717 int vim9_function = eap->cmdidx == CMD_def
718 || eap->cmdidx == CMD_block;
719#define MAX_FUNC_NESTING 50
720 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200721 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100722 int nesting = 0;
723 getline_opt_T getline_options;
724 int indent = 2;
725 char_u *skip_until = NULL;
726 int ret = FAIL;
727 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200728 int heredoc_concat_len = 0;
729 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100730 char_u *heredoc_trimmed = NULL;
731
Bram Moolenaar20677332021-06-06 17:02:53 +0200732 ga_init2(&heredoc_ga, 1, 500);
733
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100734 // Detect having skipped over comment lines to find the return
735 // type. Add NULL lines to keep the line count correct.
736 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
737 if (SOURCING_LNUM < sourcing_lnum_off)
738 {
739 sourcing_lnum_off -= SOURCING_LNUM;
740 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
741 goto theend;
742 while (sourcing_lnum_off-- > 0)
743 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
744 }
745
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200746 nesting_def[0] = vim9_function;
747 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100748 getline_options = vim9_function
749 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
750 for (;;)
751 {
752 char_u *theline;
753 char_u *p;
754 char_u *arg;
755
756 if (KeyTyped)
757 {
758 msg_scroll = TRUE;
759 saved_wait_return = FALSE;
760 }
761 need_wait_return = FALSE;
762
763 if (line_arg != NULL)
764 {
765 // Use eap->arg, split up in parts by line breaks.
766 theline = line_arg;
767 p = vim_strchr(theline, '\n');
768 if (p == NULL)
769 line_arg += STRLEN(line_arg);
770 else
771 {
772 *p = NUL;
773 line_arg = p + 1;
774 }
775 }
776 else
777 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000778 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100779 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100780 }
781 if (KeyTyped)
782 lines_left = Rows - 1;
783 if (theline == NULL)
784 {
785 // Use the start of the function for the line number.
786 SOURCING_LNUM = sourcing_lnum_top;
787 if (skip_until != NULL)
788 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200789 else if (nesting_inline[nesting])
790 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100791 else if (eap->cmdidx == CMD_def)
792 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100793 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000794 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100795 goto theend;
796 }
797
798 // Detect line continuation: SOURCING_LNUM increased more than one.
799 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
800 if (SOURCING_LNUM < sourcing_lnum_off)
801 sourcing_lnum_off -= SOURCING_LNUM;
802 else
803 sourcing_lnum_off = 0;
804
805 if (skip_until != NULL)
806 {
807 // Don't check for ":endfunc"/":enddef" between
808 // * ":append" and "."
809 // * ":python <<EOF" and "EOF"
810 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
811 if (heredoc_trimmed == NULL
812 || (is_heredoc && skipwhite(theline) == theline)
813 || STRNCMP(theline, heredoc_trimmed,
814 STRLEN(heredoc_trimmed)) == 0)
815 {
816 if (heredoc_trimmed == NULL)
817 p = theline;
818 else if (is_heredoc)
819 p = skipwhite(theline) == theline
820 ? theline : theline + STRLEN(heredoc_trimmed);
821 else
822 p = theline + STRLEN(heredoc_trimmed);
823 if (STRCMP(p, skip_until) == 0)
824 {
825 VIM_CLEAR(skip_until);
826 VIM_CLEAR(heredoc_trimmed);
827 getline_options = vim9_function
828 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
829 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200830
831 if (heredoc_concat_len > 0)
832 {
833 // Replace the starting line with all the concatenated
834 // lines.
835 ga_concat(&heredoc_ga, theline);
836 vim_free(((char_u **)(newlines->ga_data))[
837 heredoc_concat_len - 1]);
838 ((char_u **)(newlines->ga_data))[
839 heredoc_concat_len - 1] = heredoc_ga.ga_data;
840 ga_init(&heredoc_ga);
841 heredoc_concat_len = 0;
842 theline += STRLEN(theline); // skip the "EOF"
843 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100844 }
845 }
846 }
847 else
848 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200849 int c;
850 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000851 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100852
853 // skip ':' and blanks
854 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
855 ;
856
857 // Check for "endfunction", "enddef" or "}".
858 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000859 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200860 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100861 ? *p == '}'
862 : (checkforcmd(&p, nesting_def[nesting]
863 ? "enddef" : "endfunction", 4)
864 && *p != ':'))
865 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000866 if (!nesting_inline[nesting] && nesting_def[nesting]
867 && p < cmd + 6)
868 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100869 if (nesting-- == 0)
870 {
871 char_u *nextcmd = NULL;
872
873 if (*p == '|' || *p == '}')
874 nextcmd = p + 1;
875 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
876 nextcmd = line_arg;
877 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100878 && (vim9_function || p_verbose > 0))
879 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200880 SOURCING_LNUM = sourcing_lnum_top
881 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100882 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000883 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100884 else
885 give_warning2((char_u *)
886 _("W22: Text found after :endfunction: %s"),
887 p, TRUE);
888 }
889 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100890 {
891 // Another command follows. If the line came from "eap"
892 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000893 // change "eap->cmdlinep" to point to the last fetched
894 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100895 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000896 if (lines_to_free->ga_len > 0
897 && *eap->cmdlinep !=
898 ((char_u **)lines_to_free->ga_data)
899 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100900 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000901 // *cmdlinep will be freed later, thus remove the
902 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100903 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000904 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
905 [lines_to_free->ga_len - 1];
906 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100907 }
908 }
909 break;
910 }
911 }
912
913 // Check for mismatched "endfunc" or "enddef".
914 // We don't check for "def" inside "func" thus we also can't check
915 // for "enddef".
916 // We continue to find the end of the function, although we might
917 // not find it.
918 else if (nesting_def[nesting])
919 {
920 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
921 emsg(_(e_mismatched_endfunction));
922 }
923 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
924 emsg(_(e_mismatched_enddef));
925
926 // Increase indent inside "if", "while", "for" and "try", decrease
927 // at "end".
928 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
929 indent -= 2;
930 else if (STRNCMP(p, "if", 2) == 0
931 || STRNCMP(p, "wh", 2) == 0
932 || STRNCMP(p, "for", 3) == 0
933 || STRNCMP(p, "try", 3) == 0)
934 indent += 2;
935
936 // Check for defining a function inside this function.
937 // Only recognize "def" inside "def", not inside "function",
938 // For backwards compatibility, see Test_function_python().
939 c = *p;
940 if (is_function_cmd(&p)
941 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
942 {
943 if (*p == '!')
944 p = skipwhite(p + 1);
945 p += eval_fname_script(p);
946 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
947 NULL, NULL));
948 if (*skipwhite(p) == '(')
949 {
950 if (nesting == MAX_FUNC_NESTING - 1)
951 emsg(_(e_function_nesting_too_deep));
952 else
953 {
954 ++nesting;
955 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200956 nesting_inline[nesting] = FALSE;
957 indent += 2;
958 }
959 }
960 }
961
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200962 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200963 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200964 // Not a comment line: check for nested inline function.
965 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200966 while (end > p && VIM_ISWHITE(*end))
967 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200968 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200969 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200970 int is_block;
971
972 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200973 --end;
974 while (end > p && VIM_ISWHITE(*end))
975 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200976 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
977 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200978 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200979 char_u *s = p;
980
981 // check for line starting with "au" for :autocmd or
982 // "com" for :command, these can use a {} block
983 is_block = checkforcmd_noparen(&s, "autocmd", 2)
984 || checkforcmd_noparen(&s, "command", 3);
985 }
986
987 if (is_block)
988 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200989 if (nesting == MAX_FUNC_NESTING - 1)
990 emsg(_(e_function_nesting_too_deep));
991 else
992 {
993 ++nesting;
994 nesting_def[nesting] = TRUE;
995 nesting_inline[nesting] = TRUE;
996 indent += 2;
997 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100998 }
999 }
1000 }
1001
1002 // Check for ":append", ":change", ":insert". Not for :def.
1003 p = skip_range(p, FALSE, NULL);
1004 if (!vim9_function
1005 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1006 || (p[0] == 'c'
1007 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1008 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1009 && (STRNCMP(&p[3], "nge", 3) != 0
1010 || !ASCII_ISALPHA(p[6])))))))
1011 || (p[0] == 'i'
1012 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1013 && (!ASCII_ISALPHA(p[2])
1014 || (p[2] == 's'
1015 && (!ASCII_ISALPHA(p[3])
1016 || p[3] == 'e'))))))))
1017 skip_until = vim_strsave((char_u *)".");
1018
1019 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1020 arg = skipwhite(skiptowhite(p));
1021 if (arg[0] == '<' && arg[1] =='<'
1022 && ((p[0] == 'p' && p[1] == 'y'
1023 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1024 || ((p[2] == '3' || p[2] == 'x')
1025 && !ASCII_ISALPHA(p[3]))))
1026 || (p[0] == 'p' && p[1] == 'e'
1027 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1028 || (p[0] == 't' && p[1] == 'c'
1029 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1030 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1031 && !ASCII_ISALPHA(p[3]))
1032 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1033 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1034 || (p[0] == 'm' && p[1] == 'z'
1035 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1036 ))
1037 {
1038 // ":python <<" continues until a dot, like ":append"
1039 p = skipwhite(arg + 2);
1040 if (STRNCMP(p, "trim", 4) == 0)
1041 {
1042 // Ignore leading white space.
1043 p = skipwhite(p + 4);
1044 heredoc_trimmed = vim_strnsave(theline,
1045 skipwhite(theline) - theline);
1046 }
1047 if (*p == NUL)
1048 skip_until = vim_strsave((char_u *)".");
1049 else
1050 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1051 getline_options = GETLINE_NONE;
1052 is_heredoc = TRUE;
Bram Moolenaard881d152022-05-13 13:50:36 +01001053 if (eap->cmdidx == CMD_def && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001054 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001055 }
1056
Bram Moolenaard881d152022-05-13 13:50:36 +01001057 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001058 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001059 // Check for ":cmd v =<< [trim] EOF"
1060 // and ":cmd [a, b] =<< [trim] EOF"
1061 // and "lines =<< [trim] EOF" for Vim9
1062 // Where "cmd" can be "let", "var", "final" or "const".
1063 arg = skipwhite(skiptowhite(p));
1064 if (*arg == '[')
1065 arg = vim_strchr(arg, ']');
1066 if (arg != NULL)
1067 {
1068 int found = (eap->cmdidx == CMD_def && arg[0] == '='
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001069 && arg[1] == '<' && arg[2] =='<');
1070
Bram Moolenaard881d152022-05-13 13:50:36 +01001071 if (!found)
1072 // skip over the argument after "cmd"
1073 arg = skipwhite(skiptowhite(arg));
1074 if (found || (arg[0] == '=' && arg[1] == '<'
1075 && arg[2] =='<'
1076 && (checkforcmd(&p, "let", 2)
1077 || checkforcmd(&p, "var", 3)
1078 || checkforcmd(&p, "final", 5)
1079 || checkforcmd(&p, "const", 5))))
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001080 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001081 p = skipwhite(arg + 3);
1082 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001083 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001084 if (STRNCMP(p, "trim", 4) == 0)
1085 {
1086 // Ignore leading white space.
1087 p = skipwhite(p + 4);
1088 heredoc_trimmed = vim_strnsave(theline,
1089 skipwhite(theline) - theline);
1090 continue;
1091 }
1092 if (STRNCMP(p, "eval", 4) == 0)
1093 {
1094 // Ignore leading white space.
1095 p = skipwhite(p + 4);
1096 continue;
1097 }
1098 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001099 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001100 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1101 getline_options = GETLINE_NONE;
1102 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001103 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001104 }
1105 }
1106 }
1107
1108 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001109 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001110 goto theend;
1111
Bram Moolenaar20677332021-06-06 17:02:53 +02001112 if (heredoc_concat_len > 0)
1113 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001114 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001115 // to be used for the instruction later.
1116 ga_concat(&heredoc_ga, theline);
1117 ga_concat(&heredoc_ga, (char_u *)"\n");
1118 p = vim_strsave((char_u *)"");
1119 }
1120 else
1121 {
1122 // Copy the line to newly allocated memory. get_one_sourceline()
1123 // allocates 250 bytes per line, this saves 80% on average. The
1124 // cost is an extra alloc/free.
1125 p = vim_strsave(theline);
1126 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001127 if (p == NULL)
1128 goto theend;
1129 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1130
1131 // Add NULL lines for continuation lines, so that the line count is
1132 // equal to the index in the growarray.
1133 while (sourcing_lnum_off-- > 0)
1134 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1135
1136 // Check for end of eap->arg.
1137 if (line_arg != NULL && *line_arg == NUL)
1138 line_arg = NULL;
1139 }
1140
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001141 // Return OK when no error was detected.
1142 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001143 ret = OK;
1144
1145theend:
1146 vim_free(skip_until);
1147 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001148 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001149 need_wait_return |= saved_wait_return;
1150 return ret;
1151}
1152
1153/*
1154 * Handle the body of a lambda. *arg points to the "{", process statements
1155 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001156 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001157 * When successful "rettv" is set to a funcref.
1158 */
1159 static int
1160lambda_function_body(
1161 char_u **arg,
1162 typval_T *rettv,
1163 evalarg_T *evalarg,
1164 garray_T *newargs,
1165 garray_T *argtypes,
1166 int varargs,
1167 garray_T *default_args,
1168 char_u *ret_type)
1169{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001170 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001171 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001172 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001173 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001174 exarg_T eap;
1175 garray_T newlines;
1176 char_u *cmdline = NULL;
1177 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001178 partial_T *pt;
1179 char_u *name;
1180 int lnum_save = -1;
1181 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1182
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001183 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1184 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001185 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001186 return FAIL;
1187 }
1188
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001189 CLEAR_FIELD(eap);
1190 eap.cmdidx = CMD_block;
1191 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001192 eap.cmdlinep = &cmdline;
1193 eap.skip = !evaluate;
1194 if (evalarg->eval_cctx != NULL)
1195 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1196 else
1197 {
1198 eap.getline = evalarg->eval_getline;
1199 eap.cookie = evalarg->eval_cookie;
1200 }
1201
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001202 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001203 if (get_function_body(&eap, &newlines, NULL,
1204 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001205 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001206
1207 // When inside a lambda must add the function lines to evalarg.eval_ga.
1208 evalarg->eval_break_count += newlines.ga_len;
1209 if (gap->ga_itemsize > 0)
1210 {
1211 int idx;
1212 char_u *last;
1213 size_t plen;
1214 char_u *pnl;
1215
1216 for (idx = 0; idx < newlines.ga_len; ++idx)
1217 {
1218 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1219
Bram Moolenaarecb66452021-05-18 15:09:18 +02001220 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001221 goto erret;
1222
1223 // Going to concatenate the lines after parsing. For an empty or
1224 // comment line use an empty string.
1225 // Insert NL characters at the start of each line, the string will
1226 // be split again later in .get_lambda_tv().
1227 if (*p == NUL || vim9_comment_start(p))
1228 p = (char_u *)"";
1229 plen = STRLEN(p);
1230 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1231 if (pnl != NULL)
1232 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001233 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1234 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001235 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001236 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001237 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001238 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001239 // more is following after the "}", which was skipped
1240 last = cmdline;
1241 else
1242 // nothing is following the "}"
1243 last = (char_u *)"}";
1244 plen = STRLEN(last);
1245 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1246 if (pnl != NULL)
1247 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001248 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1249 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001250 }
1251
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001252 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001253 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001254 garray_T *tfgap = &evalarg->eval_tofree_ga;
1255
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001256 // Something comes after the "}".
1257 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001258
1259 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001260 if (ga_grow(tfgap, 1) == OK)
1261 {
1262 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1263 evalarg->eval_using_cmdline = TRUE;
1264 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001265 }
1266 else
1267 *arg = (char_u *)"";
1268
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001269 if (!evaluate)
1270 {
1271 ret = OK;
1272 goto erret;
1273 }
1274
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001275 name = get_lambda_name();
1276 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1277 if (ufunc == NULL)
1278 goto erret;
1279 set_ufunc_name(ufunc, name);
1280 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001281 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001282 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001283 ufunc->uf_refcount = 1;
1284 ufunc->uf_args = *newargs;
1285 newargs->ga_data = NULL;
1286 ufunc->uf_def_args = *default_args;
1287 default_args->ga_data = NULL;
1288 ufunc->uf_func_type = &t_func_any;
1289
1290 // error messages are for the first function line
1291 lnum_save = SOURCING_LNUM;
1292 SOURCING_LNUM = sourcing_lnum_top;
1293
1294 // parse argument types
1295 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1296 {
1297 SOURCING_LNUM = lnum_save;
1298 goto erret;
1299 }
1300
1301 // parse the return type, if any
1302 if (parse_return_type(ufunc, ret_type) == FAIL)
1303 goto erret;
1304
1305 pt = ALLOC_CLEAR_ONE(partial_T);
1306 if (pt == NULL)
1307 goto erret;
1308 pt->pt_func = ufunc;
1309 pt->pt_refcount = 1;
1310
1311 ufunc->uf_lines = newlines;
1312 newlines.ga_data = NULL;
1313 if (sandbox)
1314 ufunc->uf_flags |= FC_SANDBOX;
1315 if (!ASCII_ISUPPER(*ufunc->uf_name))
1316 ufunc->uf_flags |= FC_VIM9;
1317 ufunc->uf_script_ctx = current_sctx;
1318 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1319 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1320 set_function_type(ufunc);
1321
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001322 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1323
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001324 rettv->vval.v_partial = pt;
1325 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001326 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001327 ret = OK;
1328
1329erret:
1330 if (lnum_save >= 0)
1331 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001332 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001333 if (newargs != NULL)
1334 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001335 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001336 if (ufunc != NULL)
1337 {
1338 func_clear(ufunc, TRUE);
1339 func_free(ufunc, TRUE);
1340 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001341 return ret;
1342}
1343
1344/*
1345 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001346 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001347 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001348 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1349 */
1350 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001351get_lambda_tv(
1352 char_u **arg,
1353 typval_T *rettv,
1354 int types_optional,
1355 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001357 int evaluate = evalarg != NULL
1358 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001359 garray_T newargs;
1360 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001361 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001362 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001363 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001364 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001365 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001366 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001367 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001368 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001369 char_u *s;
1370 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001371 int *old_eval_lavars = eval_lavars_used;
1372 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001373 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001374 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001375 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001376 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001377 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001378 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001379
Bram Moolenaar4525a572022-02-13 11:57:33 +00001380 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001381 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001382
1383 ga_init(&newargs);
1384 ga_init(&newlines);
1385
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001386 // First, check if this is really a lambda expression. "->" or "=>" must
1387 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001388 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001389 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001390 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001391 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001392 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001393 {
1394 if (types_optional)
1395 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001396 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001398
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001399 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001400 if (evaluate)
1401 pnewargs = &newargs;
1402 else
1403 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001404 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001405 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001406 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001407 &varargs, &default_args,
1408 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001409 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001410 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001411 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001412 {
1413 if (types_optional)
1414 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001415 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001416 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001417 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001418 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001419
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001420 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1421 if (ret_type != NULL)
1422 {
1423 ret_type = vim_strsave(ret_type);
1424 tofree2 = ret_type;
1425 }
1426
Bram Moolenaare38eab22019-12-05 21:50:01 +01001427 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001428 if (evaluate)
1429 eval_lavars_used = &eval_lavars;
1430
Bram Moolenaar65c44152020-12-24 15:14:01 +01001431 *arg = skipwhite_and_linebreak(*arg, evalarg);
1432
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001433 // Recognize "{" as the start of a function body.
1434 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001435 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001436 if (evalarg == NULL)
1437 // cannot happen?
1438 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001439 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001440 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1441 types_optional ? &argtypes : NULL, varargs,
1442 &default_args, ret_type) == FAIL)
1443 goto errret;
1444 goto theend;
1445 }
1446 if (default_args.ga_len > 0)
1447 {
1448 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001449 goto errret;
1450 }
1451
Bram Moolenaare38eab22019-12-05 21:50:01 +01001452 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001453 start = *arg;
1454 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001455 if (ret == FAIL)
1456 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001457
Bram Moolenaar65c44152020-12-24 15:14:01 +01001458 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001459 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001460 *arg = skipwhite_and_linebreak(*arg, evalarg);
1461 if (**arg != '}')
1462 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001463 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001464 goto errret;
1465 }
1466 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001467 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001468
1469 if (evaluate)
1470 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001471 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001472 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001473 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001474 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001475 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001476
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001477 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478 if (fp == NULL)
1479 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001480 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001481 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001482 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001483 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001485 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486 if (ga_grow(&newlines, 1) == FAIL)
1487 goto errret;
1488
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001489 // If there are line breaks, we need to split up the string.
1490 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001491 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001492 line_end = end;
1493
1494 // Add "return " before the expression (or the first line).
1495 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001496 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001497 if (p == NULL)
1498 goto errret;
1499 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1500 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001501 vim_strncpy(p + 7, start, line_end - start);
1502
1503 if (line_end != end)
1504 {
1505 // Add more lines, split by line breaks. Thus is used when a
1506 // lambda with { cmds } is encountered.
1507 while (*line_end == '\n')
1508 {
1509 if (ga_grow(&newlines, 1) == FAIL)
1510 goto errret;
1511 start = line_end + 1;
1512 line_end = vim_strchr(start, '\n');
1513 if (line_end == NULL)
1514 line_end = end;
1515 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1516 vim_strnsave(start, line_end - start);
1517 }
1518 }
1519
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001520 if (strstr((char *)p + 7, "a:") == NULL)
1521 // No a: variables are used for sure.
1522 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523
1524 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001525 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001527 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001528 if (types_optional)
1529 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001530 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001531 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001532 goto errret;
1533 if (ret_type != NULL)
1534 {
1535 fp->uf_ret_type = parse_type(&ret_type,
1536 &fp->uf_type_list, TRUE);
1537 if (fp->uf_ret_type == NULL)
1538 goto errret;
1539 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001540 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001541 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001542 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001543
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001545 if (current_funccal != NULL && eval_lavars)
1546 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001547 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001548 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001549 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001550 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001551
1552#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001553 if (prof_def_func())
1554 func_do_profile(fp);
1555#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001556 if (sandbox)
1557 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001558 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001559 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001560 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001561 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001563 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001564 // Use the line number of the arguments.
1565 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001567 function_using_block_scopes(fp, evalarg->eval_cstack);
1568
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001569 pt->pt_func = fp;
1570 pt->pt_refcount = 1;
1571 rettv->vval.v_partial = pt;
1572 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001573
1574 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001577theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001578 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001579 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001580 if (types_optional)
1581 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001582
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001583 return OK;
1584
1585errret:
1586 ga_clear_strings(&newargs);
1587 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001588 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001589 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001590 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001591 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001592 if (fp != NULL)
1593 vim_free(fp->uf_arg_types);
1594 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001596 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001597 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001598 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 return FAIL;
1600}
1601
1602/*
1603 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1604 * name it contains, otherwise return "name".
1605 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1606 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001607 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1608 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001609 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001610 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611 */
1612 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001613deref_func_name(
1614 char_u *name,
1615 int *lenp,
1616 partial_T **partialp,
1617 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001618 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001619 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001620 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621{
1622 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001623 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001624 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001625 char_u *s = NULL;
1626 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001627 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628
1629 if (partialp != NULL)
1630 *partialp = NULL;
1631
1632 cc = name[*lenp];
1633 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001634
Bram Moolenaar71f21932022-01-07 18:20:55 +00001635 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001637 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001639 tv = &v->di_tv;
1640 }
1641 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1642 {
1643 imported_T *import;
1644 char_u *p = name;
1645 int len = *lenp;
1646
1647 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001648 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001649 p = name + 2;
1650 len -= 2;
1651 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001652 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001653
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001654 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001655 if (import != NULL)
1656 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001657 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001658 if (new_function)
1659 semsg(_(e_redefining_imported_item_str), name);
1660 else
1661 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001662 name[len] = cc;
1663 *lenp = 0;
1664 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001665 }
1666 }
1667
1668 if (tv != NULL)
1669 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001670 if (found_var != NULL)
1671 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001672 if (tv->v_type == VAR_FUNC)
1673 {
1674 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001675 {
1676 *lenp = 0;
1677 return (char_u *)""; // just in case
1678 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001679 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001680 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001682
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001683 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001684 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001685 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001686
1687 if (pt == NULL)
1688 {
1689 *lenp = 0;
1690 return (char_u *)""; // just in case
1691 }
1692 if (partialp != NULL)
1693 *partialp = pt;
1694 s = partial_name(pt);
1695 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001697
1698 if (s != NULL)
1699 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001700 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001701 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001702 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001703
1704 if (sv != NULL)
1705 *type = sv->sv_type;
1706 }
1707 return s;
1708 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001709 }
1710
1711 return name;
1712}
1713
1714/*
1715 * Give an error message with a function name. Handle <SNR> things.
1716 * "ermsg" is to be passed without translation, use N_() instead of _().
1717 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001718 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001719emsg_funcname(char *ermsg, char_u *name)
1720{
Bram Moolenaar54598062022-01-13 12:05:09 +00001721 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722
Bram Moolenaar54598062022-01-13 12:05:09 +00001723 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001724 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001725 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726 if (p != name)
1727 vim_free(p);
1728}
1729
1730/*
1731 * Allocate a variable for the result of a function.
1732 * Return OK or FAIL.
1733 */
1734 int
1735get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001736 char_u *name, // name of the function
1737 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001738 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001739 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001740 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001741 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001742{
1743 char_u *argp;
1744 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001745 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1746 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001747 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001748 int evaluate = evalarg == NULL
1749 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001750
1751 /*
1752 * Get the arguments.
1753 */
1754 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001755 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1756 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001757 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001758 // skip the '(' or ',' and possibly line breaks
1759 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1760
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001761 if (*argp == ')' || *argp == ',' || *argp == NUL)
1762 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001763 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001764 {
1765 ret = FAIL;
1766 break;
1767 }
1768 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001769 // The comma should come right after the argument, but this wasn't
1770 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001771 if (vim9script)
1772 {
1773 if (*argp != ',' && *skipwhite(argp) == ',')
1774 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001775 if (evaluate)
1776 semsg(_(e_no_white_space_allowed_before_str_str),
1777 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001778 ret = FAIL;
1779 break;
1780 }
1781 }
1782 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001783 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001784 if (*argp != ',')
1785 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001786 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1787 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001788 if (evaluate)
1789 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001790 ret = FAIL;
1791 break;
1792 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001794 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795 if (*argp == ')')
1796 ++argp;
1797 else
1798 ret = FAIL;
1799
1800 if (ret == OK)
1801 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001802 int i = 0;
1803 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804
1805 if (get_vim_var_nr(VV_TESTING))
1806 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001807 // Prepare for calling test_garbagecollect_now(), need to know
1808 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001809 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001810 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811 for (i = 0; i < argcount; ++i)
1812 if (ga_grow(&funcargs, 1) == OK)
1813 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1814 &argvars[i];
1815 }
1816
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001817 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001818 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001819 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001820 // An error in a builtin function does not return FAIL, but we do
1821 // want to abort further processing if an error was given.
1822 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001823 clear_tv(rettv);
1824 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001825
1826 funcargs.ga_len -= i;
1827 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001828 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001829 {
1830 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001831 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001832 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001833 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834 }
1835
1836 while (--argcount >= 0)
1837 clear_tv(&argvars[argcount]);
1838
Bram Moolenaar4525a572022-02-13 11:57:33 +00001839 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001840 *arg = argp;
1841 else
1842 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 return ret;
1844}
1845
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001846/*
1847 * Return TRUE if "p" starts with "<SID>" or "s:".
1848 * Only works if eval_fname_script() returned non-zero for "p"!
1849 */
1850 static int
1851eval_fname_sid(char_u *p)
1852{
1853 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1854}
1855
1856/*
1857 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1858 * Change <SNR>123_name() to K_SNR 123_name().
1859 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1860 * (slow).
1861 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001862 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001863fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1864{
1865 int llen;
1866 char_u *fname;
1867 int i;
1868
1869 llen = eval_fname_script(name);
1870 if (llen > 0)
1871 {
1872 fname_buf[0] = K_SPECIAL;
1873 fname_buf[1] = KS_EXTRA;
1874 fname_buf[2] = (int)KE_SNR;
1875 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001876 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001877 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001878 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001879 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001880 else
1881 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001882 sprintf((char *)fname_buf + 3, "%ld_",
1883 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884 i = (int)STRLEN(fname_buf);
1885 }
1886 }
1887 if (i + STRLEN(name + llen) < FLEN_FIXED)
1888 {
1889 STRCPY(fname_buf + i, name + llen);
1890 fname = fname_buf;
1891 }
1892 else
1893 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001894 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001895 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001896 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001897 else
1898 {
1899 *tofree = fname;
1900 mch_memmove(fname, fname_buf, (size_t)i);
1901 STRCPY(fname + i, name + llen);
1902 }
1903 }
1904 }
1905 else
1906 fname = name;
1907 return fname;
1908}
1909
1910/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001911 * Concatenate the script ID and function name into "<SNR>99_name".
1912 * "buffer" must have size MAX_FUNC_NAME_LEN.
1913 */
1914 void
1915func_name_with_sid(char_u *name, int sid, char_u *buffer)
1916{
1917 // A script-local function is stored as "<SNR>99_name".
1918 buffer[0] = K_SPECIAL;
1919 buffer[1] = KS_EXTRA;
1920 buffer[2] = (int)KE_SNR;
1921 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1922 (long)sid, name);
1923}
1924
1925/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001926 * Find a function "name" in script "sid".
1927 */
1928 static ufunc_T *
1929find_func_with_sid(char_u *name, int sid)
1930{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001931 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001932 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001933
Bram Moolenaarb8822442022-01-11 15:24:05 +00001934 if (!SCRIPT_ID_VALID(sid))
1935 return NULL; // not in a script
1936
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001937 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001938 hi = hash_find(&func_hashtab, buffer);
1939 if (!HASHITEM_EMPTY(hi))
1940 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001941 return NULL;
1942}
1943
1944/*
1945 * Find a function "name" in script "sid" prefixing the autoload prefix.
1946 */
1947 static ufunc_T *
1948find_func_with_prefix(char_u *name, int sid)
1949{
1950 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001951 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001952 scriptitem_T *si;
1953
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001954 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001955 return NULL; // already has the prefix
1956 if (!SCRIPT_ID_VALID(sid))
1957 return NULL; // not in a script
1958 si = SCRIPT_ITEM(sid);
1959 if (si->sn_autoload_prefix != NULL)
1960 {
1961 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1962 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001963 char_u *namep;
1964
1965 // skip a "<SNR>99_" prefix
1966 namep = untrans_function_name(name);
1967 if (namep == NULL)
1968 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001969
1970 // An exported function in an autoload script is stored as
1971 // "dir#path#name".
1972 if (len < sizeof(buffer))
1973 auto_name = buffer;
1974 else
1975 auto_name = alloc(len);
1976 if (auto_name != NULL)
1977 {
1978 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001979 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001980 hi = hash_find(&func_hashtab, auto_name);
1981 if (auto_name != buffer)
1982 vim_free(auto_name);
1983 if (!HASHITEM_EMPTY(hi))
1984 return HI2UF(hi);
1985 }
1986 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001987
1988 return NULL;
1989}
1990
1991/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001992 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001993 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
1994 * functions.
1995 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001996 * Return NULL for unknown function.
1997 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001998 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00001999find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002000{
2001 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002002 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002003
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002004 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002005 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002006 // Find script-local function before global one.
2007 if (in_vim9script() && eval_isnamec1(*name)
2008 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002010 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2011 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002012 if (func != NULL)
2013 return func;
2014 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002015 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2016 {
2017 char_u *p = name + 5;
2018 long sid;
2019
2020 // printable "<SNR>123_Name" form
2021 sid = getdigits(&p);
2022 if (*p == '_')
2023 {
2024 func = find_func_with_sid(p + 1, (int)sid);
2025 if (func != NULL)
2026 return func;
2027 }
2028 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002029 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002030
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002031 if ((flags & FFED_NO_GLOBAL) == 0)
2032 {
2033 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002034 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002035 if (!HASHITEM_EMPTY(hi))
2036 return HI2UF(hi);
2037 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002038
Bram Moolenaarb8822442022-01-11 15:24:05 +00002039 // Find autoload function if this is an autoload script.
2040 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2041 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002042}
2043
2044/*
2045 * Find a function by name, return pointer to it in ufuncs.
2046 * "cctx" is passed in a :def function to find imported functions.
2047 * Return NULL for unknown or dead function.
2048 */
2049 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002050find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002051{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002052 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002053
2054 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2055 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002056 return NULL;
2057}
2058
2059/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002060 * Return TRUE if "ufunc" is a global function.
2061 */
2062 int
2063func_is_global(ufunc_T *ufunc)
2064{
2065 return ufunc->uf_name[0] != K_SPECIAL;
2066}
2067
2068/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002069 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2070 */
2071 int
2072func_requires_g_prefix(ufunc_T *ufunc)
2073{
2074 return ufunc->uf_name[0] != K_SPECIAL
2075 && (ufunc->uf_flags & FC_LAMBDA) == 0
2076 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2077}
2078
2079/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002080 * Copy the function name of "fp" to buffer "buf".
2081 * "buf" must be able to hold the function name plus three bytes.
2082 * Takes care of script-local function names.
2083 */
2084 static void
2085cat_func_name(char_u *buf, ufunc_T *fp)
2086{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002087 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002088 {
2089 STRCPY(buf, "<SNR>");
2090 STRCAT(buf, fp->uf_name + 3);
2091 }
2092 else
2093 STRCPY(buf, fp->uf_name);
2094}
2095
2096/*
2097 * Add a number variable "name" to dict "dp" with value "nr".
2098 */
2099 static void
2100add_nr_var(
2101 dict_T *dp,
2102 dictitem_T *v,
2103 char *name,
2104 varnumber_T nr)
2105{
2106 STRCPY(v->di_key, name);
2107 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2108 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2109 v->di_tv.v_type = VAR_NUMBER;
2110 v->di_tv.v_lock = VAR_FIXED;
2111 v->di_tv.vval.v_number = nr;
2112}
2113
2114/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002115 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002117 static void
2118free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002119{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002120 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002121
2122 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2123 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002124 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002125
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002126 // When garbage collecting a funccall_T may be freed before the
2127 // function that references it, clear its uf_scoped field.
2128 // The function may have been redefined and point to another
2129 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002130 if (fp != NULL && fp->uf_scoped == fc)
2131 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002132 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002133 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002134
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002135 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002136 vim_free(fc);
2137}
2138
2139/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002140 * Free "fc" and what it contains.
2141 * Can be called only when "fc" is kept beyond the period of it called,
2142 * i.e. after cleanup_function_call(fc).
2143 */
2144 static void
2145free_funccal_contents(funccall_T *fc)
2146{
2147 listitem_T *li;
2148
2149 // Free all l: variables.
2150 vars_clear(&fc->l_vars.dv_hashtab);
2151
2152 // Free all a: variables.
2153 vars_clear(&fc->l_avars.dv_hashtab);
2154
2155 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002156 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002157 clear_tv(&li->li_tv);
2158
2159 free_funccal(fc);
2160}
2161
2162/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002163 * Handle the last part of returning from a function: free the local hashtable.
2164 * Unless it is still in use by a closure.
2165 */
2166 static void
2167cleanup_function_call(funccall_T *fc)
2168{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002169 int may_free_fc = fc->fc_refcount <= 0;
2170 int free_fc = TRUE;
2171
Bram Moolenaar6914c642017-04-01 21:21:30 +02002172 current_funccal = fc->caller;
2173
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002174 // Free all l: variables if not referred.
2175 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2176 vars_clear(&fc->l_vars.dv_hashtab);
2177 else
2178 free_fc = FALSE;
2179
2180 // If the a:000 list and the l: and a: dicts are not referenced and
2181 // there is no closure using it, we can free the funccall_T and what's
2182 // in it.
2183 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2184 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002185 else
2186 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002187 int todo;
2188 hashitem_T *hi;
2189 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002190
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002191 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002192
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002193 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002194 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2195 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2196 {
2197 if (!HASHITEM_EMPTY(hi))
2198 {
2199 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002200 di = HI2DI(hi);
2201 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002202 }
2203 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002204 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002205
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002206 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2207 fc->l_varlist.lv_first = NULL;
2208 else
2209 {
2210 listitem_T *li;
2211
2212 free_fc = FALSE;
2213
2214 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002215 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002216 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002217 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002218
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002219 if (free_fc)
2220 free_funccal(fc);
2221 else
2222 {
2223 static int made_copy = 0;
2224
2225 // "fc" is still in use. This can happen when returning "a:000",
2226 // assigning "l:" to a global variable or defining a closure.
2227 // Link "fc" in the list for garbage collection later.
2228 fc->caller = previous_funccal;
2229 previous_funccal = fc;
2230
2231 if (want_garbage_collect)
2232 // If garbage collector is ready, clear count.
2233 made_copy = 0;
2234 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002235 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002236 // We have made a lot of copies, worth 4 Mbyte. This can happen
2237 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002238 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002239 // too much memory.
2240 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002241 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002242 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002243 }
2244}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002245
2246/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002247 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2248 */
2249 static int
2250numbered_function(char_u *name)
2251{
2252 return isdigit(*name)
2253 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2254}
2255
2256/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002257 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002258 * 1. ordinary names, function defined with :function or :def;
2259 * can start with "<SNR>123_" literally or with K_SPECIAL.
2260 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002261 * For the first we only count the name stored in func_hashtab as a reference,
2262 * using function() does not count as a reference, because the function is
2263 * looked up by name.
2264 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002265 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002266func_name_refcount(char_u *name)
2267{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002268 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002269}
2270
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002271/*
2272 * Unreference "fc": decrement the reference count and free it when it
2273 * becomes zero. "fp" is detached from "fc".
2274 * When "force" is TRUE we are exiting.
2275 */
2276 static void
2277funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2278{
2279 funccall_T **pfc;
2280 int i;
2281
2282 if (fc == NULL)
2283 return;
2284
2285 if (--fc->fc_refcount <= 0 && (force || (
2286 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2287 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2288 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2289 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2290 {
2291 if (fc == *pfc)
2292 {
2293 *pfc = fc->caller;
2294 free_funccal_contents(fc);
2295 return;
2296 }
2297 }
2298 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2299 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2300 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2301}
2302
2303/*
2304 * Remove the function from the function hashtable. If the function was
2305 * deleted while it still has references this was already done.
2306 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2307 */
2308 static int
2309func_remove(ufunc_T *fp)
2310{
2311 hashitem_T *hi;
2312
2313 // Return if it was already virtually deleted.
2314 if (fp->uf_flags & FC_DEAD)
2315 return FALSE;
2316
2317 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2318 if (!HASHITEM_EMPTY(hi))
2319 {
2320 // When there is a def-function index do not actually remove the
2321 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002322 // Do remove it when it's a copy.
2323 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002324 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002325 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002326 return FALSE;
2327 }
2328 hash_remove(&func_hashtab, hi);
2329 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002330 return TRUE;
2331 }
2332 return FALSE;
2333}
2334
2335 static void
2336func_clear_items(ufunc_T *fp)
2337{
2338 ga_clear_strings(&(fp->uf_args));
2339 ga_clear_strings(&(fp->uf_def_args));
2340 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002341 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002342 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002343 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002344 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002345
2346 // Increment the refcount of this function to avoid it being freed
2347 // recursively when the partial is freed.
2348 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002349 partial_unref(fp->uf_partial);
2350 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002351 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002352
2353#ifdef FEAT_LUA
2354 if (fp->uf_cb_free != NULL)
2355 {
2356 fp->uf_cb_free(fp->uf_cb_state);
2357 fp->uf_cb_free = NULL;
2358 }
2359
2360 fp->uf_cb_state = NULL;
2361 fp->uf_cb = NULL;
2362#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002363#ifdef FEAT_PROFILE
2364 VIM_CLEAR(fp->uf_tml_count);
2365 VIM_CLEAR(fp->uf_tml_total);
2366 VIM_CLEAR(fp->uf_tml_self);
2367#endif
2368}
2369
2370/*
2371 * Free all things that a function contains. Does not free the function
2372 * itself, use func_free() for that.
2373 * When "force" is TRUE we are exiting.
2374 */
2375 static void
2376func_clear(ufunc_T *fp, int force)
2377{
2378 if (fp->uf_cleared)
2379 return;
2380 fp->uf_cleared = TRUE;
2381
2382 // clear this function
2383 func_clear_items(fp);
2384 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002385 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002386}
2387
2388/*
2389 * Free a function and remove it from the list of functions. Does not free
2390 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002391 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002392 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002393 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002394 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002395func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002396{
2397 // Only remove it when not done already, otherwise we would remove a newer
2398 // version of the function with the same name.
2399 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2400 func_remove(fp);
2401
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002402 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002403 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002404 if (fp->uf_dfunc_idx > 0)
2405 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002406 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002407 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002408 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002409 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002410 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002411}
2412
2413/*
2414 * Free all things that a function contains and free the function itself.
2415 * When "force" is TRUE we are exiting.
2416 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002417 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002418func_clear_free(ufunc_T *fp, int force)
2419{
2420 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002421 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2422 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002423 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002424 else
2425 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002426}
2427
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002428/*
2429 * Copy already defined function "lambda" to a new function with name "global".
2430 * This is for when a compiled function defines a global function.
2431 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002432 int
2433copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002434{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002435 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002436 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002437
2438 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002439 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002440 semsg(_(e_lambda_function_not_found_str), lambda);
2441 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002442 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002443
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002444 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002445 if (fp != NULL)
2446 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002447 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002448 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002449 return FAIL;
2450 }
2451
2452 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2453 if (fp == NULL)
2454 return FAIL;
2455
2456 fp->uf_varargs = ufunc->uf_varargs;
2457 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2458 fp->uf_def_status = ufunc->uf_def_status;
2459 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2460 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2461 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2462 == FAIL
2463 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2464 goto failed;
2465
2466 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2467 : vim_strsave(ufunc->uf_name_exp);
2468 if (ufunc->uf_arg_types != NULL)
2469 {
2470 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2471 if (fp->uf_arg_types == NULL)
2472 goto failed;
2473 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2474 sizeof(type_T *) * fp->uf_args.ga_len);
2475 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002476 if (ufunc->uf_va_name != NULL)
2477 {
2478 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2479 if (fp->uf_va_name == NULL)
2480 goto failed;
2481 }
2482 fp->uf_ret_type = ufunc->uf_ret_type;
2483
2484 fp->uf_refcount = 1;
2485 STRCPY(fp->uf_name, global);
2486 hash_add(&func_hashtab, UF2HIKEY(fp));
2487
2488 // the referenced dfunc_T is now used one more time
2489 link_def_function(fp);
2490
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002491 // Create a partial to store the context of the function where it was
2492 // instantiated. Only needs to be done once. Do this on the original
2493 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002494 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2495 {
2496 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2497
2498 if (pt == NULL)
2499 goto failed;
2500 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002501 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002502 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002503 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002504 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002505 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002506 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002507 }
2508
2509 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002510
2511failed:
2512 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002513 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002514}
2515
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002516static int funcdepth = 0;
2517
2518/*
2519 * Increment the function call depth count.
2520 * Return FAIL when going over 'maxfuncdepth'.
2521 * Otherwise return OK, must call funcdepth_decrement() later!
2522 */
2523 int
2524funcdepth_increment(void)
2525{
2526 if (funcdepth >= p_mfd)
2527 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002528 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002529 return FAIL;
2530 }
2531 ++funcdepth;
2532 return OK;
2533}
2534
2535 void
2536funcdepth_decrement(void)
2537{
2538 --funcdepth;
2539}
2540
2541/*
2542 * Get the current function call depth.
2543 */
2544 int
2545funcdepth_get(void)
2546{
2547 return funcdepth;
2548}
2549
2550/*
2551 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002552 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002553 * times as funcdepth_increment().
2554 */
2555 void
2556funcdepth_restore(int depth)
2557{
2558 funcdepth = depth;
2559}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002560
2561/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002562 * Call a user function.
2563 */
2564 static void
2565call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002566 ufunc_T *fp, // pointer to function
2567 int argcount, // nr of args
2568 typval_T *argvars, // arguments
2569 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002570 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002571 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002572{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002573 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002574 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002575 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002576 funccall_T *fc;
2577 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002578 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002579 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002580 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002581 int i;
2582 int ai;
2583 int islambda = FALSE;
2584 char_u numbuf[NUMBUFLEN];
2585 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002586 typval_T *tv_to_free[MAX_FUNC_ARGS];
2587 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002589 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002590#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002591 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002592
Bram Moolenaarb2049902021-01-24 12:53:53 +01002593#ifdef FEAT_PROFILE
2594 CLEAR_FIELD(profile_info);
2595#endif
2596
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002597 // If depth of calling is getting too high, don't execute the function.
2598 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002599 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002600 rettv->v_type = VAR_NUMBER;
2601 rettv->vval.v_number = -1;
2602 return;
2603 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002604
Bram Moolenaare38eab22019-12-05 21:50:01 +01002605 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002606
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002607 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002608 if (fc == NULL)
2609 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610 fc->caller = current_funccal;
2611 current_funccal = fc;
2612 fc->func = fp;
2613 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002614 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002615 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2617 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002618 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002619 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002620 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002622 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002623 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002624#ifdef FEAT_PROFILE
2625 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2626#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002627 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002628#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002629 if (do_profiling == PROF_YES)
2630 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002631#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002632 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002633 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002634 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002635#ifdef FEAT_PROFILE
2636 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002637 || (caller != NULL && caller->uf_profiling)))
2638 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002639#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002640 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002641 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002642 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002643 return;
2644 }
2645
Bram Moolenaar38453522021-11-28 22:00:12 +00002646 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647
2648 /*
2649 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2650 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2651 * each argument variable and saves a lot of time.
2652 */
2653 /*
2654 * Init l: variables.
2655 */
2656 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2657 if (selfdict != NULL)
2658 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002659 // Set l:self to "selfdict". Use "name" to avoid a warning from
2660 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 v = &fc->fixvar[fixvar_idx++].var;
2662 name = v->di_key;
2663 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002664 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2666 v->di_tv.v_type = VAR_DICT;
2667 v->di_tv.v_lock = 0;
2668 v->di_tv.vval.v_dict = selfdict;
2669 ++selfdict->dv_refcount;
2670 }
2671
2672 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002673 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002674 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 * Set a:000 to a list with room for the "..." arguments.
2676 */
2677 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002678 if ((fp->uf_flags & FC_NOARGS) == 0)
2679 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002680 (varnumber_T)(argcount >= fp->uf_args.ga_len
2681 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002682 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002683 if ((fp->uf_flags & FC_NOARGS) == 0)
2684 {
2685 // Use "name" to avoid a warning from some compiler that checks the
2686 // destination size.
2687 v = &fc->fixvar[fixvar_idx++].var;
2688 name = v->di_key;
2689 STRCPY(name, "000");
2690 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2691 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2692 v->di_tv.v_type = VAR_LIST;
2693 v->di_tv.v_lock = VAR_FIXED;
2694 v->di_tv.vval.v_list = &fc->l_varlist;
2695 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002696 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2698 fc->l_varlist.lv_lock = VAR_FIXED;
2699
2700 /*
2701 * Set a:firstline to "firstline" and a:lastline to "lastline".
2702 * Set a:name to named arguments.
2703 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002704 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002706 if ((fp->uf_flags & FC_NOARGS) == 0)
2707 {
2708 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002709 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002710 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002711 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002712 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002713 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 {
2715 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002716 typval_T def_rettv;
2717 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718
2719 ai = i - fp->uf_args.ga_len;
2720 if (ai < 0)
2721 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002722 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 name = FUNCARG(fp, i);
2724 if (islambda)
2725 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002726
2727 // evaluate named argument default expression
2728 isdefault = ai + fp->uf_def_args.ga_len >= 0
2729 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2730 && argvars[i].vval.v_number == VVAL_NONE));
2731 if (isdefault)
2732 {
2733 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002734
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002735 def_rettv.v_type = VAR_NUMBER;
2736 def_rettv.vval.v_number = -1;
2737
2738 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2739 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002740 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002741 {
2742 default_arg_err = 1;
2743 break;
2744 }
2745 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 }
2747 else
2748 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002749 if ((fp->uf_flags & FC_NOARGS) != 0)
2750 // Bail out if no a: arguments used (in lambda).
2751 break;
2752
Bram Moolenaare38eab22019-12-05 21:50:01 +01002753 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 sprintf((char *)numbuf, "%d", ai + 1);
2755 name = numbuf;
2756 }
2757 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2758 {
2759 v = &fc->fixvar[fixvar_idx++].var;
2760 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002761 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 }
2763 else
2764 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002765 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766 if (v == NULL)
2767 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002768 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002771 // Note: the values are copied directly to avoid alloc/free.
2772 // "argvars" must have VAR_FIXED for v_lock.
2773 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 v->di_tv.v_lock = VAR_FIXED;
2775
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002776 if (isdefault)
2777 // Need to free this later, no matter where it's stored.
2778 tv_to_free[tv_to_free_len++] = &v->di_tv;
2779
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 if (addlocal)
2781 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002782 // Named arguments should be accessed without the "a:" prefix in
2783 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002784 copy_tv(&v->di_tv, &v->di_tv);
2785 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002787 else
2788 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789
2790 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2791 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002792 listitem_T *li = &fc->l_listitems[ai];
2793
2794 li->li_tv = argvars[i];
2795 li->li_tv.v_lock = VAR_FIXED;
2796 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 }
2798 }
2799
Bram Moolenaare38eab22019-12-05 21:50:01 +01002800 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002801 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002802
2803 if (fp->uf_flags & FC_SANDBOX)
2804 {
2805 using_sandbox = TRUE;
2806 ++sandbox;
2807 }
2808
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002809 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002810 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002811 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002813 ++no_wait_return;
2814 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002816 smsg(_("calling %s"), SOURCING_NAME);
2817 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002819 char_u buf[MSG_BUF_LEN];
2820 char_u numbuf2[NUMBUFLEN];
2821 char_u *tofree;
2822 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002823
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002824 msg_puts("(");
2825 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002827 if (i > 0)
2828 msg_puts(", ");
2829 if (argvars[i].v_type == VAR_NUMBER)
2830 msg_outnum((long)argvars[i].vval.v_number);
2831 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002833 // Do not want errors such as E724 here.
2834 ++emsg_off;
2835 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2836 --emsg_off;
2837 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002839 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002841 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2842 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002844 msg_puts((char *)s);
2845 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002846 }
2847 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002849 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002851 msg_puts("\n"); // don't overwrite this either
2852
2853 verbose_leave_scroll();
2854 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 }
2856#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002857 if (do_profiling == PROF_YES)
2858 profile_may_start_func(&profile_info, fp,
2859 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860#endif
2861
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002862 // "legacy" does not apply to commands in the function
2863 sticky_cmdmod_flags = 0;
2864
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002865 save_current_sctx = current_sctx;
2866 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867 save_did_emsg = did_emsg;
2868 did_emsg = FALSE;
2869
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002870 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2871 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002872 else if (islambda)
2873 {
2874 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2875
2876 // A Lambda always has the command "return {expr}". It is much faster
2877 // to evaluate {expr} directly.
2878 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002879 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002880 --ex_nesting_level;
2881 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002882 else
2883 // call do_cmdline() to execute the lines
2884 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002885 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2886
2887 --RedrawingDisabled;
2888
Bram Moolenaare38eab22019-12-05 21:50:01 +01002889 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2891 {
2892 clear_tv(rettv);
2893 rettv->v_type = VAR_NUMBER;
2894 rettv->vval.v_number = -1;
2895 }
2896
2897#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002898 if (do_profiling == PROF_YES)
2899 {
2900 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2901
2902 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2903 profile_may_end_func(&profile_info, fp, caller);
2904 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002905#endif
2906
Bram Moolenaare38eab22019-12-05 21:50:01 +01002907 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002908 if (p_verbose >= 12)
2909 {
2910 ++no_wait_return;
2911 verbose_enter_scroll();
2912
2913 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002914 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002916 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917 (long)fc->rettv->vval.v_number);
2918 else
2919 {
2920 char_u buf[MSG_BUF_LEN];
2921 char_u numbuf2[NUMBUFLEN];
2922 char_u *tofree;
2923 char_u *s;
2924
Bram Moolenaare38eab22019-12-05 21:50:01 +01002925 // The value may be very long. Skip the middle part, so that we
2926 // have some idea how it starts and ends. smsg() would always
2927 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928 ++emsg_off;
2929 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2930 --emsg_off;
2931 if (s != NULL)
2932 {
2933 if (vim_strsize(s) > MSG_BUF_CLEN)
2934 {
2935 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2936 s = buf;
2937 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002938 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002939 vim_free(tofree);
2940 }
2941 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002942 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002943
2944 verbose_leave_scroll();
2945 --no_wait_return;
2946 }
2947
Bram Moolenaare31ee862020-01-07 20:59:34 +01002948 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002949 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002950 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951#ifdef FEAT_PROFILE
2952 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002953 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002955 if (using_sandbox)
2956 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002957 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002958
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002959 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002960 {
2961 ++no_wait_return;
2962 verbose_enter_scroll();
2963
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002964 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002965 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002966
2967 verbose_leave_scroll();
2968 --no_wait_return;
2969 }
2970
2971 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002972 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002973 for (i = 0; i < tv_to_free_len; ++i)
2974 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002975 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002976}
2977
2978/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002979 * Check the argument count for user function "fp".
2980 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2981 */
2982 int
2983check_user_func_argcount(ufunc_T *fp, int argcount)
2984{
2985 int regular_args = fp->uf_args.ga_len;
2986
2987 if (argcount < regular_args - fp->uf_def_args.ga_len)
2988 return FCERR_TOOFEW;
2989 else if (!has_varargs(fp) && argcount > regular_args)
2990 return FCERR_TOOMANY;
2991 return FCERR_UNKNOWN;
2992}
2993
2994/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002995 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002996 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002997 int
2998call_user_func_check(
2999 ufunc_T *fp,
3000 int argcount,
3001 typval_T *argvars,
3002 typval_T *rettv,
3003 funcexe_T *funcexe,
3004 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003005{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003006 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003007
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003008#ifdef FEAT_LUA
3009 if (fp->uf_flags & FC_CFUNC)
3010 {
3011 cfunc_T cb = fp->uf_cb;
3012
3013 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3014 }
3015#endif
3016
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003017 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3018 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003019 error = check_user_func_argcount(fp, argcount);
3020 if (error != FCERR_UNKNOWN)
3021 return error;
3022 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 error = FCERR_DICT;
3024 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003025 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003026 int did_save_redo = FALSE;
3027 save_redo_T save_redo;
3028
3029 /*
3030 * Call the user function.
3031 * Save and restore search patterns, script variables and
3032 * redo buffer.
3033 */
3034 save_search_patterns();
3035 if (!ins_compl_active())
3036 {
3037 saveRedobuff(&save_redo);
3038 did_save_redo = TRUE;
3039 }
3040 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003041 call_user_func(fp, argcount, argvars, rettv, funcexe,
3042 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003043 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3044 // Function was unreferenced while being used, free it now.
3045 func_clear_free(fp, FALSE);
3046 if (did_save_redo)
3047 restoreRedobuff(&save_redo);
3048 restore_search_patterns();
3049 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003050 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003051 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003052}
3053
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003054static funccal_entry_T *funccal_stack = NULL;
3055
3056/*
3057 * Save the current function call pointer, and set it to NULL.
3058 * Used when executing autocommands and for ":source".
3059 */
3060 void
3061save_funccal(funccal_entry_T *entry)
3062{
3063 entry->top_funccal = current_funccal;
3064 entry->next = funccal_stack;
3065 funccal_stack = entry;
3066 current_funccal = NULL;
3067}
3068
3069 void
3070restore_funccal(void)
3071{
3072 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003073 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003074 else
3075 {
3076 current_funccal = funccal_stack->top_funccal;
3077 funccal_stack = funccal_stack->next;
3078 }
3079}
3080
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003081 funccall_T *
3082get_current_funccal(void)
3083{
3084 return current_funccal;
3085}
3086
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003087/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003088 * Return TRUE when currently at the script level:
3089 * - not in a function
3090 * - not executing an autocommand
3091 * Note that when an autocommand sources a script the result is FALSE;
3092 */
3093 int
3094at_script_level(void)
3095{
3096 return current_funccal == NULL && autocmd_match == NULL;
3097}
3098
3099/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003100 * Mark all functions of script "sid" as deleted.
3101 */
3102 void
3103delete_script_functions(int sid)
3104{
3105 hashitem_T *hi;
3106 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003107 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003108 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003109 size_t len;
3110
3111 buf[0] = K_SPECIAL;
3112 buf[1] = KS_EXTRA;
3113 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003114 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003115 len = STRLEN(buf);
3116
Bram Moolenaarce658352020-07-31 23:47:12 +02003117 while (todo > 0)
3118 {
3119 todo = func_hashtab.ht_used;
3120 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3121 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003122 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003123 fp = HI2UF(hi);
3124 if (STRNCMP(fp->uf_name, buf, len) == 0)
3125 {
3126 int changed = func_hashtab.ht_changed;
3127
3128 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003129
3130 if (fp->uf_calls > 0)
3131 {
3132 // Function is executing, don't free it but do remove
3133 // it from the hashtable.
3134 if (func_remove(fp))
3135 fp->uf_refcount--;
3136 }
3137 else
3138 {
3139 func_clear(fp, TRUE);
3140 // When clearing a function another function can be
3141 // cleared as a side effect. When that happens start
3142 // over.
3143 if (changed != func_hashtab.ht_changed)
3144 break;
3145 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003146 }
3147 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003148 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003149 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003150}
3151
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152#if defined(EXITFREE) || defined(PROTO)
3153 void
3154free_all_functions(void)
3155{
3156 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003157 ufunc_T *fp;
3158 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003159 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003160 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161
Bram Moolenaare38eab22019-12-05 21:50:01 +01003162 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003163 while (current_funccal != NULL)
3164 {
3165 clear_tv(current_funccal->rettv);
3166 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003167 if (current_funccal == NULL && funccal_stack != NULL)
3168 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003169 }
3170
Bram Moolenaare38eab22019-12-05 21:50:01 +01003171 // First clear what the functions contain. Since this may lower the
3172 // reference count of a function, it may also free a function and change
3173 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003174 while (todo > 0)
3175 {
3176 todo = func_hashtab.ht_used;
3177 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3178 if (!HASHITEM_EMPTY(hi))
3179 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003180 // clear the def function index now
3181 fp = HI2UF(hi);
3182 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003183 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003184
Bram Moolenaare38eab22019-12-05 21:50:01 +01003185 // Only free functions that are not refcounted, those are
3186 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003187 if (func_name_refcount(fp->uf_name))
3188 ++skipped;
3189 else
3190 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003191 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003192 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003193 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003194 {
3195 skipped = 0;
3196 break;
3197 }
3198 }
3199 --todo;
3200 }
3201 }
3202
Bram Moolenaare38eab22019-12-05 21:50:01 +01003203 // Now actually free the functions. Need to start all over every time,
3204 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003205 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003206 while (func_hashtab.ht_used > skipped)
3207 {
3208 todo = func_hashtab.ht_used;
3209 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 if (!HASHITEM_EMPTY(hi))
3211 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003212 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003213 // Only free functions that are not refcounted, those are
3214 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003215 fp = HI2UF(hi);
3216 if (func_name_refcount(fp->uf_name))
3217 ++skipped;
3218 else
3219 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003220 if (func_free(fp, FALSE) == OK)
3221 {
3222 skipped = 0;
3223 break;
3224 }
3225 // did not actually free it
3226 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003227 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003229 }
3230 if (skipped == 0)
3231 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003232
3233 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234}
3235#endif
3236
3237/*
3238 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003239 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3240 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 * "len" is the length of "name", or -1 for NUL terminated.
3242 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003243 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244builtin_function(char_u *name, int len)
3245{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003246 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247
Bram Moolenaara26b9702020-04-18 19:53:28 +02003248 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003250 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3251 {
3252 if (name[i] == AUTOLOAD_CHAR)
3253 return FALSE;
3254 if (!eval_isnamec(name[i]))
3255 {
3256 // "name.something" is not a builtin function
3257 if (name[i] == '.')
3258 return FALSE;
3259 break;
3260 }
3261 }
3262 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263}
3264
3265 int
3266func_call(
3267 char_u *name,
3268 typval_T *args,
3269 partial_T *partial,
3270 dict_T *selfdict,
3271 typval_T *rettv)
3272{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003273 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274 listitem_T *item;
3275 typval_T argv[MAX_FUNC_ARGS + 1];
3276 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 int r = 0;
3278
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003279 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003280 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 {
3282 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3283 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003284 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285 break;
3286 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003287 // Make a copy of each argument. This is needed to be able to set
3288 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289 copy_tv(&item->li_tv, &argv[argc++]);
3290 }
3291
3292 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003293 {
3294 funcexe_T funcexe;
3295
Bram Moolenaara80faa82020-04-12 19:37:17 +02003296 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003297 funcexe.fe_firstline = curwin->w_cursor.lnum;
3298 funcexe.fe_lastline = curwin->w_cursor.lnum;
3299 funcexe.fe_evaluate = TRUE;
3300 funcexe.fe_partial = partial;
3301 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003302 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304
Bram Moolenaare38eab22019-12-05 21:50:01 +01003305 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 while (argc > 0)
3307 clear_tv(&argv[--argc]);
3308
3309 return r;
3310}
3311
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003312static int callback_depth = 0;
3313
3314 int
3315get_callback_depth(void)
3316{
3317 return callback_depth;
3318}
3319
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003321 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003322 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003323 */
3324 int
3325call_callback(
3326 callback_T *callback,
3327 int len, // length of "name" or -1 to use strlen()
3328 typval_T *rettv, // return value goes here
3329 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003330 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003331 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003332{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003333 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003334 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003335
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003336 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3337 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003338 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003339 funcexe.fe_evaluate = TRUE;
3340 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003341 ++callback_depth;
3342 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3343 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003344
3345 // When a :def function was called that uses :try an error would be turned
3346 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003347 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003348 {
3349 need_rethrow = FALSE;
3350 handle_did_throw();
3351 }
3352
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003353 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003354}
3355
3356/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003357 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003358 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003359 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3360 */
3361 varnumber_T
3362call_callback_retnr(
3363 callback_T *callback,
3364 int argcount, // number of "argvars"
3365 typval_T *argvars) // vars for arguments, must have "argcount"
3366 // PLUS ONE elements!
3367{
3368 typval_T rettv;
3369 varnumber_T retval;
3370
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003371 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003372 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003373
3374 retval = tv_get_number_chk(&rettv, NULL);
3375 clear_tv(&rettv);
3376 return retval;
3377}
3378
3379/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003380 * Give an error message for the result of a function.
3381 * Nothing if "error" is FCERR_NONE.
3382 */
3383 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003384user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003385{
3386 switch (error)
3387 {
3388 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003389 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003390 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003391 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003392 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003393 break;
3394 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003395 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003396 break;
3397 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003398 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003399 break;
3400 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003401 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003402 break;
3403 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003404 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003405 break;
3406 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003407 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408 break;
3409 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003410 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3411 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003412 break;
3413 }
3414}
3415
3416/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003418 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003419 * Return FAIL when the function can't be called, OK otherwise.
3420 * Also returns OK when an error was encountered while executing the function.
3421 */
3422 int
3423call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003424 char_u *funcname, // name of the function
3425 int len, // length of "name" or -1 to use strlen()
3426 typval_T *rettv, // return value goes here
3427 int argcount_in, // number of "argvars"
3428 typval_T *argvars_in, // vars for arguments, must have "argcount"
3429 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003430 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431{
3432 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003433 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003435 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 char_u fname_buf[FLEN_FIXED + 1];
3437 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003438 char_u *fname = NULL;
3439 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 int argcount = argcount_in;
3441 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003442 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003443 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003444 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003446 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003447 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003448 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003449 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003451 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3452 // even when call_func() returns FAIL.
3453 rettv->v_type = VAR_UNKNOWN;
3454
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003455 if (partial != NULL)
3456 fp = partial->pt_func;
3457 if (fp == NULL)
3458 {
3459 // Make a copy of the name, if it comes from a funcref variable it
3460 // could be changed or deleted in the called function.
3461 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3462 if (name == NULL)
3463 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003464
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003465 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003468 if (funcexe->fe_doesrange != NULL)
3469 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003470
3471 if (partial != NULL)
3472 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003473 // When the function has a partial with a dict and there is a dict
3474 // argument, use the dict argument. That is backwards compatible.
3475 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003476 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003477 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003478 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 {
3480 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003481 {
3482 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3483 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003484 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003485 goto theend;
3486 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003487 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003488 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489 for (i = 0; i < argcount_in; ++i)
3490 argv[i + argv_clear] = argvars_in[i];
3491 argvars = argv;
3492 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003493
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003494 if (funcexe->fe_check_type != NULL
3495 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003496 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003497 // Now funcexe->fe_check_type is missing the added arguments,
3498 // make a copy of the type with the correction.
3499 check_type = *funcexe->fe_check_type;
3500 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003501 check_type.tt_args = check_type_args;
3502 CLEAR_FIELD(check_type_args);
3503 for (i = 0; i < check_type.tt_argcount; ++i)
3504 check_type_args[i + partial->pt_argc] =
3505 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003506 check_type.tt_argcount += partial->pt_argc;
3507 check_type.tt_min_argcount += partial->pt_argc;
3508 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 }
3510 }
3511
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003512 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3513 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003514 {
3515 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003516 if (check_argument_types(funcexe->fe_check_type,
3517 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003518 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003519 error = FCERR_OTHER;
3520 }
3521
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003522 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 {
3524 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003525 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526
Bram Moolenaar333894b2020-08-01 18:53:07 +02003527 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003528 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003529 {
3530 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533
Bram Moolenaare38eab22019-12-05 21:50:01 +01003534 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003536 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003538 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 {
3540 /*
3541 * User defined function.
3542 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003543 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003544 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003545 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003546 if (fp != NULL && !is_global && in_vim9script()
3547 && func_requires_g_prefix(fp))
3548 // In Vim9 script g: is required to find a global
3549 // non-autoload function.
3550 fp = NULL;
3551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552
Bram Moolenaare38eab22019-12-05 21:50:01 +01003553 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 if (fp == NULL
3555 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003556 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 && !aborting())
3558 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003559 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003560 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003562 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3564 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003565 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003566 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003568 if (fp == NULL)
3569 {
3570 char_u *p = untrans_function_name(rfname);
3571
3572 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003573 // Don't do this if the name starts with "s:".
3574 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003575 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003578 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003579 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003580 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003582 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003583 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003584 argcount = funcexe->fe_argv_func(argcount, argvars,
3585 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003586
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003587 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003588 {
3589 // Method call: base->Method()
3590 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003591 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003592 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003593 argvars = argv;
3594 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003595 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003596
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003597 error = call_user_func_check(fp, argcount, argvars, rettv,
3598 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 }
3600 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003601 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003602 {
3603 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003604 * expr->method(): Find the method name in the table, call its
3605 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003606 */
3607 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003608 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003609 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003610 else
3611 {
3612 /*
3613 * Find the function name in the table, call its implementation.
3614 */
3615 error = call_internal_func(fname, argcount, argvars, rettv);
3616 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003617
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618 /*
3619 * The function call (or "FuncUndefined" autocommand sequence) might
3620 * have been aborted by an error, an interrupt, or an explicitly thrown
3621 * exception that has not been caught so far. This situation can be
3622 * tested for by calling aborting(). For an error in an internal
3623 * function or for the "E132" error in call_user_func(), however, the
3624 * throw point at which the "force_abort" flag (temporarily reset by
3625 * emsg()) is normally updated has not been reached yet. We need to
3626 * update that flag first to make aborting() reliable.
3627 */
3628 update_force_abort();
3629 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003630 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003631 ret = OK;
3632
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003633theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 /*
3635 * Report an error unless the argument evaluation or function call has been
3636 * cancelled due to an aborting error, an interrupt, or an exception.
3637 */
3638 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003639 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003641 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003643 clear_tv(&argv[--argv_clear + argv_base]);
3644
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003645 vim_free(tofree);
3646 vim_free(name);
3647
3648 return ret;
3649}
3650
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003651 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003652printable_func_name(ufunc_T *fp)
3653{
3654 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3655}
3656
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003658 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 */
3660 static void
3661list_func_head(ufunc_T *fp, int indent)
3662{
3663 int j;
3664
3665 msg_start();
3666 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003667 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003668 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003669 msg_puts("def ");
3670 else
3671 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003672 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 msg_putchar('(');
3674 for (j = 0; j < fp->uf_args.ga_len; ++j)
3675 {
3676 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003677 msg_puts(", ");
3678 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003679 if (fp->uf_arg_types != NULL)
3680 {
3681 char *tofree;
3682
3683 msg_puts(": ");
3684 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3685 vim_free(tofree);
3686 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003687 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3688 {
3689 msg_puts(" = ");
3690 msg_puts(((char **)(fp->uf_def_args.ga_data))
3691 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3692 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 }
3694 if (fp->uf_varargs)
3695 {
3696 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003697 msg_puts(", ");
3698 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003700 if (fp->uf_va_name != NULL)
3701 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003702 if (!fp->uf_varargs)
3703 {
3704 if (j)
3705 msg_puts(", ");
3706 msg_puts("...");
3707 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003708 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003709 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003710 {
3711 char *tofree;
3712
3713 msg_puts(": ");
3714 msg_puts(type_name(fp->uf_va_type, &tofree));
3715 vim_free(tofree);
3716 }
3717 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003718 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003719
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003720 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003721 {
3722 if (fp->uf_ret_type != &t_void)
3723 {
3724 char *tofree;
3725
3726 msg_puts(": ");
3727 msg_puts(type_name(fp->uf_ret_type, &tofree));
3728 vim_free(tofree);
3729 }
3730 }
3731 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003732 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003734 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003736 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003737 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003738 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 msg_clr_eos();
3740 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003741 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003742}
3743
3744/*
3745 * Get a function name, translating "<SID>" and "<SNR>".
3746 * Also handles a Funcref in a List or Dictionary.
3747 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003748 * Set "*is_global" to TRUE when the function must be global, unless
3749 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 * flags:
3751 * TFN_INT: internal function name OK
3752 * TFN_QUIET: be quiet
3753 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003754 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 * Advances "pp" to just after the function name (if no error).
3756 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003757 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758trans_function_name(
3759 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003760 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003761 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003762 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003763 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003764 partial_T **partial, // return: partial of a FuncRef
3765 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766{
3767 char_u *name = NULL;
3768 char_u *start;
3769 char_u *end;
3770 int lead;
3771 char_u sid_buf[20];
3772 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003773 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003774 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003776 int vim9script = in_vim9script();
3777 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778
3779 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003780 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 start = *pp;
3782
Bram Moolenaare38eab22019-12-05 21:50:01 +01003783 // Check for hard coded <SNR>: already translated function ID (from a user
3784 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3786 && (*pp)[2] == (int)KE_SNR)
3787 {
3788 *pp += 3;
3789 len = get_id_len(pp) + 3;
3790 return vim_strnsave(start, len);
3791 }
3792
Bram Moolenaare38eab22019-12-05 21:50:01 +01003793 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3794 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 lead = eval_fname_script(start);
3796 if (lead > 2)
3797 start += lead;
3798
Bram Moolenaare38eab22019-12-05 21:50:01 +01003799 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003800 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003802 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003803 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 {
3805 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003806 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 goto theend;
3808 }
3809 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3810 {
3811 /*
3812 * Report an invalid expression in braces, unless the expression
3813 * evaluation has been cancelled due to an aborting error, an
3814 * interrupt, or an exception.
3815 */
3816 if (!aborting())
3817 {
3818 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003819 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 }
3821 else
3822 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3823 goto theend;
3824 }
3825
3826 if (lv.ll_tv != NULL)
3827 {
3828 if (fdp != NULL)
3829 {
3830 fdp->fd_dict = lv.ll_dict;
3831 fdp->fd_newkey = lv.ll_newkey;
3832 lv.ll_newkey = NULL;
3833 fdp->fd_di = lv.ll_di;
3834 }
3835 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3836 {
3837 name = vim_strsave(lv.ll_tv->vval.v_string);
3838 *pp = end;
3839 }
3840 else if (lv.ll_tv->v_type == VAR_PARTIAL
3841 && lv.ll_tv->vval.v_partial != NULL)
3842 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003843 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 *pp = end;
3845 if (partial != NULL)
3846 *partial = lv.ll_tv->vval.v_partial;
3847 }
3848 else
3849 {
3850 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3851 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003852 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853 else
3854 *pp = end;
3855 name = NULL;
3856 }
3857 goto theend;
3858 }
3859
3860 if (lv.ll_name == NULL)
3861 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003862 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003863 *pp = end;
3864 goto theend;
3865 }
3866
Bram Moolenaare38eab22019-12-05 21:50:01 +01003867 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 if (lv.ll_exp_name != NULL)
3869 {
3870 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003871 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003872 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003873 if (name == lv.ll_exp_name)
3874 name = NULL;
3875 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003876 else if (lv.ll_sid > 0)
3877 {
3878 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3879 int cc = *lv.ll_name_end;
3880
3881 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3882 *lv.ll_name_end = NUL;
3883 if (si->sn_autoload_prefix != NULL)
3884 {
3885 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3886 }
3887 else
3888 {
3889 sid_buf[0] = K_SPECIAL;
3890 sid_buf[1] = KS_EXTRA;
3891 sid_buf[2] = (int)KE_SNR;
3892 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003893 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003894 name = concat_str(sid_buf, lv.ll_name);
3895 }
3896 *lv.ll_name_end = cc;
3897 *pp = end;
3898 goto theend;
3899 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003900 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901 {
3902 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003903 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003904 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905 if (name == *pp)
3906 name = NULL;
3907 }
3908 if (name != NULL)
3909 {
3910 name = vim_strsave(name);
3911 *pp = end;
3912 if (STRNCMP(name, "<SNR>", 5) == 0)
3913 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003914 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 name[0] = K_SPECIAL;
3916 name[1] = KS_EXTRA;
3917 name[2] = (int)KE_SNR;
3918 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3919 }
3920 goto theend;
3921 }
3922
3923 if (lv.ll_exp_name != NULL)
3924 {
3925 len = (int)STRLEN(lv.ll_exp_name);
3926 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3927 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3928 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003929 // When there was "s:" already or the name expanded to get a
3930 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 lv.ll_name += 2;
3932 len -= 2;
3933 lead = 2;
3934 }
3935 }
3936 else
3937 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003938 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003940 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003941 if (lv.ll_name[0] == 'g')
3942 {
3943 if (is_global != NULL)
3944 {
3945 *is_global = TRUE;
3946 }
3947 else
3948 {
3949 // dropping "g:" without setting "is_global" won't work in
3950 // Vim9script, put it back later
3951 prefix_g = TRUE;
3952 extra = 2;
3953 }
3954 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003956 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 len = (int)(end - lv.ll_name);
3958 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003959 if (len <= 0)
3960 {
3961 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003962 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003963 goto theend;
3964 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003966 // In Vim9 script a user function is script-local by default, unless it
3967 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003968 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003969
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970 /*
3971 * Copy the function name to allocated memory.
3972 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3973 * Accept <SNR>123_name() outside a script.
3974 */
3975 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003976 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003977 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003979 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003980 {
Kota Kato948a3892022-08-16 16:09:59 +01003981 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
3982 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00003983 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01003984 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00003985 goto theend;
3986 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003987 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00003988 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00003989 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003990 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991 || eval_fname_sid(*pp))
3992 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003993 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003994 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00003996 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003997 goto theend;
3998 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003999 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004000 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004001 extra = 3 + (int)STRLEN(sid_buf);
4002 else
4003 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 }
4005 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004006 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004007 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004009 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004010 : e_function_name_must_start_with_capital_or_s_str),
4011 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 goto theend;
4013 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004014 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004015 {
4016 char_u *cp = vim_strchr(lv.ll_name, ':');
4017
4018 if (cp != NULL && cp < end)
4019 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004020 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 goto theend;
4022 }
4023 }
4024
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004025 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 if (name != NULL)
4027 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004028 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 {
4030 name[0] = K_SPECIAL;
4031 name[1] = KS_EXTRA;
4032 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004033 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034 STRCPY(name + 3, sid_buf);
4035 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004036 else if (prefix_g)
4037 {
4038 name[0] = 'g';
4039 name[1] = ':';
4040 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004041 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4042 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 }
4044 *pp = end;
4045
4046theend:
4047 clear_lval(&lv);
4048 return name;
4049}
4050
4051/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004052 * Assuming "name" is the result of trans_function_name() and it was prefixed
4053 * to use the script-local name, return the unmodified name (points into
4054 * "name"). Otherwise return NULL.
4055 * This can be used to first search for a script-local function and fall back
4056 * to the global function if not found.
4057 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004058 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004059untrans_function_name(char_u *name)
4060{
4061 char_u *p;
4062
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004063 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004064 {
4065 p = vim_strchr(name, '_');
4066 if (p != NULL)
4067 return p + 1;
4068 }
4069 return NULL;
4070}
4071
4072/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004073 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4074 * current script ID and returns the expanded function name. The caller should
4075 * free the returned name. If not called from a script context or the function
4076 * name doesn't start with these prefixes, then returns NULL.
4077 * This doesn't check whether the script-local function exists or not.
4078 */
4079 char_u *
4080get_scriptlocal_funcname(char_u *funcname)
4081{
4082 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004083 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004084 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004085 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004086
4087 if (funcname == NULL)
4088 return NULL;
4089
4090 if (STRNCMP(funcname, "s:", 2) != 0
4091 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004092 {
4093 ufunc_T *ufunc;
4094
4095 // The function name does not have a script-local prefix. Try finding
4096 // it when in a Vim9 script and there is no "g:" prefix.
4097 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4098 return NULL;
4099 ufunc = find_func(funcname, FALSE);
4100 if (ufunc == NULL || func_is_global(ufunc)
4101 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4102 return NULL;
4103 ++p;
4104 off = 0;
4105 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004106 else
4107 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004108
4109 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4110 {
4111 emsg(_(e_using_sid_not_in_script_context));
4112 return NULL;
4113 }
4114 // Expand s: prefix into <SNR>nr_<name>
4115 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4116 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004117 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004118 if (newname == NULL)
4119 return NULL;
4120 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004121 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004122
4123 return newname;
4124}
4125
4126/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004127 * Return script-local "fname" with the 3-byte sequence replaced by
4128 * printable <SNR> in allocated memory.
4129 */
4130 char_u *
4131alloc_printable_func_name(char_u *fname)
4132{
4133 char_u *n = alloc(STRLEN(fname + 3) + 6);
4134
4135 if (n != NULL)
4136 {
4137 STRCPY(n, "<SNR>");
4138 STRCPY(n + 5, fname + 3);
4139 }
4140 return n;
4141}
4142
4143/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004144 * Call trans_function_name(), except that a lambda is returned as-is.
4145 * Returns the name in allocated memory.
4146 */
4147 char_u *
4148save_function_name(
4149 char_u **name,
4150 int *is_global,
4151 int skip,
4152 int flags,
4153 funcdict_T *fudi)
4154{
4155 char_u *p = *name;
4156 char_u *saved;
4157
4158 if (STRNCMP(p, "<lambda>", 8) == 0)
4159 {
4160 p += 8;
4161 (void)getdigits(&p);
4162 saved = vim_strnsave(*name, p - *name);
4163 if (fudi != NULL)
4164 CLEAR_POINTER(fudi);
4165 }
4166 else
4167 saved = trans_function_name(&p, is_global, skip,
4168 flags, fudi, NULL, NULL);
4169 *name = p;
4170 return saved;
4171}
4172
4173/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004174 * List functions. When "regmatch" is NULL all of then.
4175 * Otherwise functions matching "regmatch".
4176 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004177 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004178list_functions(regmatch_T *regmatch)
4179{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004180 int changed = func_hashtab.ht_changed;
4181 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004182 hashitem_T *hi;
4183
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004184 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004185 {
4186 if (!HASHITEM_EMPTY(hi))
4187 {
4188 ufunc_T *fp = HI2UF(hi);
4189
4190 --todo;
4191 if ((fp->uf_flags & FC_DEAD) == 0
4192 && (regmatch == NULL
4193 ? !message_filtered(fp->uf_name)
4194 && !func_name_refcount(fp->uf_name)
4195 : !isdigit(*fp->uf_name)
4196 && vim_regexec(regmatch, fp->uf_name, 0)))
4197 {
4198 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004199 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004200 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004201 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004202 return;
4203 }
4204 }
4205 }
4206 }
4207}
4208
4209/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004210 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004211 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4212 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004213 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004214 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004215 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004216 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004217define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004219 int j;
4220 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004221 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004222 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004223 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004224 char_u *p;
4225 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004226 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227 char_u *line_arg = NULL;
4228 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004229 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004230 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231 garray_T newlines;
4232 int varargs = FALSE;
4233 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004234 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004235 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004236 int fp_allocated = FALSE;
4237 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004238 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239 dictitem_T *v;
4240 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004241 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004242 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004244 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004245 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004246 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247
4248 /*
4249 * ":function" without argument: list functions.
4250 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004251 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 {
4253 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004254 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004255 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004256 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257 }
4258
4259 /*
4260 * ":function /pat": list functions matching pattern.
4261 */
4262 if (*eap->arg == '/')
4263 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004264 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265 if (!eap->skip)
4266 {
4267 regmatch_T regmatch;
4268
4269 c = *p;
4270 *p = NUL;
4271 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4272 *p = c;
4273 if (regmatch.regprog != NULL)
4274 {
4275 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004276 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004277 vim_regfree(regmatch.regprog);
4278 }
4279 }
4280 if (*p == '/')
4281 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004282 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004283 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004284 }
4285
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004286 ga_init(&newargs);
4287 ga_init(&argtypes);
4288 ga_init(&default_args);
4289
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 /*
4291 * Get the function name. There are these situations:
4292 * func normal function name
4293 * "name" == func, "fudi.fd_dict" == NULL
4294 * dict.func new dictionary entry
4295 * "name" == NULL, "fudi.fd_dict" set,
4296 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4297 * dict.func existing dict entry with a Funcref
4298 * "name" == func, "fudi.fd_dict" set,
4299 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4300 * dict.func existing dict entry that's not a Funcref
4301 * "name" == NULL, "fudi.fd_dict" set,
4302 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4303 * s:func script-local function name
4304 * g:func global function name, same as "func"
4305 */
4306 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004307 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004309 // nested function, argument is (args).
4310 paren = TRUE;
4311 CLEAR_FIELD(fudi);
4312 }
4313 else
4314 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004315 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004316 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004317 if (p[0] == 's' && p[1] == ':')
4318 {
4319 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4320 return NULL;
4321 }
4322 p = to_name_end(p, TRUE);
4323 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4324 {
4325 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4326 eap->arg);
4327 return NULL;
4328 }
4329 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004330 }
4331
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004332 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004333 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004334 paren = (vim_strchr(p, '(') != NULL);
4335 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004336 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004337 /*
4338 * Return on an invalid expression in braces, unless the expression
4339 * evaluation has been cancelled due to an aborting error, an
4340 * interrupt, or an exception.
4341 */
4342 if (!aborting())
4343 {
4344 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004345 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004346 vim_free(fudi.fd_newkey);
4347 return NULL;
4348 }
4349 else
4350 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004352
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004353 // For "export def FuncName()" in an autoload script the function name
4354 // is stored with the legacy autoload name "dir#script#FuncName" so
4355 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004356 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004357 {
4358 char_u *prefixed = may_prefix_autoload(name);
4359
4360 if (prefixed != NULL && prefixed != name)
4361 {
4362 vim_free(name);
4363 name = prefixed;
4364 }
4365 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004366 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004367 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004368 {
4369 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4370 goto ret_free;
4371 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372 }
4373
Bram Moolenaare38eab22019-12-05 21:50:01 +01004374 // An error in a function call during evaluation of an expression in magic
4375 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376 saved_did_emsg = did_emsg;
4377 did_emsg = FALSE;
4378
4379 /*
4380 * ":function func" with only function name: list function.
4381 */
4382 if (!paren)
4383 {
4384 if (!ends_excmd(*skipwhite(p)))
4385 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004386 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387 goto ret_free;
4388 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004389 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390 if (eap->nextcmd != NULL)
4391 *p = NUL;
4392 if (!eap->skip && !got_int)
4393 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004394 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004395 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4396 {
4397 char_u *up = untrans_function_name(name);
4398
4399 // With Vim9 script the name was made script-local, if not
4400 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004401 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004402 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004403 }
4404
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 if (fp != NULL)
4406 {
4407 list_func_head(fp, TRUE);
4408 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4409 {
4410 if (FUNCLINE(fp, j) == NULL)
4411 continue;
4412 msg_putchar('\n');
4413 msg_outnum((long)(j + 1));
4414 if (j < 9)
4415 msg_putchar(' ');
4416 if (j < 99)
4417 msg_putchar(' ');
4418 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004419 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 ui_breakcheck();
4421 }
4422 if (!got_int)
4423 {
4424 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004425 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004426 msg_puts(" enddef");
4427 else
4428 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 }
4430 }
4431 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004432 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 }
4434 goto ret_free;
4435 }
4436
4437 /*
4438 * ":function name(arg1, arg2)" Define function.
4439 */
4440 p = skipwhite(p);
4441 if (*p != '(')
4442 {
4443 if (!eap->skip)
4444 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004445 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 goto ret_free;
4447 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004448 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449 if (vim_strchr(p, '(') != NULL)
4450 p = vim_strchr(p, '(');
4451 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004453 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4454 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004455 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004456 goto ret_free;
4457 }
4458
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004459 // In Vim9 script only global functions can be redefined.
4460 if (vim9script && eap->forceit && !is_global)
4461 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004462 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004463 goto ret_free;
4464 }
4465
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004466 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467
Bram Moolenaar04b12692020-05-04 23:24:44 +02004468 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004470 // Check the name of the function. Unless it's a dictionary function
4471 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 if (name != NULL)
4473 arg = name;
4474 else
4475 arg = fudi.fd_newkey;
4476 if (arg != NULL && (fudi.fd_di == NULL
4477 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4478 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4479 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004480 char_u *name_base = arg;
4481 int i;
4482
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004484 {
4485 name_base = vim_strchr(arg, '_');
4486 if (name_base == NULL)
4487 name_base = arg + 3;
4488 else
4489 ++name_base;
4490 }
4491 for (i = 0; name_base[i] != NUL && (i == 0
4492 ? eval_isnamec1(name_base[i])
4493 : eval_isnamec(name_base[i])); ++i)
4494 ;
4495 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004496 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004497
4498 // In Vim9 script a function cannot have the same name as a
4499 // variable.
4500 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004501 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4502 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004503 + EVAL_VAR_NO_FUNC) == OK)
4504 {
4505 semsg(_(e_redefining_script_item_str), name_base);
4506 goto ret_free;
4507 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004509 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004511 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004512 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004513 goto ret_free;
4514 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 }
4516
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004517 // This may get more lines and make the pointers into the first line
4518 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004519 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004520 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004521 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004522 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004523 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004525 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004526
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004527 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004528 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004529 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004530 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004531 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004532 if (*p != ':')
4533 {
4534 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4535 p = skipwhite(p);
4536 }
4537 else if (!IS_WHITE_OR_NUL(p[1]))
4538 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004539 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004540 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004541 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004542 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004543 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004544 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004545 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004546 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004547 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004548 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004549 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004550 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004553 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004555 else
4556 // find extra arguments "range", "dict", "abort" and "closure"
4557 for (;;)
4558 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004559 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004560 p = skipwhite(p);
4561 if (STRNCMP(p, "range", 5) == 0)
4562 {
4563 flags |= FC_RANGE;
4564 p += 5;
4565 }
4566 else if (STRNCMP(p, "dict", 4) == 0)
4567 {
4568 flags |= FC_DICT;
4569 p += 4;
4570 }
4571 else if (STRNCMP(p, "abort", 5) == 0)
4572 {
4573 flags |= FC_ABORT;
4574 p += 5;
4575 }
4576 else if (STRNCMP(p, "closure", 7) == 0)
4577 {
4578 flags |= FC_CLOSURE;
4579 p += 7;
4580 if (current_funccal == NULL)
4581 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004582 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004583 name == NULL ? (char_u *)"" : name);
4584 goto erret;
4585 }
4586 }
4587 else
4588 break;
4589 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590
Bram Moolenaare38eab22019-12-05 21:50:01 +01004591 // When there is a line break use what follows for the function body.
4592 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 if (*p == '\n')
4594 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004595 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004596 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4597 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004598 && !(VIM_ISWHITE(*whitep) && *p == '#'
4599 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004600 && !eap->skip
4601 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004602 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603
4604 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004605 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4606 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607 */
4608 if (KeyTyped)
4609 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004610 // Check if the function already exists, don't let the user type the
4611 // whole function before telling him it doesn't work! For a script we
4612 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004613 if (!eap->skip && !eap->forceit)
4614 {
4615 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004616 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004617 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004618 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 }
4620
4621 if (!eap->skip && did_emsg)
4622 goto erret;
4623
Bram Moolenaare38eab22019-12-05 21:50:01 +01004624 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625 cmdline_row = msg_row;
4626 }
4627
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004628 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004629 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004630
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004631 // Do not define the function when getting the body fails and when
4632 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004633 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004634 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004635 goto erret;
4636
4637 /*
4638 * If there are no errors, add the function
4639 */
4640 if (fudi.fd_dict == NULL)
4641 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004642 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004643 char_u *find_name = name;
4644 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004645 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004646
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004647 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004648 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004649 var_conflict = TRUE;
4650
4651 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4652 {
4653 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4654
4655 if (si->sn_autoload_prefix != NULL)
4656 {
4657 if (is_export)
4658 {
4659 find_name = name + STRLEN(si->sn_autoload_prefix);
4660 v = find_var(find_name, &ht, TRUE);
4661 if (v != NULL)
4662 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004663 // Only check if the function already exists in the script,
4664 // global functions can be shadowed.
4665 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004666 }
4667 else
4668 {
4669 char_u *prefixed = may_prefix_autoload(name);
4670
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004671 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004672 {
4673 v = find_var(prefixed, &ht, TRUE);
4674 if (v != NULL)
4675 var_conflict = TRUE;
4676 vim_free(prefixed);
4677 }
4678 }
4679 }
4680 }
4681 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004683 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 goto erret;
4685 }
4686
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004687 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004688 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004689 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004690 char_u *uname = untrans_function_name(name);
4691
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004692 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004693 }
4694
4695 if (fp != NULL || import != NULL)
4696 {
4697 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004698
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004699 // Function can be replaced with "function!" and when sourcing the
4700 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004701 // A name that is used by an import can not be overruled.
4702 if (import != NULL
4703 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004704 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004705 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004706 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004707 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004708 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004709 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004710 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004711 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004712 goto erret;
4713 }
4714 if (fp->uf_calls > 0)
4715 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004716 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004717 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718 goto erret;
4719 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004720 if (fp->uf_refcount > 1)
4721 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004722 // This function is referenced somewhere, don't redefine it but
4723 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004724 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004725 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004726 fp = NULL;
4727 overwrite = TRUE;
4728 }
4729 else
4730 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004731 char_u *exp_name = fp->uf_name_exp;
4732
4733 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004734 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004735 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004736 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004737 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004738 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004739#ifdef FEAT_PROFILE
4740 fp->uf_profiling = FALSE;
4741 fp->uf_prof_initialized = FALSE;
4742#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004743 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004744 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745 }
4746 }
4747 else
4748 {
4749 char numbuf[20];
4750
4751 fp = NULL;
4752 if (fudi.fd_newkey == NULL && !eap->forceit)
4753 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004754 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004755 goto erret;
4756 }
4757 if (fudi.fd_di == NULL)
4758 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004759 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004760 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761 goto erret;
4762 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004763 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004764 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004765 goto erret;
4766
Bram Moolenaare38eab22019-12-05 21:50:01 +01004767 // Give the function a sequential number. Can only be used with a
4768 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769 vim_free(name);
4770 sprintf(numbuf, "%d", ++func_nr);
4771 name = vim_strsave((char_u *)numbuf);
4772 if (name == NULL)
4773 goto erret;
4774 }
4775
4776 if (fp == NULL)
4777 {
4778 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4779 {
4780 int slen, plen;
4781 char_u *scriptname;
4782
Bram Moolenaare38eab22019-12-05 21:50:01 +01004783 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004785 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 {
4787 scriptname = autoload_name(name);
4788 if (scriptname != NULL)
4789 {
4790 p = vim_strchr(scriptname, '/');
4791 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004792 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004794 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 j = OK;
4796 vim_free(scriptname);
4797 }
4798 }
4799 if (j == FAIL)
4800 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004801 linenr_T save_lnum = SOURCING_LNUM;
4802
4803 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004804 semsg(_(e_function_name_does_not_match_script_file_name_str),
4805 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004806 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 goto erret;
4808 }
4809 }
4810
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004811 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 if (fp == NULL)
4813 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004814 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004815
4816 if (fudi.fd_dict != NULL)
4817 {
4818 if (fudi.fd_di == NULL)
4819 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004820 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004821 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4822 if (fudi.fd_di == NULL)
4823 {
4824 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004825 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826 goto erret;
4827 }
4828 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4829 {
4830 vim_free(fudi.fd_di);
4831 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004832 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 goto erret;
4834 }
4835 }
4836 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004837 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 clear_tv(&fudi.fd_di->di_tv);
4839 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004840 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004841
Bram Moolenaare38eab22019-12-05 21:50:01 +01004842 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004843 flags |= FC_DICT;
4844 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004845 }
4846 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004847 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004848 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004849 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004850
4851 if (eap->cmdidx == CMD_def)
4852 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004853 int lnum_save = SOURCING_LNUM;
4854 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004855
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004856 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004857
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004858 // error messages are for the first function line
4859 SOURCING_LNUM = sourcing_lnum_top;
4860
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004861 // The function may use script variables from the context.
4862 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004863
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004864 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004865 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004866 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004867 free_fp = fp_allocated;
4868 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004869 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004870 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004871
4872 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004873 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004874 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004875 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004876 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004877 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004878 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004879 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004880 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004881 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004882 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004883
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004884 if (fp_allocated)
4885 {
4886 // insert the new function in the function list
4887 set_ufunc_name(fp, name);
4888 if (overwrite)
4889 {
4890 hi = hash_find(&func_hashtab, name);
4891 hi->hi_key = UF2HIKEY(fp);
4892 }
4893 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4894 {
4895 free_fp = TRUE;
4896 goto erret;
4897 }
4898 fp->uf_refcount = 1;
4899 }
4900
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004902 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004903 if ((flags & FC_CLOSURE) != 0)
4904 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004905 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004906 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004907 }
4908 else
4909 fp->uf_scoped = NULL;
4910
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004911#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912 if (prof_def_func())
4913 func_do_profile(fp);
4914#endif
4915 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004916 if (sandbox)
4917 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004918 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004919 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004920 fp->uf_flags = flags;
4921 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004922 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004923 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004924 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004925 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004926 if (is_export)
4927 {
4928 fp->uf_flags |= FC_EXPORT;
4929 // let ex_export() know the export worked.
4930 is_export = FALSE;
4931 }
4932
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004933 if (eap->cmdidx == CMD_def)
4934 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004935 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4936 // :func does not use Vim9 script syntax, even in a Vim9 script file
4937 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004938
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939 goto ret_free;
4940
4941erret:
4942 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004943 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004944 if (fp != NULL)
4945 {
4946 ga_init(&fp->uf_args);
4947 ga_init(&fp->uf_def_args);
4948 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004949errret_2:
4950 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004951 if (fp != NULL)
4952 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004953 if (free_fp)
4954 {
4955 vim_free(fp);
4956 fp = NULL;
4957 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004958ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004959 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004960 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004961 if (name != name_arg)
4962 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004963 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004964 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004965
4966 return fp;
4967}
4968
4969/*
4970 * ":function"
4971 */
4972 void
4973ex_function(exarg_T *eap)
4974{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004975 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004976
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004977 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4978 (void)define_function(eap, NULL, &lines_to_free);
4979 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004980}
4981
4982/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01004983 * Find a function by name, including "<lambda>123".
4984 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01004985 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01004986 * Return NULL if not found.
4987 */
4988 ufunc_T *
4989find_func_by_name(char_u *name, compiletype_T *compile_type)
4990{
4991 char_u *arg = name;
4992 char_u *fname;
4993 ufunc_T *ufunc;
4994 int is_global = FALSE;
4995
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01004996 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
4997 {
4998 *compile_type = CT_PROFILE;
4999 arg = skipwhite(arg + 7);
5000 }
5001 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5002 {
5003 *compile_type = CT_DEBUG;
5004 arg = skipwhite(arg + 5);
5005 }
5006
5007 if (STRNCMP(arg, "<lambda>", 8) == 0)
5008 {
5009 arg += 8;
5010 (void)getdigits(&arg);
5011 fname = vim_strnsave(name, arg - name);
5012 }
5013 else
5014 fname = trans_function_name(&arg, &is_global, FALSE,
5015 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5016 if (fname == NULL)
5017 {
5018 semsg(_(e_invalid_argument_str), name);
5019 return NULL;
5020 }
5021 if (!ends_excmd2(name, arg))
5022 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005023 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005024 emsg(ex_errmsg(e_trailing_characters_str, arg));
5025 return NULL;
5026 }
5027
5028 ufunc = find_func(fname, is_global);
5029 if (ufunc == NULL)
5030 {
5031 char_u *p = untrans_function_name(fname);
5032
5033 if (p != NULL)
5034 // Try again without making it script-local.
5035 ufunc = find_func(p, FALSE);
5036 }
5037 vim_free(fname);
5038 if (ufunc == NULL)
5039 semsg(_(e_cannot_find_function_str), name);
5040 return ufunc;
5041}
5042
5043/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005044 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005045 * be compiled or the one specified by the argument.
5046 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005047 */
5048 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005049ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005050{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005051 ufunc_T *ufunc;
5052
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005053 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005054 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005055 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005056
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005057 ufunc = find_func_by_name(eap->arg, &compile_type);
5058 if (ufunc != NULL)
5059 {
5060 if (func_needs_compiling(ufunc, compile_type))
5061 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5062 else
5063 smsg(_("Function %s does not need compiling"), eap->arg);
5064 }
5065 }
5066 else
5067 {
5068 long todo = (long)func_hashtab.ht_used;
5069 int changed = func_hashtab.ht_changed;
5070 hashitem_T *hi;
5071
5072 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5073 {
5074 if (!HASHITEM_EMPTY(hi))
5075 {
5076 --todo;
5077 ufunc = HI2UF(hi);
5078 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5079 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5080 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005081 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005082 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5083
5084 if (func_hashtab.ht_changed != changed)
5085 {
5086 // a function has been added or removed, need to start
5087 // over
5088 todo = (long)func_hashtab.ht_used;
5089 changed = func_hashtab.ht_changed;
5090 hi = func_hashtab.ht_array;
5091 --hi;
5092 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005093 }
5094 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005095 }
5096 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005097}
5098
5099/*
5100 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5101 * Return 2 if "p" starts with "s:".
5102 * Return 0 otherwise.
5103 */
5104 int
5105eval_fname_script(char_u *p)
5106{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005107 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5108 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5110 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5111 return 5;
5112 if (p[0] == 's' && p[1] == ':')
5113 return 2;
5114 return 0;
5115}
5116
5117 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005118translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005119{
5120 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005121 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005122 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005123}
5124
5125/*
5126 * Return TRUE when "ufunc" has old-style "..." varargs
5127 * or named varargs "...name: type".
5128 */
5129 int
5130has_varargs(ufunc_T *ufunc)
5131{
5132 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005133}
5134
5135/*
5136 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005137 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005138 */
5139 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005140function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005141{
5142 char_u *nm = name;
5143 char_u *p;
5144 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005145 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005146 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005148 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5149 if (no_deref)
5150 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005151 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 nm = skipwhite(nm);
5153
Bram Moolenaare38eab22019-12-05 21:50:01 +01005154 // Only accept "funcname", "funcname ", "funcname (..." and
5155 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005156 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005157 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005158 vim_free(p);
5159 return n;
5160}
5161
Bram Moolenaar113e1072019-01-20 15:30:40 +01005162#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005163 char_u *
5164get_expanded_name(char_u *name, int check)
5165{
5166 char_u *nm = name;
5167 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005168 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005170 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005171 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005173 if (p != NULL && *nm == NUL
5174 && (!check || translated_function_exists(p, is_global)))
5175 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005176
5177 vim_free(p);
5178 return NULL;
5179}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005180#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005181
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005182/*
5183 * Function given to ExpandGeneric() to obtain the list of user defined
5184 * function names.
5185 */
5186 char_u *
5187get_user_func_name(expand_T *xp, int idx)
5188{
5189 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005190 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005191 static hashitem_T *hi;
5192 ufunc_T *fp;
5193
5194 if (idx == 0)
5195 {
5196 done = 0;
5197 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005198 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005199 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005200 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201 {
5202 if (done++ > 0)
5203 ++hi;
5204 while (HASHITEM_EMPTY(hi))
5205 ++hi;
5206 fp = HI2UF(hi);
5207
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005208 // don't show dead, dict and lambda functions
5209 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005210 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005211 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212
5213 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005214 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215
5216 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005217 if (xp->xp_context != EXPAND_USER_FUNC
5218 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005219 {
5220 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005221 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005222 STRCAT(IObuff, ")");
5223 }
5224 return IObuff;
5225 }
5226 return NULL;
5227}
5228
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005229/*
5230 * ":delfunction {name}"
5231 */
5232 void
5233ex_delfunction(exarg_T *eap)
5234{
5235 ufunc_T *fp = NULL;
5236 char_u *p;
5237 char_u *name;
5238 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005239 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005240
5241 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005242 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5243 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005244 vim_free(fudi.fd_newkey);
5245 if (name == NULL)
5246 {
5247 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005248 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249 return;
5250 }
5251 if (!ends_excmd(*skipwhite(p)))
5252 {
5253 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005254 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005255 return;
5256 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005257 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258 if (eap->nextcmd != NULL)
5259 *p = NUL;
5260
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005261 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005262 {
5263 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005264 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005265 vim_free(name);
5266 return;
5267 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005268 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005269 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005270 vim_free(name);
5271
5272 if (!eap->skip)
5273 {
5274 if (fp == NULL)
5275 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005276 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005277 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005278 return;
5279 }
5280 if (fp->uf_calls > 0)
5281 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005282 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005283 return;
5284 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005285 if (fp->uf_flags & FC_VIM9)
5286 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005287 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005288 return;
5289 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005290
5291 if (fudi.fd_dict != NULL)
5292 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005293 // Delete the dict item that refers to the function, it will
5294 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005295 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5296 }
5297 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005298 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005299 // A normal function (not a numbered function or lambda) has a
5300 // refcount of 1 for the entry in the hashtable. When deleting
5301 // it and the refcount is more than one, it should be kept.
5302 // A numbered function and lambda should be kept if the refcount is
5303 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005304 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005305 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005306 // Function is still referenced somewhere. Don't free it but
5307 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005308 if (func_remove(fp))
5309 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005310 }
5311 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005312 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005313 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 }
5315}
5316
5317/*
5318 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005319 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005320 */
5321 void
5322func_unref(char_u *name)
5323{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005324 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005325
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005326 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005327 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005328 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005329 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005330 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005331#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005332 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005333#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005334 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005335 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005336 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005337}
5338
5339/*
5340 * Unreference a Function: decrement the reference count and free it when it
5341 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005342 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005343 */
5344 void
5345func_ptr_unref(ufunc_T *fp)
5346{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005347 if (fp != NULL && (--fp->uf_refcount <= 0
5348 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5349 && fp->uf_partial->pt_refcount <= 1
5350 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005351 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005352 // Only delete it when it's not being used. Otherwise it's done
5353 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005354 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005355 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005356 }
5357}
5358
5359/*
5360 * Count a reference to a Function.
5361 */
5362 void
5363func_ref(char_u *name)
5364{
5365 ufunc_T *fp;
5366
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005367 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005368 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005369 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005370 if (fp != NULL)
5371 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005372 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005373 // Only give an error for a numbered function.
5374 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005375 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005376}
5377
5378/*
5379 * Count a reference to a Function.
5380 */
5381 void
5382func_ptr_ref(ufunc_T *fp)
5383{
5384 if (fp != NULL)
5385 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005386}
5387
5388/*
5389 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5390 * referenced from anywhere that is in use.
5391 */
5392 static int
5393can_free_funccal(funccall_T *fc, int copyID)
5394{
5395 return (fc->l_varlist.lv_copyID != copyID
5396 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005397 && fc->l_avars.dv_copyID != copyID
5398 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399}
5400
5401/*
5402 * ":return [expr]"
5403 */
5404 void
5405ex_return(exarg_T *eap)
5406{
5407 char_u *arg = eap->arg;
5408 typval_T rettv;
5409 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005410 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005411
5412 if (current_funccal == NULL)
5413 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005414 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005415 return;
5416 }
5417
Bram Moolenaar844fb642021-10-23 13:32:30 +01005418 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005419 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5420
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005421 if (eap->skip)
5422 ++emsg_skip;
5423
5424 eap->nextcmd = NULL;
5425 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005426 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005427 {
5428 if (!eap->skip)
5429 returning = do_return(eap, FALSE, TRUE, &rettv);
5430 else
5431 clear_tv(&rettv);
5432 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005433 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005434 else if (!eap->skip)
5435 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005436 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005437 update_force_abort();
5438
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005439 /*
5440 * Return unless the expression evaluation has been cancelled due to an
5441 * aborting error, an interrupt, or an exception.
5442 */
5443 if (!aborting())
5444 returning = do_return(eap, FALSE, TRUE, NULL);
5445 }
5446
Bram Moolenaare38eab22019-12-05 21:50:01 +01005447 // When skipping or the return gets pending, advance to the next command
5448 // in this line (!returning). Otherwise, ignore the rest of the line.
5449 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005450 if (returning)
5451 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005452 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005453 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005454
5455 if (eap->skip)
5456 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005457 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005458}
5459
5460/*
5461 * ":1,25call func(arg1, arg2)" function call.
5462 */
5463 void
5464ex_call(exarg_T *eap)
5465{
5466 char_u *arg = eap->arg;
5467 char_u *startarg;
5468 char_u *name;
5469 char_u *tofree;
5470 int len;
5471 typval_T rettv;
5472 linenr_T lnum;
5473 int doesrange;
5474 int failed = FALSE;
5475 funcdict_T fudi;
5476 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005477 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005478 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005479 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005480 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005481
Bram Moolenaare6b53242020-07-01 17:28:33 +02005482 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005483 if (eap->skip)
5484 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005485 // trans_function_name() doesn't work well when skipping, use eval0()
5486 // instead to skip to any following command, e.g. for:
5487 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005488 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005489 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005490 clear_tv(&rettv);
5491 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005492 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005493 return;
5494 }
5495
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005496 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005497 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005498 if (fudi.fd_newkey != NULL)
5499 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005500 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005501 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005502 vim_free(fudi.fd_newkey);
5503 }
5504 if (tofree == NULL)
5505 return;
5506
Bram Moolenaare38eab22019-12-05 21:50:01 +01005507 // Increase refcount on dictionary, it could get deleted when evaluating
5508 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005509 if (fudi.fd_dict != NULL)
5510 ++fudi.fd_dict->dv_refcount;
5511
Bram Moolenaare38eab22019-12-05 21:50:01 +01005512 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5513 // contents. For VAR_PARTIAL get its partial, unless we already have one
5514 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005516 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005517 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005518 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519
Bram Moolenaare38eab22019-12-05 21:50:01 +01005520 // Skip white space to allow ":call func ()". Not good, but required for
5521 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005522 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005523 if (*startarg != '(')
5524 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005525 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005526 goto end;
5527 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005528 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005529 {
5530 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5531 goto end;
5532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005533
5534 /*
5535 * When skipping, evaluate the function once, to find the end of the
5536 * arguments.
5537 * When the function takes a range, this is discovered after the first
5538 * call, and the loop is broken.
5539 */
5540 if (eap->skip)
5541 {
5542 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005543 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005544 }
5545 else
5546 lnum = eap->line1;
5547 for ( ; lnum <= eap->line2; ++lnum)
5548 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005549 funcexe_T funcexe;
5550
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005551 if (!eap->skip && eap->addr_count > 0)
5552 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005553 if (lnum > curbuf->b_ml.ml_line_count)
5554 {
5555 // If the function deleted lines or switched to another buffer
5556 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005557 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005558 break;
5559 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005560 curwin->w_cursor.lnum = lnum;
5561 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005562 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005563 }
5564 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005565
Bram Moolenaara80faa82020-04-12 19:37:17 +02005566 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005567 funcexe.fe_firstline = eap->line1;
5568 funcexe.fe_lastline = eap->line2;
5569 funcexe.fe_doesrange = &doesrange;
5570 funcexe.fe_evaluate = !eap->skip;
5571 funcexe.fe_partial = partial;
5572 funcexe.fe_selfdict = fudi.fd_dict;
5573 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005574 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005575 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005576 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005577 {
5578 failed = TRUE;
5579 break;
5580 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005581 if (has_watchexpr())
5582 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005583
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005584 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005585 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005586 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005587 {
5588 failed = TRUE;
5589 break;
5590 }
5591
5592 clear_tv(&rettv);
5593 if (doesrange || eap->skip)
5594 break;
5595
Bram Moolenaare38eab22019-12-05 21:50:01 +01005596 // Stop when immediately aborting on error, or when an interrupt
5597 // occurred or an exception was thrown but not caught.
5598 // get_func_tv() returned OK, so that the check for trailing
5599 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005600 if (aborting())
5601 break;
5602 }
5603 if (eap->skip)
5604 --emsg_skip;
5605
Bram Moolenaar1d341892021-09-18 15:25:52 +02005606 // When inside :try we need to check for following "| catch" or "| endtry".
5607 // Not when there was an error, but do check if an exception was thrown.
5608 if ((!aborting() || did_throw)
5609 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005610 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005611 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005612 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005613 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005614 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005615 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005616 {
5617 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005618 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005619 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005620 }
5621 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005622 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005623 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005624 // Must be after using "arg", it may point into memory cleared here.
5625 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005626
5627end:
5628 dict_unref(fudi.fd_dict);
5629 vim_free(tofree);
5630}
5631
5632/*
5633 * Return from a function. Possibly makes the return pending. Also called
5634 * for a pending return at the ":endtry" or after returning from an extra
5635 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5636 * when called due to a ":return" command. "rettv" may point to a typval_T
5637 * with the return rettv. Returns TRUE when the return can be carried out,
5638 * FALSE when the return gets pending.
5639 */
5640 int
5641do_return(
5642 exarg_T *eap,
5643 int reanimate,
5644 int is_cmd,
5645 void *rettv)
5646{
5647 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005648 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005649
5650 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005651 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005652 current_funccal->returned = FALSE;
5653
5654 /*
5655 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5656 * not in its finally clause (which then is to be executed next) is found.
5657 * In this case, make the ":return" pending for execution at the ":endtry".
5658 * Otherwise, return normally.
5659 */
5660 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5661 if (idx >= 0)
5662 {
5663 cstack->cs_pending[idx] = CSTP_RETURN;
5664
5665 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005666 // A pending return again gets pending. "rettv" points to an
5667 // allocated variable with the rettv of the original ":return"'s
5668 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005669 cstack->cs_rettv[idx] = rettv;
5670 else
5671 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005672 // When undoing a return in order to make it pending, get the stored
5673 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005674 if (reanimate)
5675 rettv = current_funccal->rettv;
5676
5677 if (rettv != NULL)
5678 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005679 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005680 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5681 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5682 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005683 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005684 }
5685 else
5686 cstack->cs_rettv[idx] = NULL;
5687
5688 if (reanimate)
5689 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005690 // The pending return value could be overwritten by a ":return"
5691 // without argument in a finally clause; reset the default
5692 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005693 current_funccal->rettv->v_type = VAR_NUMBER;
5694 current_funccal->rettv->vval.v_number = 0;
5695 }
5696 }
5697 report_make_pending(CSTP_RETURN, rettv);
5698 }
5699 else
5700 {
5701 current_funccal->returned = TRUE;
5702
Bram Moolenaare38eab22019-12-05 21:50:01 +01005703 // If the return is carried out now, store the return value. For
5704 // a return immediately after reanimation, the value is already
5705 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005706 if (!reanimate && rettv != NULL)
5707 {
5708 clear_tv(current_funccal->rettv);
5709 *current_funccal->rettv = *(typval_T *)rettv;
5710 if (!is_cmd)
5711 vim_free(rettv);
5712 }
5713 }
5714
5715 return idx < 0;
5716}
5717
5718/*
5719 * Free the variable with a pending return value.
5720 */
5721 void
5722discard_pending_return(void *rettv)
5723{
5724 free_tv((typval_T *)rettv);
5725}
5726
5727/*
5728 * Generate a return command for producing the value of "rettv". The result
5729 * is an allocated string. Used by report_pending() for verbose messages.
5730 */
5731 char_u *
5732get_return_cmd(void *rettv)
5733{
5734 char_u *s = NULL;
5735 char_u *tofree = NULL;
5736 char_u numbuf[NUMBUFLEN];
5737
5738 if (rettv != NULL)
5739 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5740 if (s == NULL)
5741 s = (char_u *)"";
5742
5743 STRCPY(IObuff, ":return ");
5744 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5745 if (STRLEN(s) + 8 >= IOSIZE)
5746 STRCPY(IObuff + IOSIZE - 4, "...");
5747 vim_free(tofree);
5748 return vim_strsave(IObuff);
5749}
5750
5751/*
5752 * Get next function line.
5753 * Called by do_cmdline() to get the next line.
5754 * Returns allocated string, or NULL for end of function.
5755 */
5756 char_u *
5757get_func_line(
5758 int c UNUSED,
5759 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005760 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005761 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005762{
5763 funccall_T *fcp = (funccall_T *)cookie;
5764 ufunc_T *fp = fcp->func;
5765 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005766 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005767
Bram Moolenaare38eab22019-12-05 21:50:01 +01005768 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005769 if (fcp->dbg_tick != debug_tick)
5770 {
5771 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005772 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005773 fcp->dbg_tick = debug_tick;
5774 }
5775#ifdef FEAT_PROFILE
5776 if (do_profiling == PROF_YES)
5777 func_line_end(cookie);
5778#endif
5779
5780 gap = &fp->uf_lines;
5781 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5782 || fcp->returned)
5783 retval = NULL;
5784 else
5785 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005786 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005787 while (fcp->linenr < gap->ga_len
5788 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5789 ++fcp->linenr;
5790 if (fcp->linenr >= gap->ga_len)
5791 retval = NULL;
5792 else
5793 {
5794 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005795 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005796#ifdef FEAT_PROFILE
5797 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005798 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005799#endif
5800 }
5801 }
5802
Bram Moolenaare38eab22019-12-05 21:50:01 +01005803 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005804 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005805 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005806 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005807 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005808 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005809 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005810 fcp->dbg_tick = debug_tick;
5811 }
5812
5813 return retval;
5814}
5815
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005816/*
5817 * Return TRUE if the currently active function should be ended, because a
5818 * return was encountered or an error occurred. Used inside a ":while".
5819 */
5820 int
5821func_has_ended(void *cookie)
5822{
5823 funccall_T *fcp = (funccall_T *)cookie;
5824
Bram Moolenaare38eab22019-12-05 21:50:01 +01005825 // Ignore the "abort" flag if the abortion behavior has been changed due to
5826 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005827 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5828 || fcp->returned);
5829}
5830
5831/*
5832 * return TRUE if cookie indicates a function which "abort"s on errors.
5833 */
5834 int
5835func_has_abort(
5836 void *cookie)
5837{
5838 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5839}
5840
5841
5842/*
5843 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5844 * Don't do this when "Func" is already a partial that was bound
5845 * explicitly (pt_auto is FALSE).
5846 * Changes "rettv" in-place.
5847 * Returns the updated "selfdict_in".
5848 */
5849 dict_T *
5850make_partial(dict_T *selfdict_in, typval_T *rettv)
5851{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005852 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005853 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005854 char_u fname_buf[FLEN_FIXED + 1];
5855 int error;
5856 dict_T *selfdict = selfdict_in;
5857
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005858 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
5859 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005860 fp = rettv->vval.v_partial->pt_func;
5861 else
5862 {
5863 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005864 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005865 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005866 if (fname == NULL)
5867 {
5868 // There is no point binding a dict to a NULL function, just create
5869 // a function reference.
5870 rettv->v_type = VAR_FUNC;
5871 rettv->vval.v_string = NULL;
5872 }
5873 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00005874 {
5875 char_u *tofree = NULL;
5876
5877 // Translate "s:func" to the stored function name.
5878 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
5879 fp = find_func(fname, FALSE);
5880 vim_free(tofree);
5881 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005882 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005883
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005884 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005885 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005886 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005887
5888 if (pt != NULL)
5889 {
5890 pt->pt_refcount = 1;
5891 pt->pt_dict = selfdict;
5892 pt->pt_auto = TRUE;
5893 selfdict = NULL;
5894 if (rettv->v_type == VAR_FUNC)
5895 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005896 // Just a function: Take over the function name and use
5897 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005898 pt->pt_name = rettv->vval.v_string;
5899 }
5900 else
5901 {
5902 partial_T *ret_pt = rettv->vval.v_partial;
5903 int i;
5904
Bram Moolenaare38eab22019-12-05 21:50:01 +01005905 // Partial: copy the function name, use selfdict and copy
5906 // args. Can't take over name or args, the partial might
5907 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005908 if (ret_pt->pt_name != NULL)
5909 {
5910 pt->pt_name = vim_strsave(ret_pt->pt_name);
5911 func_ref(pt->pt_name);
5912 }
5913 else
5914 {
5915 pt->pt_func = ret_pt->pt_func;
5916 func_ptr_ref(pt->pt_func);
5917 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005918 if (ret_pt->pt_argc > 0)
5919 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005920 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005921 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005922 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005923 pt->pt_argc = 0;
5924 else
5925 {
5926 pt->pt_argc = ret_pt->pt_argc;
5927 for (i = 0; i < pt->pt_argc; i++)
5928 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5929 }
5930 }
5931 partial_unref(ret_pt);
5932 }
5933 rettv->v_type = VAR_PARTIAL;
5934 rettv->vval.v_partial = pt;
5935 }
5936 }
5937 return selfdict;
5938}
5939
5940/*
5941 * Return the name of the executed function.
5942 */
5943 char_u *
5944func_name(void *cookie)
5945{
5946 return ((funccall_T *)cookie)->func->uf_name;
5947}
5948
5949/*
5950 * Return the address holding the next breakpoint line for a funccall cookie.
5951 */
5952 linenr_T *
5953func_breakpoint(void *cookie)
5954{
5955 return &((funccall_T *)cookie)->breakpoint;
5956}
5957
5958/*
5959 * Return the address holding the debug tick for a funccall cookie.
5960 */
5961 int *
5962func_dbg_tick(void *cookie)
5963{
5964 return &((funccall_T *)cookie)->dbg_tick;
5965}
5966
5967/*
5968 * Return the nesting level for a funccall cookie.
5969 */
5970 int
5971func_level(void *cookie)
5972{
5973 return ((funccall_T *)cookie)->level;
5974}
5975
5976/*
5977 * Return TRUE when a function was ended by a ":return" command.
5978 */
5979 int
5980current_func_returned(void)
5981{
5982 return current_funccal->returned;
5983}
5984
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005985 int
5986free_unref_funccal(int copyID, int testing)
5987{
5988 int did_free = FALSE;
5989 int did_free_funccal = FALSE;
5990 funccall_T *fc, **pfc;
5991
5992 for (pfc = &previous_funccal; *pfc != NULL; )
5993 {
5994 if (can_free_funccal(*pfc, copyID))
5995 {
5996 fc = *pfc;
5997 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005998 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005999 did_free = TRUE;
6000 did_free_funccal = TRUE;
6001 }
6002 else
6003 pfc = &(*pfc)->caller;
6004 }
6005 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006006 // When a funccal was freed some more items might be garbage
6007 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006008 (void)garbage_collect(testing);
6009
6010 return did_free;
6011}
6012
6013/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006014 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006015 */
6016 static funccall_T *
6017get_funccal(void)
6018{
6019 int i;
6020 funccall_T *funccal;
6021 funccall_T *temp_funccal;
6022
6023 funccal = current_funccal;
6024 if (debug_backtrace_level > 0)
6025 {
6026 for (i = 0; i < debug_backtrace_level; i++)
6027 {
6028 temp_funccal = funccal->caller;
6029 if (temp_funccal)
6030 funccal = temp_funccal;
6031 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006032 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006033 debug_backtrace_level = i;
6034 }
6035 }
6036 return funccal;
6037}
6038
6039/*
6040 * Return the hashtable used for local variables in the current funccal.
6041 * Return NULL if there is no current funccal.
6042 */
6043 hashtab_T *
6044get_funccal_local_ht()
6045{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006046 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006047 return NULL;
6048 return &get_funccal()->l_vars.dv_hashtab;
6049}
6050
6051/*
6052 * Return the l: scope variable.
6053 * Return NULL if there is no current funccal.
6054 */
6055 dictitem_T *
6056get_funccal_local_var()
6057{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006058 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006059 return NULL;
6060 return &get_funccal()->l_vars_var;
6061}
6062
6063/*
6064 * Return the hashtable used for argument in the current funccal.
6065 * Return NULL if there is no current funccal.
6066 */
6067 hashtab_T *
6068get_funccal_args_ht()
6069{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006070 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006071 return NULL;
6072 return &get_funccal()->l_avars.dv_hashtab;
6073}
6074
6075/*
6076 * Return the a: scope variable.
6077 * Return NULL if there is no current funccal.
6078 */
6079 dictitem_T *
6080get_funccal_args_var()
6081{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006082 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006083 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01006084 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006085}
6086
6087/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006088 * List function variables, if there is a function.
6089 */
6090 void
6091list_func_vars(int *first)
6092{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006093 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006094 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006095 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006096}
6097
6098/*
6099 * If "ht" is the hashtable for local variables in the current funccal, return
6100 * the dict that contains it.
6101 * Otherwise return NULL.
6102 */
6103 dict_T *
6104get_current_funccal_dict(hashtab_T *ht)
6105{
6106 if (current_funccal != NULL
6107 && ht == &current_funccal->l_vars.dv_hashtab)
6108 return &current_funccal->l_vars;
6109 return NULL;
6110}
6111
6112/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006113 * Search hashitem in parent scope.
6114 */
6115 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006116find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006117{
6118 funccall_T *old_current_funccal = current_funccal;
6119 hashtab_T *ht;
6120 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006121 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006122
6123 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6124 return NULL;
6125
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006126 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006127 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006128 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006129 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006130 ht = find_var_ht(name, &varname);
6131 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006132 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006133 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006134 if (!HASHITEM_EMPTY(hi))
6135 {
6136 *pht = ht;
6137 break;
6138 }
6139 }
6140 if (current_funccal == current_funccal->func->uf_scoped)
6141 break;
6142 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006143 }
6144 current_funccal = old_current_funccal;
6145
6146 return hi;
6147}
6148
6149/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006150 * Search variable in parent scope.
6151 */
6152 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006153find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006154{
6155 dictitem_T *v = NULL;
6156 funccall_T *old_current_funccal = current_funccal;
6157 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006158 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006159
6160 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6161 return NULL;
6162
Bram Moolenaare38eab22019-12-05 21:50:01 +01006163 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006164 current_funccal = current_funccal->func->uf_scoped;
6165 while (current_funccal)
6166 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006167 ht = find_var_ht(name, &varname);
6168 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006169 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006170 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006171 if (v != NULL)
6172 break;
6173 }
6174 if (current_funccal == current_funccal->func->uf_scoped)
6175 break;
6176 current_funccal = current_funccal->func->uf_scoped;
6177 }
6178 current_funccal = old_current_funccal;
6179
6180 return v;
6181}
6182
6183/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006184 * Set "copyID + 1" in previous_funccal and callers.
6185 */
6186 int
6187set_ref_in_previous_funccal(int copyID)
6188{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006189 funccall_T *fc;
6190
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006191 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006192 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006193 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006194 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6195 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6196 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6197 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006198 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006199 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006200}
6201
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006202 static int
6203set_ref_in_funccal(funccall_T *fc, int copyID)
6204{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006205 if (fc->fc_copyID != copyID)
6206 {
6207 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006208 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6209 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6210 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6211 || set_ref_in_func(NULL, fc->func, copyID))
6212 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006213 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006214 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006215}
6216
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006217/*
6218 * Set "copyID" in all local vars and arguments in the call stack.
6219 */
6220 int
6221set_ref_in_call_stack(int copyID)
6222{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006223 funccall_T *fc;
6224 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006225
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006226 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6227 if (set_ref_in_funccal(fc, copyID))
6228 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006229
6230 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006231 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6232 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6233 if (set_ref_in_funccal(fc, copyID))
6234 return TRUE;
6235 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006236}
6237
6238/*
6239 * Set "copyID" in all functions available by name.
6240 */
6241 int
6242set_ref_in_functions(int copyID)
6243{
6244 int todo;
6245 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006246 ufunc_T *fp;
6247
6248 todo = (int)func_hashtab.ht_used;
6249 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006250 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006251 if (!HASHITEM_EMPTY(hi))
6252 {
6253 --todo;
6254 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006255 if (!func_name_refcount(fp->uf_name)
6256 && set_ref_in_func(NULL, fp, copyID))
6257 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006258 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006259 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006260 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006261}
6262
6263/*
6264 * Set "copyID" in all function arguments.
6265 */
6266 int
6267set_ref_in_func_args(int copyID)
6268{
6269 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006270
6271 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006272 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6273 copyID, NULL, NULL))
6274 return TRUE;
6275 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006276}
6277
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006278/*
6279 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006280 * Returns TRUE if setting references failed somehow.
6281 */
6282 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006283set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006284{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006285 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006286 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006287 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006288 char_u fname_buf[FLEN_FIXED + 1];
6289 char_u *tofree = NULL;
6290 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006291 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006292
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006293 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006294 return FALSE;
6295
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006296 if (fp_in == NULL)
6297 {
6298 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006299 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006300 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006301 if (fp != NULL)
6302 {
6303 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006304 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006305 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006306
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006307 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006308 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006309}
6310
Bram Moolenaare38eab22019-12-05 21:50:01 +01006311#endif // FEAT_EVAL